Warning | ||
---|---|---|
| ||
This page is in development and as such, its contents may be incorrect |
The schedules API provides functionality that allows a administrator to add, delete or update schedules
Table of Contents |
---|
Section | |||||||
---|---|---|---|---|---|---|---|
Get all schedulesLists all the schedules configured in the Aspire
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 |
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
},
{
"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
Lists schedules configured in the Aspire, filtered by a specified criteria
Panel | ||||
---|---|---|---|---|
| ||||
|
Query String Parameters
Sort mode
Body Parameters
Pagination query string parameters
Response
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
}
},
{
"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
Response code | Description |
---|---|
200 | Success |
Section | |||||||
---|---|---|---|---|---|---|---|
Get all schedules, filteredLists schedules configured in the Aspire, filtered by a specified criteria
|
Section | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Get a single scheduleGet information about a single schedule configured in Aspire
Path Parameters
Query String Parameters
Response
Status
|
Section | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Add schedulesAdd schedules to Aspire
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
Status
|
Section | |||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Update schedulesUpdate schedules in Aspire.
Body Parameters
Other parameters passed in the request body will depend on the type of schedule being created - see Add schedule(s) above Example
Response
Status
|
Section | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete multiple schedules, filteredDelete multiple schedules from Aspire, filtered by a specified criteria
Body Parameters
Response
See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors Status
|
Section | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Delete single scheduleDelete a single schedule from Aspire.
Path Parameters
Example
Response
Status
|
Section | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filters
Some endpoint queries require a filter. A filter is basically a JSON object with the following format: Credentials filter:
|