Managing Connector Maintenance Schedules
Troubleshooting
An unsuccessful API request returns the following information in the response body:
- Type: A link to the standard HTTP response code.
- Details: A brief description of the error.
- Parameters: An optional JSON object to provide extra error information.
Sample API error response
{
"type": "404",
"detail": "resource not found",
"parameters":
{
"name": "entityType",
"value": "the request URL"
}
}
<!--NeedCopy-->
Response codes
The following section lists the response codes for the APIs with examples.
200 OK
GET/ maintenance
Connector maintenance schedules retrieved successfully
[
{
"location": "847daa2f-d6bf-42bf-977a-537250dcaec0",
"dayOfWeek": "Friday",
"start": "12:00:00",
"order": "Early"
}
]
<!--NeedCopy-->
401 Unauthorized
GET/ maintenance
Case 1: If the authorization header is empty or missing, the ‘value’ in the ‘parameters’ subschema is ‘missing’
{
"type": "https://errors-api.cloud.com/common/authentication",
"detail": "Missing or invalid authentication details",
"parameters": [
{
"name": "reason",
"value": "missing"
}
]
}
<!--NeedCopy-->
Case 2: If the Authorization header is invalid, the ‘value’ in the ‘parameters’ subschema is ‘invalid’
{
"type": "https://errors-api.cloud.com/common/authentication",
"detail": "Missing or invalid authentication details",
"parameters": [
{
"name": "reason",
"value": "invalid"
}
]
}
<!--NeedCopy-->
403 Forbidden
If the Authorization details are provided incorrectly in the header, the following error occurs:
GET/ maintenance
Case 1: Customer (bearer token) details are not correct
{
"type": "https://errors-api.cloud.com/common/authorization",
"detail": "Access denied"
}
<!--NeedCopy-->
404 Not Found
GET/ maintenance
Case 1: In case the URL does not match the OpenAPI Specification
{
"type": "https://errors-api.cloud.com/maintenance/notFound",
"detail": "resource not found",
"parameters": [
{
"name": "entityType",
"value": "/resourcelocations"
}
]
}
<!--NeedCopy-->
500 Internal Server Error
Report these errors directly to the engineering team to help resolve the issues. Take a note of the customer ID and Transaction ID from the customer to troubleshoot further.
GET/ maintenance
Case 1: Server Errors
{
"type": "https://errors-api.cloud.com/maintenance/internalerror",
"detail": "There was a internal issue"
}
<!--NeedCopy-->
Troubleshooting
In this article
Copied!
Failed!