2.2.18 Error information
This section describes the case an error occurs in an API request. If an error occurs in an API request, the schema in the table below is returned as the response information. For error information other than the schema in the table below, see the manual JP1/Automatic Operation Messages.
The following table describes the schema of error information.
Member name |
Data type |
Description |
---|---|---|
errorSource |
string |
API where the error occurred |
message |
string |
Message of the error |
messageID |
string |
Message ID. If the error was caused by a wrong XML description in a request, generic error is set for the message ID. |
application |
string |
Information about the application that holds the API where an error occurred (Automation) |
messageData |
string |
Detailed information of the error |
Output example
The following example outputs KNAE02102-E as messageID of the error information.
{ "errorSource" : "http://10.196.184.238:22015/Automation/v1/objects/Tasks/555", "message" : "The specified resource does not exist or you do not have access. After reviewing the content of the following, please re-run.\n- The presence or absence of resources\n- Access rights to the resource", "messageID" : "KNAE02102-E", "application" : "Automation" }