Scheduler Maintenance

Acknowledge scheduler maintenance events

This method requires SchedulerMaintenance:Acknowledge permission to be associated with the role.

POST

/gb/scheduler-maintenance/acknowledge

curl --request POST \
  --url https://api.catch-e.com/gb/scheduler-maintenance/acknowledge \
  --header 'Authorization: <api-key>' \
  --header 'Audit-User-Id: <string>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'scheduler_maintenance_ids%5B0%5D=%3Cstring%3E'

{
  "detail": "Unauthorized",
  "status": 401,
  "title": "Unauthorized",
  "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Headers

Audit-User-Idstringheader

(Optional) User Id to use for audit purposes. This header requires the Audit:UserIdOverride permission to be associated with your role.

Maximum string length: 5

Pattern: ^[1-9]{1}[0-9]*$

Body

scheduler_maintenance_idsstring[]required

Scheduler Maintenance Ids

Response

Scheduler maintenance events acknowledged successfully

Still need help? Ask the team