The error objects give information to the clients using Transform API about the eventual case of failure of one entire request, or of one or more transformations within one or more requests.
Errors#
Overview#
JSON instantiation#
Errors are instantiated using JSON in the responses to Transform API requests.
{
"error": {
"code": "[string]",
"message": "[string]"
}
}
JSON attribute | Type | Description | Required |
---|---|---|---|
code | guid | the error's code. | |
message | string | text defining the error. |
Example of JSON instantiation#
{
"error": {
"code": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"message": "Undefined RightContext"
}
}
Error codes#
Find below two lists of error codes and their explanation to help troubleshooting failing requests.
Response level errors#
Use case in JSON request | HTTP Response code | property.value | error.message | error.code |
---|---|---|---|---|
Configuration not found or disabled | 400 Bad Request | N/A | Configuration not found | df7817ea-b5b6-4933-b8da-ce28fff582e9 |
Account not found | 400 Bad Request | N/A | Account not found | 151a7cb0-9b13-494f-996c-0c7eee2bfd08 |
Account status is not active (Suspended or Disabled) | 400 Bad Request | N/A | Account status is not active | ecae14fc-b6fa-4e13-8ca3-cb85f21bd015 |
Account balance has no credits | 400 Bad Request | N/A | Account has no credits | 368b13a8-9cda-4a8e-b646-dd837f9f504e |
Account daily transformation limit exceeded | 400 Bad Request | N/A | Daily transformation limit exceeded | 9ca42676-423a-4384-805a-0b671afecc4b |
Account monthly transformation limit exceeded | 400 Bad Request | N/A | Monthly transformation limit exceeded | da593b4c-277e-440c-956e-3a6e7737b565 |
Wrong request format or required fields is not specified | 400 Bad Request | N/A | Wrong request format | d60c07f8-acb0-4125-82fe-d3577d7eec98 |
Request section has no defined related rights context Guid | 400 Bad Request | N/A | Request = '{request.Guid}' has no rights context definition | c0804f15-1632-4d54-8154-5b63f0ebbe1d |
RightContext.Guid has no evidence list definitions | 400 Bad Request | N/A | No rights context defined for Guid = '{request.RightsContext}' | c0804f15-1632-4d54-8154-5b63f0ebbe1d |
ProcessingContext.Guid has no evidence list definitions | 400 Bad Request | N/A | No processing context defined for Guid = '{request.ProcessingContext}' | c0804f15-1632-4d54-8154-5b63f0ebbe1d |
Instance level errors#
Use case in JSON request | HTTP Response code | property.value | error.message | error.code |
---|---|---|---|---|
ProcessingContext not specified in request (in order to extract class & property from value) | 200 OK | null | Processing context required | 118f797c-5f6f-4c46-a48f-4d1a9fb38f21 |
ProcessingContext.Guid has no corresponding processing context in response from Core Configuration API (in order to extract class & property from value) | 200 OK | null | Undefined Processing context | 11b34d01-1425-489d-9665-2acd24e2922c |
Corresponding processing context in response from Core Configuration API does not exist in configuration list of Processing contexts (in order to extract class & property from value) | 200 OK | null | Processing context not found | 8d39bc4c-8698-4f7b-a4f8-ba74b593f86e |
ProcessingContext.SequenceId is empty in response from Core Configuration API (in order to extract class & property from value) | 200 OK | null | Undefined Sequence | 978c46c6-5859-40e9-be71-bd9ca4badd1c |
Corresponding sequence in response from Core Configuration API does not exist in configuration list of Sequences (in order to extract class & property from value) | 200 OK | null | Sequence not found | 3f63a7bc-39d9-4671-83a1-6f17595c0d03 |
Transformer with type = ExtractProperty not found in Sequence (in order to extract class & property from value) | 200 OK | null | Required transformer not found | 98f54c8f-d339-4b18-a524-90c53882be71 |
RightsContext.Guid has no corresponding rights context in response from Core Configuration API (in order to extract property rights) | 200 OK | null | Undefined Rights context | 3f567979-e5b7-4725-8b93-9363ceaa5604 |
Corresponding rights context in response from Core Configuration API does not exist in configuration list of Rights contexts (in order to extract property rights) | 200 OK | null | Rights context not found | f800df3c-4288-4591-9b7b-64eff20ff9ed |
RightsContext.Guid has no assigned rights for property mapping in response from Core Configuration API (in order to extract property rights) | 200 OK | null | Undefined Rights context | 2f01b281-35eb-414b-85c2-b642ebde542f |
ProcessingContext not specified in request (in order to detect transformation sequence) | 200 OK | null | Processing context required | a81e9f99-b934-409c-b26d-78f2455a9ec7 |