Get Request Status V3
Get Request Status API is used to query the system for previously sent regular or bulk requests and get all its inner requests’ status, whether succeeded, failed or still in progress in a single API call.
|
HTTP URL |
|
|---|---|
|
GET |
api/v3/global/call/{id} |
{id} is either the UUID (Request-Id) that was provided in a regular or in bulk asynchronous response header.
Eligibility
The Requestor is eligible to request for API calls status for its own generated request IDs.
API Request
Request Structure
This API has no request structure.
API Response
Response Structure
| Parameter | Type | M/O/CM | Description |
|---|---|---|---|
| errorCode | String | O | Failure code. See list below, under ‘Error Codes’ section |
| errorMessage | String | O | Failure detailed description. See list below, under ‘Error Codes’ section |
| content | Object | O | Array of main response body object. Displayed when an API call was successful. For a failure it will be empty. |
| pageable | Object | O | Paging information object. Displayed when an API call was successful. For a failure it will be empty. |
Content
| Parameter | Type | M/O/CM | Description |
|---|---|---|---|
| requestId | String | M | The ‘requestId’ UUID that was provided in asynchronous response per a regular event request or per a specific node of the bulk API. |
| status | String | M | Specific node status of bulk API call. Valid values: OPEN, SUCCESS, FAILURE, INTERNAL_ERROR. |
Pageable Data Objects
| Parameter | Type | M/O/CM | Description |
|---|---|---|---|
| page | Numeric | M | Page number |
| size | Numeric | M | Page size. Number of requested elements per page |
| totalPages | Numeric | M | Total amount of available pages per requested page size |
| totalElements | Numeric | M | Total amount of retrieved elements |
Error Codes
In addition to the general success and failure codes, the following error codes are possible.
| Code | Message |
|---|---|
| GLOBAL_1001 | Service unavailable. Please try again |
| GLOBAL_1003 | Provided request ID does not exist for your account. |
Examples
Request Body
Copy
{
}Response Body: Success ACK
Copy
{
"errorCode": "",
"errorMessage": "",
"content": [
{
"requestId": "77022d89-8a5b-4ecb-a118-334c7ccb3779",
"status": "SUCCESS"
},
{
"requestId": "6c4480ea-3f3d-4fa7-9517-34e08902d6f9",
"status": "FAILURE"
}
],
"pageable": {
"page": 0,
"size": 10,
"totalPages": 1,
"totalElements": 1
}
}Response Body: Failure NAK
Copy
{
"errorCode": "GLOBAL_1003",
"errorMessage": "Provided request ID does not exist for your account",
"content": "",
"pageable": null
}