-
To execute an action asynchronously, your client must specify the following Header/value on the request:
Header name: Prefer, header value: respond-async
-
If the Smart API processes the request asynchronously, it will return a HTTP 202 (Accepted) response.
The response returns an empty body and includes a HTTP Location header pointing to a URI (identifying a status monitor resource) that represents the current state of the asynchronous processing:
Header name: Location, header value: <status monitor URI>
-
The response also might include a Retry-After header indicating the time, in seconds, the client should wait before querying the Smart API for status:
Header name: Retry-After, header value: 5
-
An HTTP GET request to the status monitor URI will return an HTTP 200 (OK) once the asynchronous processing completes, with a single HTTP response body containing the results.
See the OData specification: Asynchronous Requests for full details.