Field Service Developer Guide
jNewer Version Available
Start Batch
Creates service appointment bundles automatically. The resource uses appointment bundle
policies that are marked for automatic bundling. Service appointments that are already bundled
manually stay untouched by this API. The resource returns the success or failure message of
starting the batch process of automatic bundling. This endpoint is available in version 54.0 and
later of the Salesforce API.
- URI
- <host>/bundleflow/api/v1.0/startbatch
- Format
- JSON
- HTTP Method
- POST
- Authentication
-
Authorization: Bearer
<token>
If the authentication token isn’t valid, a 401 HTTP status is returned.
- Headers
- sf_api_version—Salesforce API version. Minimum version is 53.0.
- Authorization—Authorization token.
- Content-Type—File format. Valid value is JSON.
- Referer—Org domain URL.
Request Body
Properties
| Field | Type | Description | ||
|---|---|---|---|---|
| operation | String | The bundling operation. Valid value: start-batch-processing |
||
Example
JSON Example
This example shows an automated bundling request of service appointments.
1{
2 "operation": "start-batch-processing"
3}Response Body
Properties
| Field | Type | Description | ||
|---|---|---|---|---|
| httpStatus | Number | Response HTTP status. | ||
| statusDescription | String | Response status description. | ||
| responsePayload | String | Message about the batch status. If it’s successful, the payload is null. If the batch bundling fails, the payload shows an error message, such as, "Wrong API version" or "Failed to start batch agent". | ||
| messageCode | Number | Message code is always 0. | ||
| messageAdditionalInfo | String | More information provided by Salesforce. | ||
Example
JSON Example: Successful Response
This example shows the output of a batch process of automatic bundling that started successfully.
1{
2 "httpStatus":200,
3 "statusDescription":null,
4 "responsePayload":null,
5 "messageCode":"NONE"}
6}Example
JSON Example: Fail Response
This example shows the output of a batch process that failed to start because the operation parameter of the request is null or empty.
1{
2 "httpStatus":400,
3 "statusDescription":null,
4 "responsePayload":"Failed to start batch agent",
5 "messageCode":"NONE"
6 "messageAdditionalInfo": ""
7}