この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

ジョブの終了または中止

ジョブを終了するには、ジョブの状況を UploadComplete に更新します。ジョブを終了すると、アップロード済みのデータは処理用のキューに追加されます。ジョブを中止するには、ジョブの状況を Aborted に更新します。ジョブを中止すると、そのジョブはキューに追加されず、処理もされません。中止したジョブの一環としてアップロードされたデータは削除されます。

経過日数が 7 日を超えている、状態が Open または UploadComplete の未完了の一括ジョブは、キューから削除されます。ジョブが正常に終了または中止されると、ジョブデータを追加できなくなります。

URI: /api/v1/ingest/jobs/{id}
適用開始バージョン: Customer Data Platform v1.0、Salesforce v51.0
形式: JSON
HTTP のメソッド: PATCH
認証: Authorization: Bearer access_token

スキーマで定義されたすべての項目は、要求ペイロード内に存在する必要があります。この条件は、[値が必要です] が true に設定されているかどうかに関係なく成立します。レコードの特定の項目にデータがない場合は、空白の値を送信します。

メモ

リクエストボディ

1{
2   "state" : "UploadComplete"
3}

要求パラメータ

パラメータ	説明
id	ジョブの作成要求からレスポンスボディに返されたジョブ ID。
state	ジョブの更新後の状況。ジョブを終了する場合は `UploadComplete`、ジョブを中止する場合は `Aborted` を使用します。

レスポンスボディ

1{
2       "id": "7505e000001NLkPAAW",
3       "operation": "upsert",
4       "object": "Contact",
5       "createdById": "0055e000003PfMYAA0",
6       "createdDate": "2021-06-10T13:25:40.000Z",
7       "systemModstamp": "2021-06-10T13:25:40.000Z",
8       "state": "UploadComplete",
9       "contentType": "CSV",
10       "apiVersion": "v1"
11}

例

1curl --location --request PATCH 'https://{instance_url}/api/v1/ingest/jobs/{id}' \
2--header 'Content-Type: application/json' \
3--header 'Authorization: Bearer <access_token>' \
4--data-raw '{
5   "state":"UploadComplete"
6}'
7< HTTP/1.1 200 OK
8< Content-Type: application/json;charset=UTF-8
9< Transfer-Encoding: chunked
10<
11{"id":"7505e000001NLkPAAW","operation":"upsert","object":"Contact","createdById":"0055e000003PfMYAA0","createdDate":"2021-06-10T13:25:40.000Z","systemModstamp":"2021-06-10T13:25:40.000Z","state":"UploadComplete","contentType":"CSV","apiVersion":1}

Customer Data Platform 開発者ガイド

ジョブの終了または中止

例