The schedules API provides functionality that allows a administrator to add, delete or update schedules

Table of Contents

description

Section

Get all schedules

Lists all the schedules configured in the Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/schedules

Query String Parameters

Name	Type	Required	Description

type

from

string

integer

Optional

Filter returned schedules to only those with the given type

Indicates the initial page to be retrieved
size	integer	Optional	Specifies the size of results page
sortBy	string	Optional

Filter returned schedules to only those whose description matches the given expressionrunningbooleanOptional

Field by which results are sorted

sortMode

string

Optional

Sort mode

"asc" for ascending sort,
"desc" for descending sort

Filter returned schedules to only running schedules

Response

Code Block

language	js

{
  "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

a single schedule

all schedules, filtered

Lists schedules configured in the Aspire, filtered by a specified criteriaGet information about a single schedule configured in Aspire

Panel

borderColor	black
bgColor	#fafafb

GET POST /aspire/_api/schedules/:idgetAll

Path Query String Parameters

idstring

Name	Type	Required	Description
from	integer	RequiredOptional	The id of the schedule to return

Response

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 "asc" for ascending sort, "desc" for descending sort

Body Parameters

Name	Type	Required	Description
filter	JSON	Required	Filters retrieved credentials. Check the filter definition here

Response

Code Block

language	js

{
  "credential": [{

Code Block

language	js

{
  "schedule": {
    "id": "AAABcID5GBc=",
    "type": "time",
    "descriptionid": "Weekend after officeAAABcID5GBc=",
    "runningtype": false,
    "enabledfilesystem": true,
    "seeddescription": ["AAABcIueWUd=", "AAABcIueWUe="]"Sales HD1 credentials",
    "propertiescreated": {1596707252548,
      "actionupdated": 1596707252548,
	"start",
      "crawlType": "incremental",    
  properties": { This will be a dynamic JSON object } 
  },
  {
    "scheduleTypeid": "customAAABcIueWUc=",
      "scheduletype": "* * * * 1filesystem",
      "lastdescription": 123456789 "Sales HD2 credentials",
      "nextcreated": 1234567891596707252548,
  },
  "messageupdated": "optional response message"1596707252548,
	"properties": { This will be a dynamic JSON object }  
  }]
}

Status

The given schedules id was not found

Response code	Description
200	Success	404

Section

Get a single schedule

Get information about a single schedule configured in

Add schedules

Add one or more schedules to Aspire

Panel

borderColor	black
bgColor	#fafafb

POST

GET /aspire/_api/schedules

/:id

Query String Request Body Parameters

Name	Type	Required	Description
typeid	string	Required	The type id of the schedule to addreturntime

Response

sequence

Code Block

description

language

string

Optional

An optional description of the schedule

js

{
  "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

Response code	Description
200	Success
404	The given schedules id was not found

Other parameters passed in the request body will depend on the type of schedule being created. Some candidates are shown below

Examples

Add a single schedule

Section

Add schedules

Add schedules to Aspire

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/schedules

Body Parameters

Name	Type	Required	Description
type	string	Required	The type of schedule to add "time" "sequence"
description	string	Optional	An optional description of the schedule
action	string	Optional	The action to perform by the scheduled task "start" "stop" "pause" "resume"
crawlType	string	Optional	The type of crawl to perform by the scheduled task "full" "incremental" "cache groups"

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 "hourly" "daily" "weekly" "monthly" "custom"
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

Example

Code Block

language	js

POST /aspire/_api/schedules
[{
  "type": "time",
  "description": "Weekly seeds"
  "enabled": true,
  "scheduleType": "weekly",
  "schedule": "* * * * 1",
  "seed": ["AAABcIueWUd=", "AAABcIueWUe

action

string

Optional

The action to perform by the scheduled task

start
stop
pause
resume

crawlType

string

Optional

The type of crawl to perform by the scheduled task

full
incremental
cache groups

Name Type Required Description

enabled boolean Optional Whether this schedule is enabled or not

scheduleType

string

Optional

The type of the time based schedule

hourly
daily
weekly
monthly
custom

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

Code Block

language	js

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

language	js

POST /aspire/_api/schedules
[{
  "type": "time",
  "description": "Weekly seeds"
  "enabled": true,
  "scheduleType": "weekly",
  "schedule": "* * * * 1",
  "seed": ["AAABcIueWUd=", "AAABcIueWUe="],
  "action": "start",
  "crawlType": "full"
},
{
  "type": "sequence",
  "description": "Rollup"
  "enabled": false,
  "after": "* * * * 1",
  "seed": ["AAABcIudWUd=", "AAABcIudWUe="],
  "action": "start",
  "crawlType": "incrementalfull"
}]

Response

Code Block

language	js

{
,
{
  "scheduletype": [{
 "sequence",
   "iddescription": "AAABcIueWU0Rollup",
    "typeenabled": "time"false,
    "descriptionafter": "Weekly* seeds"
* * *  1"enabled": true,
    "scheduleTypeseed": "weekly",
    "schedule": "* * * * 1",
    "seed": ["AAABcIueWUd["AAABcIudWUd=", "AAABcIueWUeAAABcIudWUe="],
    "action": "start",
    "crawlType": "fullincremental"
}]

Response

Code Block

language	js

{
  "schedule": [   },
   {
    "id": "AAABcIueWU1AAABcIueWU0",
    "type": "sequencetime",
    "description": "RollupWeekly seeds"
    "enabled": true,
    "scheduleType": false"weekly",
    "afterschedule": "* * * * 1",
    "seed": ["AAABcIudWUdAAABcIueWUd=", "AAABcIudWUeAAABcIueWUe="],
    "action": "start",
    "crawlType": "incrementalfull"
   }]
}

Status

Response codeDescription201Created406Not acceptable - there was an issue validating the input

,
   {
    "id": "AAABcIueWU1",
    "type": "sequence",
    "description": "Rollup"
    "enabled": false,
    "after": "* * * * 1",
    "seed": ["AAABcIudWUd=", "AAABcIudWUe="],
    "action": "start",
    "crawlType": "incremental"
 }]
}

Status

Response code	Description
201	Created
406	Not acceptable - there was an issue validating the input

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

Section

Update schedules

Update schedules in Aspire.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/schedules

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

Other parameters passed in the request body will depend on the type of schedule being created - see Add schedule(s) above

Example

Code Block

language	js

PUT /aspire/_api/schedules
{
  "AAABcIueWU0=": {
    "id": "AAABcIueWU0

Section

Update schedules

Update one or more schedules in Aspire.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/schedules/:id

PUT /aspire/_api/schedules

Path and Request 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

language	js

PUT /aspire/_api/schedules/AAABcIueWU0%3D
{
  "id": "AAABcIueWU0=",
  "type": "time",
  "description": "Weekly seeds"
  "enabled": true,
  "scheduleType": "weekly",
  "schedule": "* * * * 1",
  "seed": ["AAABcIueWUd=", "AAABcIueWUe="],
  "action": "start",
  "crawlType": "full"
}

Update multiple schedules

Code Block

language	js

PUT /aspire/_api/schedules
{
  "AAABcIueWU0=": {
    "id": "AAABcIueWU0",
    "type": "time",
    "description": "Weekly seeds"
    "enabled": true,
    "scheduleType": "weekly",
    "scheduletype": "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

language	js

{
  "schedule": [{
    "id": "AAABcIueWU0",
    "type": "time",
    "description": "Weekly seeds"
    "enabled": true,
    "scheduleType": "weekly",
    "schedule": "* * * * 1",
    "seed": ["AAABcIueWUd=", "AAABcIueWUe="],
    "action": "start",
    "crawlType": "full"
   },
   {
    "id": "AAABcIueWU1",
    "type": "sequence",
    "description": "Rollup"
    "enabled": false,
    "after": "* * * * 1",
    "seed": ["AAABcIudWUd=", "AAABcIudWUe="],
    "action": "start",
    "crawlType": "incremental"
    }]
}

Status

Response codeDescription200Success404Not found - a given schedule identifier was not found406Not acceptable - there was an issue validating the input

   "action": "start",
    "crawlType": "incremental"
    }]
}

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

Section

Delete multiple schedules, filtered

Delete multiple schedules from Aspire, filtered by a specified criteria

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/schedules/deleteAll

Body Parameters

Name	Type	Required	Description
filter	JSON	Required	Filters retrieved credentials. Check the filter definition here

Response

Code Block

language	js

{
  "message": "optional response message"
}

See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors

Status

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

Examples

Delete a single schedule

Section

Delete single schedule

Delete a single schedule from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/schedule/:id

Query String Parameters

Name	Type	Required	Description
id	string	Required	The identifier(s) of the schedule(s) to delete

Example

Code Block

language	js

DELETE

Section

Delete schedules

Delete one or more schedules from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE

/aspire/_api/schedule/

:id

DELETE /aspire/_api/schedule

Path and Query String Parameters

Name Type Required Description

id string Required The identifier(s) of the schedule(s) to delete

Code Block

language	js

DELETE /aspire/_api/schedule/AAABcID5GBc%3D

Delete multiple schedules

Code Block

language	js

DELETE /aspire/_api/schedule?id=AAABcID5GBc%3d&id=AAABcIueWUc%3D

AAABcID5GBc%3D

Response

Code Block

language	js

{
  "message": "optional response message"
}

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

Not acceptable - there was an issue validating the input

Section

Filters
Anchor
FiltersAnchor
FiltersAnchor

Some endpoint queries require a filter. A filter is basically a JSON object with the following format:

Credentials filter:Response

Code Block

language	js

  "filter" : {
    "ids" : ["id1", "id2", "id3"],
    "type" : "TYPE",
    "messagedescription" : "DESCRIPTION"optional
 response message"}
}

Status

Response code

Description

200

Success

404

Not found - a given schedule identifier was not found

406

Note
When using delete endpoints, ids in the filter are mandatory.

Page tree

Versions Compared

Old Version 15

New Version 16

Key

Get all schedules

Get

all schedules, filtered

Get a single schedule

Add schedules

Add schedules

Update schedules

Update schedules

Delete multiple schedules, filtered

Delete single schedule

Delete schedules

Filters
Anchor
FiltersAnchor
FiltersAnchor

Page tree

Page History

Versions Compared

Old Version 15

New Version 16

Key

Get all schedules

Get

all schedules, filtered

Get a single schedule

Add schedules

Add schedules

Update schedules

Update schedules

Delete multiple schedules, filtered

Delete single schedule

Delete schedules

Filters AnchorFiltersAnchorFiltersAnchor

Filters
Anchor
FiltersAnchor
FiltersAnchor