OCAPI システムジョブ 23.1

システムジョブは、次の OCAPI リクエストによって呼び出される事前定義されたジョブです:

1POST dw/data/v23_1/jobs/{job_id}/executions

このリソースを呼び出すと、バックグラウンドジョブがトリガーされ、ジョブのステータス情報を含むレスポンスドキュメントが取得されます。各システムジョブによって、使用できるリクエストペイロードが異なります。

ジョブ ID は常に sfcc- で始まります。この接頭辞は Commerce Cloud システムジョブ固有の名前空間です。カスタムジョブ ID に使用することはできません。

現在利用可能なシステムジョブは、グローバルジョブを参照してください。

システムジョブのリクエストは、基本的な OCAPI Data API リクエストと似ていますが、独自のリクエストドキュメントもつことができます。次に、サイトアーカイブのインポートジョブの例を示します:

1REQUEST:
2      POST /dw/data/v23_1/jobs/sfcc-site-archive-import/executions HTTP/1.1
3      Host: example.com
4      Accept: application/json
5      Authorization: Bearer <access_token>
6      {
7          "file_name": "siteGenesis.zip",
8          "mode": "merge"
9      }
10
11      RESPONSE:
12      HTTP/1.1 202 ACCEPTED
13      Content-Type: application/json;charset=UTF-8
14      Content-Length: 741
15      {
16          "_v" : "23.1",
17          _type": "job_execution",
18          "client_id": "[your_own_client_id]",
19          "execution_status": "pending",
20          "id": "42",
21          "is_log_file_existing": false,
22          "is_restart": false,
23          "job_id": "sfcc-site-archive-import",
24          "log_file_name": "Job-sfcc-site-archive-import-20170512142357242.log",
25          "modification_time": "2017-05-12T14:23:57.316Z",
26          "parameters": [ {
27            "_type": "job_execution_parameter",
28            "name": "ImportMode",
29            "value": "merge"
30          }, {
31            "_type": "job_execution_parameter",
32            "name": "ImportFile",
33            "value": "siteGenesis.zip"
34          } ],
35          "status": "PENDING"
36      }

DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!