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 endpoint needs at least the ADMINISTRATOR role to be executed.
Query String Parameters | |||||||
Name | Type | Required | Description | ||||
from | integer | Optional | Indicates the initial page to be retrieved | ||||
size | integer | Optional | Specifies the size of results page | ||||
sortBy | string | Optional | Field by which results are sorted | ||||
sortMode | string | Optional | Sort mode
| ||||
expand | string | Optional | List of fields to expand, * will expand everything |
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 | ||||
---|---|---|---|---|
| ||||
{ "schedulecount": [{ "id": "AAABcID5GBc=", "typetotalItems": "time" 1 }, "descriptionschedule": "Weekend[ after office", "running": false, { "enabled": true, "seedid": ["AAABcIueWUd="258962bd-1ad0-4881-af16-ed7774857ab5", "AAABcIueWUe="], "properties": { "actiontype": "starttime", "crawlType "description": "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, 09db4593-ce57-4edd-9e24-1dc0d8dc4e24" "seed": ["AAABcIueWUd=", "AAABcIueWUe="], "properties": { "actioncrawlMode": "startfull", "crawlType": "incremental", "afterSchedule"action": "AAABcID5GBc=", "last": 123456789 start" } }, ... ], } "from": 100, "size": 10, "sortBy": "id", "sortMode": "asc", "totalItems": 10000, "message": "optional response message" } |
Status
Status: 200
Section | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a single schedule informationThis endpoint needs at least the ADMINISTRATOR role to be executed.
Get all schedules, filteredLists schedules configured in the Aspire, filtered by a specified criteria
Query String Path Parameters
Body Parameters | ||||||||||||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||||||||||||
filter | JSON | Required | Filters retrieved schedules. Check the filter definition here |
The id of the schedule to return |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{
"schedule": {
"id": "258962bd-1ad0-4881-af16-ed7774857ab5",
"type": "time",
"description": "Test schedules |
Response
Code Block | ||
---|---|---|
| ||
{ "schedule": [{ "id": "AAABcID5GBc=", "typeenabled": "timetrue", "descriptionschedule": "Weekend after office0 3 1/5 ? * *", "runningafter": false"pepo", "enabled": true, "seedseeds": ["AAABcIueWUd=", "AAABcIueWUe="], "properties": { "action": "start81e23e44-4952-4938-8b1c-67b9101a3aad", "crawlType": "incremental", "09db4593-ce57-4edd-9e24-1dc0d8dc4e24" "scheduleType": "custom" ], "schedulecrawlMode": "* * * * 1full", "lastaction": 123456789, "next": 123456789"start" } }, { "id": "AAABcID5GBc=", "type": "sequence", "description": "Sequential schedule", "running": false, "enabled": true, "seed": ["AAABcIueWUd=", "AAABcIueWUe="], "properties": { "action": "start", "crawlType": "incremental", "afterSchedule": "AAABcID5GBc=", "last": 123456789 } }, ... ], "from": 100, "size": 10, "sortBy": "id", "sortMode": "asc", "totalItems": 10000, "message": "optional response message" } |
Status
} |
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: Get a single scheduleGet information about a single schedule configured in Aspire
Path Parameters
Query String Parameters | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
expand | string | Optional | List of fields to expand, * will expand everything |
Code Block | ||
---|---|---|
| ||
{
"schedule": {
"id": "AAABcID5GBc=",
"type": "time",
"description": "Weekend after office",
"running": false,
"enabled": true,
"seed": ["AAABcIueWUd=", "AAABcIueWUe="],
"properties": {
"action": "start",
"crawlType": "incremental",
"scheduleType": "custom",
"schedule": "* * * * 1",
"last": 123456789,
"next": 123456789
},
"message": "optional response message"
} |
Status
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 | ||||
---|---|---|---|---|
| ||||
POST /aspire/_api/schedules
[{
"type": "time",
"description": "Weekly seeds"
"enabled": true,
"stopOnFail": true,
"scheduleTimeType": "weekly",
"schedule": "0 0 0 ? * SUN *",
"completeThreshold": 0.65,
"seeds": ["AAABcIueWUd=", "AAABcIueWUe="],
"seedsFilter":{"tags":["tag1","tag2"]},
"action": "start",
"crawlMode": "full"
},
{
"type": "sequence",
"description": "Rollup"
"enabled": false,
"stopOnFail": true,
"after": "0 0 0 ? * SUN *",
"completeThreshold": 0.65,
"seeds": ["AAABcIudWUd=", "AAABcIudWUe="],
"seedsFilter":{"tags":["tag1","tag2"]},
"action": "start",
"crawlMode": "incremental"
}] |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{
"schedule": [{
"id": "AAABcIueWU0",
"type": "time",
"description": "Weekly seeds"
"enabled": true,
"stopOnFail": true,
"scheduleTimeType": "weekly",
"schedule": "0 0 0 ? * SUN *",
"completeThreshold": 0.65,
"seeds": ["AAABcIueWUd=", "AAABcIueWUe="],
"seedsFilter":{"tags":["tag1","tag2"]},
|
Add schedules to Aspire
Panel | ||||
---|---|---|---|---|
| ||||
POST /aspire/_api/schedules |
Body Parameters
The type of schedule to add
The action to perform by the scheduled task
The type of crawl to perform by the scheduled task
Other parameters passed in the request body will depend on the type of schedule being created. Some candidates are shown below:
The type of the time based schedule
Example
Code Block | ||
---|---|---|
| ||
POST /aspire/_api/schedules [{ "type": "time", "description": "Weekly seeds" "enabled": true, "scheduleType": "weekly", "schedule": "* * * * 1", "seed": ["AAABcIueWUd=", "AAABcIueWUe="], "action": "start", "crawlTypecrawlMode": "full" }, { "id": "AAABcIueWU1", "type": "sequence", "description": "Rollup" "enabled": false, "stopOnFail": true, "after": "0 0 0 ? * SUN *", * * 1""completeThreshold": 0.65, "seedseeds": ["AAABcIudWUd=", "AAABcIudWUe="], "actionseedsFilter": "start", "crawlType": "incremental" }] |
Response
Code Block | ||
---|---|---|
| ||
{ "schedule": [{ "id": "AAABcIueWU0"{"tags":["tag1","tag2"]}, "typeaction": "timestart", "descriptioncrawlMode": "Weekly seedsincremental" }] } |
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 needs at least the ADMINISTRATOR role to be executed.
Path Parameters
Body Parameters
x - at least one field must be present Example
Status | ||||||||||||||||||||||||||||||||||
Response code | Description | |||||||||||||||||||||||||||||||||
201 | Created | |||||||||||||||||||||||||||||||||
406 | Not acceptable - there was an issue validating the input | |||||||||||||||||||||||||||||||||
Section | ||||||||||||||||||||||||||||||||||
Response
Status: 200, 404, 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
Update schedulesUpdate schedules in Aspire.
Body Parameters | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Required | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
id | string | Required | The identifier of the schedule to update | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | string | Required | The type of schedule | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | Optional | An optional description of the schedule |
Code Block | ||
---|---|---|
| ||
PUT /aspire/_api/schedules
{
"AAABcIueWU0=": {
"id": "AAABcIueWU0",
"type": "time",
"description": "Weekly seeds"
"enabled": true,
"scheduleType": "weekly",
"schedule": "* * * * 1",
"seed": ["AAABcIueWUd=", "AAABcIueWUe="],
"action": "start",
"crawlType": "full"
},
"AAABcIueWU1": {
"id": "AAABcIueWU1",
"type": "sequence",
"description": "Rollup"
"enabled": false,
"after": "* * * * 1",
"seed": ["AAABcIudWUd=", "AAABcIudWUe="],
"action": "start",
"crawlType": "incremental"
}
} |
Response
Code Block | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||
{
"schedule": [{
|
Status
Delete multiple schedules from Aspire, filtered by a specified criteria
Panel | ||||
---|---|---|---|---|
| ||||
|
Body Parameters
Response
Code Block | ||
---|---|---|
| ||
{
"message": "optional response message"
} |
Status: 200 |
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: | |||||||
Response code | Description | ||||||
200 | Success | ||||||
404 | Not found - a given credential identifier was not found | ||||||
406 | Not acceptable - there was an issue validating the input | ||||||
Section | |||||||
Delete single scheduleDelete a single schedule from Aspire.
Path Parameters | |||||||
Name | Type | Required | Description | ||||
id | string | Required | The identifier(s) of the schedule(s) to delete |
Code Block | ||
---|---|---|
| ||
DELETE /aspire/_api/schedule/AAABcID5GBc%3D |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{ "filter" : { "ids" : ["ID1", "ID2", "ID3", ...], "type" : "TYPE", "description" : "message"DESCRIPTION", "seeds" : ["optional response message" } |
Status
SEED1", "SEED2", "SEED3", ...]
}
} |
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
| |||||||||||||||||||||||||
Section | |||||||||||||||||||||||||
Filters Anchor | | FiltersAnchor | FiltersAnchor |
Code Block | ||
---|---|---|
| ||
"filter" : { "ids" : ["ID1AAABcIueWU1", "ID2", "ID3", ...], AAABcIueWU2"] } |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
{ "AAABcIueWU1": { "typestatus" : "TYPEsuccess", }, "descriptionAAABcIueWU2" : "DESCRIPTION", "running{ "status": "true|falsefailed" } | ||||
Note | ||||
} |
Status: 200, 404