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

バッチの開始

サービス予定バンドルを自動的に作成します。このリソースは、自動バンドルとしてマークされた予定バンドルポリシーを使用します。すでに手動でバンドルされたサービス予定はこの API で変更されません。このリソースは、自動バンドルのバッチ処理の開始に関する成功メッセージまたは失敗メッセージを返します。このエンドポイントは、Salesforce API のバージョン 54.0 以降で使用できます。

URI: <host>/bundleflow/api/v1.0/startbatch
形式: JSON
HTTP メソッド: POST
認証: Authorization: Bearer <token>
認証トークンが有効ではない場合は、HTTP 状況コードの 401 が返されます。
ヘッダー: sf_api_version — Salesforce API のバージョン。最小バージョンは 53.0 です。; Authorization — 認証トークン。; Content-Type — ファイル形式。有効な値は JSON です。; Referer — 組織のドメイン URL。

リクエストボディ

プロパティ

項目			型	説明
operation			String	バンドル操作。有��な値: `start-batch-processing`

例

JSON の例

次の例は、サービス予定の自動バンドル要求を示しています。

1{
2    "operation": "start-batch-processing"
3}

レスポンスボディ

プロパティ

項目	型	説明
httpStatus	Number	HTTP 応答状況。
statusDescription	String	応答状況の説明。
responsePayload	String	バッチ状況に関するメッセージ。成功した場合、ペイロードは null になります。バッチバンドルに失敗した場合、ペイロードには、[Wrong API version (API バージョンが正しくありません)] や [Failed to start batch agent (バッチエージェントを開始できませんでした)] などのエラーメッセージが示されます。
messageCode	Number	メッセージコードは常に 0 です。
messageAdditionalInfo	String	Salesforce から提供される詳細情報。

例

JSON の例: 成功した場合の応答

次の例は、正常に開始した自動バンドルのバッチ処理の出力を示しています。

1{
2   "httpStatus":200,
3   "statusDescription":null,
4   "responsePayload":null,
5   "messageCode":"NONE"}
6}

例

JSON の例: 失敗した場合の応答

次の例は、要求の操作パラメーターが null または空であるために開始できなかったバッチ処理の出力を示しています。

1{
2   "httpStatus":400,
3   "statusDescription":null,
4   "responsePayload":"Failed to start batch agent",
5   "messageCode":"NONE"
6   "messageAdditionalInfo": ""
7}

Field Service 開発者ガイド

バッチの開始

リクエストボディ

例

レスポンスボディ

例

例