After sending an authorization request to the intended API, Apex Central returns a response indicating whether the request was successful.
The response should always be a JSON-formatted response object in the following format:
{
"result_code":(an integer indicating
the result of this API call),
"result_description":"(a string
describing the result code)",
"result_content":"(if provided, a
JSON object representing the
return value of the API)"
}
For a complete list of result_code status values, see Automation API Result Codes.
The result_description field in the response body is subject to change. If your application depends on Apex Central Automation API responses, use the result_code value instead of the result_description provided in the response body.
The following table outlines the possible responses:
|
HTTP Status Code |
Response Status |
Response Body |
|---|---|---|
|
200 |
Successful |
{
"result_code":(an integer indicating
the result of this API call),
"result_description":"(a string
describing the result code)",
"result_content":"(if provided, a
JSON object representing the
return value of the API)"
}
Note:
For a complete list of result_code status values, see Automation API Result Codes. |
|
400 |
Unsuccessful due to invalid parameters |
{
"result_code":(an integer indicating
the result of this API call),
"result_description":"(a string
describing the result code)",
"result_content":""
}
Note:
For a complete list of result_code status values, see Automation API Result Codes. |
|
401 |
Unsuccessful due to authorization error |
{
"result_code":(an integer indicating
the result of this API call),
"result_description":"(a string
describing the result code)",
"result_content":""
}
Note:
For a complete list of result_code status values, see Automation API Result Codes. |
|
500 |
Unknown error |
{
"result_code":(an integer indicating
the result of this API call),
"result_description":"(a string
describing the result code)",
"result_content":""
}
Note:
For a complete list of result_code status values, see Automation API Result Codes. |
