API responses are made up of the following:
The standard headers for responses are as follows:
A 16-character alphanumerical GUID code.
This is always present in responses, and can be used by the Get Result call to retrieve the status of an asynchronous call (within 2 days).
The response’s timestamp.
It is provided in YYYY-MM-DD format, followed by the time (GMT time).
The type of contents included in the body. Possible values are:
Response Status Codes
The main response status codes used in all Rulex APIS are:
200 – success
202 - accepted
230 - warning
500 – error
For other codes not listed here see Microsoft documentation.
Not all API responses contain a body:
Responses to GET APIs normally include a body with the requested information
Responses to POST APIs generally do not contain a body.
The following is a sample of a response in cURL to a synchronous API to export a Rulex Flow: