These endpoints allow you to submit multiple requests in a single call, improving efficiency for various operations. A batch of individual requests sent in the request body will be processed asynchronously in the background. You can then poll the status of the batch request to check if it has been completed and receive a consolidated response for all operations.
This operation creates a batch request to execute multiple operations asynchronously in a single HTTP request.
required | Array of objects (SingleRequest) non-empty |
The request was accepted for processing and it will be executed asynchronously.
Bad Request. The Problem Details object will provide more information about the exact cause.
Unsupported Media Type. When provided as a response to a PATCH request,
the response will provide an Accept-Patch response header to notify
the client what patch document media types are supported.
The server encountered an unexpected error. Retrying the request after a certain time could help.
{- "requests": [
- {
- "path": "string",
- "method": "POST",
- "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "queryParameters": [
- {
- "name": "string",
- "value": "string"
}
], - "body": { }
}
]
}{- "title": "Bad Request",
- "status": 400,
- "detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}This operation retrieves the status of a batch request and the results of the operations that were executed.
The status of the batch request and the results of the operations that were executed.
Not Found
Unacceptable. indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.
The server encountered an unexpected error. Retrying the request after a certain time could help.
{- "status": "QUEUED",
- "responses": [
- {
- "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "statusCode": 100,
- "body": { }
}
]
}