Get
GET/schedule/:apiKey/:scheduleId/get
Retrieve a schedule.
Please be aware of the rate limit for this API endpoint:
- Total limit: Each unique API user is limited to to 60 requests per 60-second window.
- Per
scheduleId
limit: Each uniquescheduleId
is limited to 10 request per 60-second window.
If these limits are exceeded, the server will respond with a HTTP 429 status code, indicating too many requests. Please ensure to manage your requests within these limits to maintain uninterrupted service.
Request
Path Parameters
Possible values: <= 50 characters
API Key of Connector
Possible values: <= 32 characters
ID of the schedule
Responses
- 200
- 429
Schedule response
- application/json
- Schema
- Example (from schema)
- Success
- Error
Schema
- false
- true
success
string
required
Possible values: [false
, true
]
Error message.
While the errorMessage
field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances.
For consistent and reliable error handling in your application, always base your logic on the errorCode
field, not the errorMessage
.
Error code.
For a complete list of error codes and their meanings, please see the appendix on Error codes.
Adapter specific error message, passed verbatim from the upstream Adapter.
Adapter specific error code, passed verbatim from the upstream Adapter.
Possible values: [ACTIVE
, PAUSED
, CANCELLED
, ERROR
, CREATE-PENDING
, NON-EXISTING
]
Status of the schedule.
Possible values: [ACTIVE
, PAUSED
, CANCELLED
, ERROR
, CREATE-PENDING
, NON-EXISTING
]
Status of the schedule.
Possible values: Value must match regular expression ^[0-9]{4}-((0[1-9])|(1[0-2]))-((0[1-9])|([1-2][0-9])|(3[0-1]))T(([0-1][0-9])|([2][0-3])):([0-5][0-9]):([0-5][0-9])\+[0-9]{2}\:[0-9]{2}$
RFC 3339 Internet Date/Time Format date-time
{
"success": true
}
{
"success": true,
"scheduleId": "SC-1234-1234-1234-1234-1234-1234",
"registrationUuid": "abcde01234abcde01234",
"oldStatus": "ACTIVE",
"newStatus": "ACTIVE",
"scheduledAt": "2019-09-30T12:00:00+00:00"
}
{
"success": false,
"errorMessage": "The scheduleId is not valid or does not match to the connector",
"errorCode": 7040
}
Rate limit exceeded
- application/json
- Schema
- Example (from schema)
- Example
Schema
Possible values: [false
]
Returns true
or false
depending on whether the request was successful.
Error message.
While the errorMessage
field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances.
For consistent and reliable error handling in your application, always base your logic on the errorCode
field, not the errorMessage
.
{
"success": false,
"errorMessage": "string",
"errorCode": 0,
"details": "string"
}
{
"success": false,
"errorCode": 1009,
"errorMessage": "Too many requests"
}