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 endpoint needs at least the ADMINISTRATOR role to be executed.
Query String Parameters | |||||||
Name | Type | Required | Description | ||||
type | string | Optional | Filter returned schedules to only those with the given type | ||||
description | string | Optional | Filter returned schedules to only those whose description matches the given expression | ||||
running | boolean | Optional | Filter returned schedules to only running schedules |
Section | |||||||
---|---|---|---|---|---|---|---|
Get all schedules, filteredLists schedules configured in Aspire, filtered by the specified criteria, this endpoint needs at least the OPERATOR role to be executed.
Pagination query string parameters |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{
"count": {
"totalItems": 1
} |
Response
Code Block | ||
---|---|---|
| ||
{ "schedule": [{ "id": "AAABcID5GBc=", "type": "time", "description": "Weekend after office", "runningschedule": false,[ "enabled": true, { "seed "id": ["AAABcIueWUd="258962bd-1ad0-4881-af16-ed7774857ab5", "AAABcIueWUe="], "properties": { "actiontype": "starttime", "crawlTypedescription": "incrementalTest schedules", "scheduleTypeenabled": "customtrue", "schedule": "*0 * 3 1/5 ? * * 1", "last": 123456789, "nextafter": 123456789"pepo", }, { "idseeds": "AAABcID5GBc=",[ "type": "sequence", "description": "Sequential schedule "81e23e44-4952-4938-8b1c-67b9101a3aad", "running": false, "enabled": true, "seed": ["AAABcIueWUd=", "AAABcIueWUe="],"09db4593-ce57-4edd-9e24-1dc0d8dc4e24" "properties": { ], "action": "start", "crawlTypecrawlMode": "incrementalfull", "afterScheduleaction": "AAABcID5GBc=start", } "last": 123456789 } }, ... ] } |
Status
]
} |
Status: 200
Section | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a single scheduleinformationThis endpoint needs at least the ADMINISTRATOR role to be executed.Get information about a single schedule configured in Aspire
Path Parameters
Response
| ||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||
200 | Success | |||||||||||||||||||||
404 | The given schedules id was not found |
Section | |||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add schedule(s) to AspireThis endpoint needs at least the ADMINISTRATOR role to be executed. | |||||||||||||||||||||||||||||
Section | |||||||||||||||||||||||||||||
Add schedulesAdd one or more schedules to Aspire
Request Body ParametersParameters
The action to perform by the scheduled task
crawlType |
Other parameters passed in the request body will depend on the type of schedule being created. Some candidates are shown below | ||||||||||||||||||||||||||||
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) | ||||||||||||||||||||||||||
seed | string | Optional | the seed(s) this schedule applies to |
filter for finding seeds this schedules applies to. JSON format follows the format of the filter for seeds. If the above "seeds" parameter has been used, then the "seedsFilter" will be ignored when the schedule starts. | |||
action | string | Required if seeds are used | The action to perform by the scheduled task:
|
crawlMode | string | Required if seeds are used and action = start | The type of crawl to perform by the scheduled task:
|
completeThreshold | number | Optional | Percentage of seeds to complete their crawl before continuing with the next schedule in the sequence. The value is a number up to 1. E.g. 0.69 means 69 %. Default is 1. |
enabled | boolean | Optional | Whether this schedule is enabled or not. Defaults to false if omitted. |
Other parameters passed in the request body will depend on the type of schedule being created. Some candidates are shown below:
Name | Type | Required | Description |
---|---|---|---|
schedule | string | Required if type is "time" | the cron like schedule for a time-based schedule |
scheduleTimeType | string | Required for UI if type is "time" | The type of the time-based schedule
|
after | string | Required if type is "sequence" | the ID of the schedule, after which this schedule should run |
stopOnFail | boolean | Required if type is "sequence" | Whether this schedule sequence will stop if the previous schedule crawl fails is enabled or not. Defaults to false if omitted. |
Example
Code Block | ||||
---|---|---|---|---|
|
Examples
Add a single schedule
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/schedules
{
"type": "time",
"description": "Weekly seeds"
"enabled": true,
"scheduleType": "weekly",
"schedule": "* * * * 1",
"seed": ["AAABcIueWUd=", "AAABcIueWUe="],
"action": "start",
"crawlType": "full"
} |
Add multiple schedules
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/schedules [{ "type": "time", "description": "Weekly seeds" "enabled": true, "stopOnFail": true, "scheduleTypescheduleTimeType": "weekly", "schedule": "*0 0 0 ? * *SUN * 1", "seedcompleteThreshold": [0.65, "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", "seedcompleteThreshold": ["0.65, "seeds": ["AAABcIudWUd=", "AAABcIudWUe="], "seedsFilter":{"tags":["tag1","tag2"]}, "action": "start", "crawlTypecrawlMode": "incremental" }] |
ResponseResponse
Code Block | ||||
---|---|---|---|---|
| ||||
{ "schedule": [{ "id": "AAABcIueWU0", "type": "time", "description": "Weekly seeds" "enabled": true, "scheduleTypestopOnFail": "weekly"true, "schedulescheduleTimeType": "* * * * 1weekly", "seedschedule": ["AAABcIueWUd=", "AAABcIueWUe="],"0 0 0 ? * SUN *", "actioncompleteThreshold": "start"0.65, "crawlTypeseeds": ["fullAAABcIueWUd=" , "AAABcIueWUe="], }, { "id"seedsFilter":{"tags": "AAABcIueWU1"["tag1","tag2"]}, "typeaction": "sequencestart", "descriptioncrawlMode": "Rollup"full" }, { "enabledid": false"AAABcIueWU1", "aftertype": "* * * * 1sequence", "seeddescription": ["AAABcIudWUd=",Rollup" "AAABcIudWUe="]enabled": false, "actionstopOnFail": "start"true, "crawlTypeafter": "incremental" }] } |
Status
0 0 0 ? * SUN *",
"completeThreshold": 0.65,
"seeds": ["AAABcIudWUd=", "AAABcIudWUe="],
"seedsFilter":{"tags":["tag1","tag2"]},
"action": "start",
"crawlMode": "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 one or more schedules in Aspire. This endpoint needs at least the ADMINISTRATOR role to be executed.
Path and Request Body Parameters
Body Parameters
Other parameters passed in the request body will depend on the type of schedule being created - see Add schedule(s) above Examples Update a single schedule
Update multiple schedules
Response
Status | |||||||||||||||||||||||||||||||||||||||||
Response code | Description | ||||||||||||||||||||||||||||||||||||||||
200 | Success | ||||||||||||||||||||||||||||||||||||||||
404 | Not found - a given schedule identifier was not found | ||||||||||||||||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input |
to update | |||
(see add schedule) | x |
x - at least one field must be present
Example
Code Block | ||||
---|---|---|---|---|
| ||||
PUT /aspire/_api/schedules
{
"AAABcIueWU0=": {
"id": "AAABcIueWU0",
"description": "Weekly seeds"
"enabled": true,
"stopOnFail": true,
"scheduleTimeType": "weekly",
"schedule": "0 0 0 ? * SUN *",
"seeds": ["AAABcIueWUd=", "AAABcIueWUe="],
"seedsFilter":{"tags":["tag1","tag2"]},
"action": "start",
"crawlMode": "full"
},
"AAABcIueWU1": {
"id": "AAABcIueWU1",
"description": "Rollup"
"enabled": false,
"stopOnFail": true,
"schedule": "0 0 0 ? * SUN *",
"seeds": ["AAABcIudWUd=", "AAABcIudWUe="],
"seedsFilter":{"tags":["tag1","tag2"]},
"action": "start",
"crawlMode": "incremental"
}
} |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{"schedule":[{"updated":true,"id":"AAABcID5GBc="},{"updated":true,"id":"AAABcID5GBd="}]} |
Status: 200, 404, 406
Section | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update schedules, filteredUpdate schedules configured in the Aspire, filtered by specified criteria. This endpoint needs at least the ADMINISTRATOR role to be executed.
Filters: Check the schedule filter definition here.
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 | |||||||||||||||||||||||||||||||||||||||||
Section | |||||||||||||||||||||||||||||||||||||||||
Delete schedulesDelete one or more schedules from Aspire.
Path and Request Body Parameters
Examples Delete Executes a single schedule
Executes multiple schedules
ResponseDelete multiple schedules
Response
Status | |||||||||||||||||||||||||||||||||||||||||
Response code | Description | ||||||||||||||||||||||||||||||||||||||||
200 | Success | ||||||||||||||||||||||||||||||||||||||||
404 | Not found - a given schedule identifier was not found | 406 | Not acceptable - there was an issue validating the input
| |||
{
"AAABcIueWU1": {
"status": "success"
},
"AAABcIueWU2": {
"status": "failed"
}
} |
Status: 200, 404