Advanced Scheduling
Create and manage advanced schedules and maintenance event rules.
See also: Advanced Scheduling documentation | Full API Reference for interactive testing and complete schemas.
Endpoints
| Method | Path | Description | Reference |
|---|---|---|---|
| GET | /maintenance-events | Query Maintenance Events | API Reference → |
| POST | /maintenance-events | Create new maintenance event | API Reference → |
| DELETE | /maintenance-events/{xid} | Delete a maintenance event | API Reference → |
| GET | /maintenance-events/{xid} | Get maintenance event by XID | API Reference → |
| PATCH | /maintenance-events/{xid} | Partially update an existing maintenance event | API Reference → |
| PUT | /maintenance-events/{xid} | Update an existing maintenance event | API Reference → |
| GET | /maintenance-events/active/{xid} | Get the current active state of a maintenance event | API Reference → |
| PUT | /maintenance-events/active/{xid} | Set the state of a maintenance event, only change state if necessary ignore if no change and just return current state | API Reference → |
| GET | /maintenance-events/export | Export formatted for Configuration Import by supplying an RQL query | API Reference → |
| POST | /maintenance-events/query/get-events-by-points-and-or-sources | Find Events for a set of Maintenance events created by the supplied criteria | API Reference → |
| POST | /maintenance-events/query/get-events-by-rql | Find Events for a set of Maintenance events created by the supplied rql query | API Reference → |
| GET | /maintenance-events/query/get-for-points-by-ids/{pointIds} | Find Maintenance Events linked to data points by point IDs | API Reference → |
| GET | /maintenance-events/query/get-for-points-by-xids/{pointXids} | Find Maintenance Events linked to data points by point XIDs | API Reference → |
| GET | /maintenance-events/query/get-for-sources-by-ids/{sourceIds} | Find Maintenance Events linked to data sources by source IDs | API Reference → |
| GET | /maintenance-events/query/get-for-sources-by-xids/{sourceXids} | Find Maintenance Events linked to data sources by source XIDs | API Reference → |
| POST | /maintenance-events/set-point-values | Set Point Values for a Maintenance Event during a given time | API Reference → |
| DELETE | /maintenance-events/set-point-values/{id} | Remove a set point values task using its id | API Reference → |
| GET | /maintenance-events/set-point-values/{id} | Get the status of a set point values operation using its id | API Reference → |
| PUT | /maintenance-events/set-point-values/{id} | Update a set values task using its id | API Reference → |
| PUT | /maintenance-events/toggle/{xid} | Toggle the state of a maintenance event | API Reference → |
| GET | /schedule-rule-sets | Query Rule Sets | API Reference → |
| POST | /schedule-rule-sets | Create a Rule Set | API Reference → |
| DELETE | /schedule-rule-sets/{xid} | Delete a Rule Set | API Reference → |
| GET | /schedule-rule-sets/{xid} | Get a Rule Set | API Reference → |
| PUT | /schedule-rule-sets/{xid} | Update a Rule Set | API Reference → |
| GET | /schedules | Query Schedules | API Reference → |
| POST | /schedules | Create a Schedule | API Reference → |
| DELETE | /schedules/{xid} | Delete a Schedule | API Reference → |
| GET | /schedules/{xid} | Get a Schedule | API Reference → |
| PUT | /schedules/{xid} | Update a Schedule | API Reference → |
| PUT | /schedules/enable-disable/{xid} | Enable/disable/restart a schedule | API Reference → |
| GET | /schedules/export | Export formatted for Configuration Import by supplying an RQL query | API Reference → |