The schedules API provides functionality that allows a administrator to add, delete or update schedules
Easy Heading Free | ||||
---|---|---|---|---|
|
Section | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get all schedulesLists all the schedules configured in the Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Pagination query string parameters Sorting query string parameters
Response
Status: 200 |
Section | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a single scheduleGet information about a single schedule configured in Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Path Parameters
Response
Status: 200, 404 |
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add schedule(s)Add schedules to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Body Parameters
Other parameters passed in the request body will depend on the type of schedule being created. Some candidates are shown below:
Example
Response
See Response Body for details regarding the response body returned where multiple items are affected with some (or all) returning errors Status: 201, 406 |
Section | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update schedule(s)Update schedules in Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Path Parameters
Body Parameters
x - at least one field must be present Example
Response
Status: 200, 404, 406 |
Section | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update schedules, filteredUpdate schedules configured in the Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed.
Filters: The schedule filter definition here
Response
Status: 200, 406 |
Section | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete multiple schedules, filteredDelete multiple schedules from Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed.
Filters: The schedule filter definition here Response
Status: 200 |
Section | |||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete schedules(s)Delete one or more schedules from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Path Parameters and Query parameters
Body Parameter
Examples
Response
Status: 200, 404, 406 |
Section | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Some endpoint queries require a filter. A filter is basically a JSON object with the following format: Seed filter:
|
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Execute schedulesExecute schedules, either sequence or time based, in Aspire. This endpoint needs at least an ADMINISTRATOR role to be executed.
Body Parameters
Examples Executes a single schedule
Executes multiple schedules
Response
Status: 200, 404 |