Warning | ||
---|---|---|
| ||
This page is in development and as such, its contents may be incorrect |
The schedules API provides functionality that allows a an administrator to add, delete or update schedules
Easy Heading Free | ||||
---|---|---|---|---|
| ||||
Section | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get all schedulesLists all the schedules configured in the Aspire, this this endpoint need the needs at least the ADMINISTRATOR role to be executed.
Pagination query string parameters Sorting query string parameters
Response TODO: check this schedule format
Status: 200
Status: 200 |
Section | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a single schedule informationThis endpoint needs at least the ADMINISTRATOR role to be executed.
Path Parameters
Response
| ||||||||||||||||||||||
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 | ||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||
id | string | Required | The id of the schedule to return |
Code Block | ||
---|---|---|
| ||
{ "schedule": { "id": "AAABcID5GBc=", "type": "time", "description": "Weekend after office", "09db4593-ce57-4edd-9e24-1dc0d8dc4e24" "running": false], "enabled": true, "seedscrawlMode": ["AAABcIueWUd=", "AAABcIueWUe="]full", "properties": { "action": "start", "crawlType": "incremental", "scheduleType": "custom", "schedule": "* * * * 1", "last": 123456789, "next": 123456789 }, "message": "optional response message" } |
Status: 200, 404
}
} |
Status: 200, 404
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add schedule(s) to AspireThis endpoint needs 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
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Add schedule(s)Add schedules to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Body Parameters TODO: check the schedule format | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string | Required | The type of schedule to add
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | Required | An optional description of the schedule | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
action | string | Optional | The action to perform by the scheduled task
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
crawlType | string | Optional | The type of crawl to perform by the scheduled task
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
enabled | boolean | Optional | Whether this schedule is enabled or not | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
scheduleType | string | Optional | The type of the time based schedule
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
schedule | string | Optional | the cron like schedule for a time based schedule | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
after | string | Optional | the id of the schedule after which this schedule should run (for a sequence based schedule) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
seeds | string | Optional | the seed(s) this schedule applies to |
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/schedules [{ "type": "time", "description": "Weekly seeds" "enabled": true, "scheduleType": "weekly", "schedule": "* * * * 1", "seeds": ["AAABcIueWUd=", "AAABcIueWUe="], "seedsFilter":{"tags":["tag1","tag2"]}, "action": "start", "crawlTypecrawlMode": "full" }, { "type": "sequence", "description": "Rollup" "enabled": false, "stopOnFail": true, "after": "0 0 0 ? * SUN * * * 1"", "completeThreshold": 0.65, "seeds": ["AAABcIudWUd=", "AAABcIudWUe="], "actionseedsFilter": "{"tags":["tag1","tag2"]}, "action": "start", "crawlTypecrawlMode": "incremental" }] |
Response Response TODO: check the schedule format
Code Block | ||||
---|---|---|---|---|
| ||||
{ "schedule": [{ "id": "AAABcIueWU0", "type": "time", "description": "Weekly seeds" "enabled": true, "stopOnFail": true, "scheduleTypescheduleTimeType": "weekly", "schedule": "*0 0 0 ? * *SUN * 1", "seedscompleteThreshold": ["0.65, "seeds": ["AAABcIueWUd=", "AAABcIueWUe="], "seedsFilter":{"tags":["tag1","tag2"]}, "action": "start", "crawlTypecrawlMode": "full" }, { "id": "AAABcIueWU1", "type": "sequence", "description": "Rollup" "enabled": false, "stopOnFail": true, "after": "*0 0 0 ? * *SUN * 1", "completeThreshold": 0.65, "seeds": ["AAABcIudWUd=", "AAABcIudWUe="], "seedsFilter":{"tags":["tag1","tag2"]}, "action": "start", "crawlTypecrawlMode": "incremental" }] } |
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 . This endpoint needs at least the ADMINISTRATOR role to be executed.
Path Parameters
Body Parameters
Other parameters passed in the request body will depend on the type of schedule being created - see Add schedule(s) above
x - at least one field must be present Example Example TODO: check the schedule format
Response Response TODO: check the schedule format
Status: 200, 404, 406
See Response Body for details regarding the response body returned where multiple items are affected with some (or all) returning errors Status: 200, 404, 406 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Section |
Panel | ||||
---|---|---|---|---|
| ||||
|
Filters: The schedule filter definition here
Response
Code Block | ||
---|---|---|
| ||
{
"message": "update result response message"
} |
Status: 200, 406
Delete multiple schedules from Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed.
Panel | ||||
---|---|---|---|---|
| ||||
|
Filters: The schedule filter definition here
Response
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
Status: 200
Delete one or more schedules from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.
Panel | ||||
---|---|---|---|---|
| ||||
|
Path Parameters and Query parameters
Response
Status: 200, 406 |
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete schedules(s)Delete one or more schedules from Aspire. This endpoint needs at least the ADMINISTRATOR role to be executed.
Path Parameters and Query parameters
Body Parameter
Examples
Response
Status: 200, 404, 406
|
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Export schedule(s)Export one or more schedule from Aspire, this endpoint needs at least the OPERATOR role to be executed.
Path Parameters and Query parameters
Body Parameter
Examples
Response
Status: 200, 404, 406
|
Section |
---|
ImportThe import usage can be found here |
Section | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Some endpoint queries require a filter. A filter is basically a JSON object with the following format: Schedule filter:
|
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Execute schedulesExecute schedules, either sequence or time based. 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 | ||||||||||||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||||||||||||
id | string | Required | The identifier(s) of the schedule(s) to delete | |||||||||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||||||||||||
ids | string | Required | The identifier(s) of the schedule(s) to delete |
Code Block | ||
---|---|---|
| ||
DELETE /aspire/_api/schedules/AAABcID5GBc
DELETE /aspire/_api/schedules?id=AAABcID5GBc&id=AAABcID5GBd
POST /aspire/_api/schedules/delete
{
"ids":["AAABcID5GBc","AAABcID5GBd"]
}
|
Response
Code Block | ||
---|---|---|
| ||
{
"message": "delete result response message"
} |
Status: 200, 404, 406
Some endpoint queries require a filter. A filter is basically a JSON object with the following format:
Seed filter:
language | js |
---|