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. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.
Unsupported Media Type. Indicates that the origin server is refusing to service the request because the content is in a format not supported by this method on the target resource.
Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.
{- "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 lists all batch requests that have been created.
A response containing a potentially paginated list of batch requests.
Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.
Not Acceptable. 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.
Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.
{- "items": [
- {
- "id": "string",
- "status": "QUEUED",
- "responses": [
- {
- "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "statusCode": 100,
- "body": { }
}
], - "created": "2019-08-24T14:15:22Z",
- "finished": "2019-08-24T14:15:22Z"
}
], - "cursor": "string"
}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. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.
Not Acceptable. 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.
Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.
{- "id": "string",
- "status": "QUEUED",
- "responses": [
- {
- "headers": [
- {
- "name": "string",
- "value": "string"
}
], - "statusCode": 100,
- "body": { }
}
], - "created": "2019-08-24T14:15:22Z",
- "finished": "2019-08-24T14:15:22Z"
}