Get Operation response format
The API response contains the status of the long-running operation. If the operation has completed successfully, the response will contain the ID of the resulting matrix.
Response params
id-
The ID of the operation.
done-
A boolean value, indicating the current status of the operation.
When
false, the operation has not completed running.When
true, the operation has completed running. response-
The response of the operation in case the operation has completed successfully.
matrixId- The ID of the resulting matrix.
error-
The error information in case the operation has failed.
code- Status code, which should be a value of RFC9110 Status codes
message- Error message in English.
Operation Error messages
| Code | Description |
|---|---|
| 500 | The operation has failed due to internal server error. Repeat the Generate Matrix request later. |
HTTP Error messages
| Code | Description |
|---|---|
| 400 | One or more required parameters are missing in the request. |
| 401 | The request doesn't contain the apikey parameter or an invalid key was specified. |
| 404 | The operation with the provided ID was not found. |
| 429 | Too many requests. |
| 500 or 504 | System server error. Retry the request later. |
If an error occurs while processing a request, API returns a message with the error description in the errors field:
{"errors": ["Error with parameter \"id\": Required"]}
{"errors": ["Key not found"]}
{"errors": ["parameter 'apikey' is missing"]}