GET /data/v1/async/{requestId}/status
Retrieve the status of the originally posted asynchronous request. Use the status to determine if the request has completed and whether or not there were errors in processing.
URL Parameters
Name | Type | Description | |
---|---|---|---|
requestId | string | Required | The requestId returned from a previous and successfully submitted asynchronous request, in this case /data/v1/async/dataextensions/*. |
Responses
Status | Name | Type | Description |
---|---|---|---|
200 | OK | ||
status | object | Information about the status of the asynchronous request. | |
status.callDateTime | datetime | The date and time the asychronous request was received. | |
status.completionDateTime | datetime | The date and time the asychronous request completed processing. | |
status.pickupDateTime | datetime | The date and time the asychronous request was picked up for processing. | |
status.hasErrors | boolean | Indicates whether the results from processing the request contain any errors. | |
status.requestStatus | string | Indicates the status of the asychronous request itself (Pending, Completed, Error). | |
status.resultStatus | string | Indicates the overall status of the result from processing the request. | |
status.requestId | guid | The unique identifier of the request for which this status has been retrieved. | |
requestId | guid | The unique identifier of this request. |
Example Request
Example Response
A successfully queued request returns the RequestId. Once the request is no longer pending, use this requestId in subsequent operations to determine the status of the asynchronous call and overall results of the persist operation.
Possible values for requestStatus are:
- Pending
- Complete
- Error
Example Error Response