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

Get all schedules

Lists all the schedules configured in the Aspire

GET /aspire/_api/schedules

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

Response

{
  "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,
  "totalItems": 10000,
  "message": "optional response message"
}

Status

Response code	Description
200	Success

Get a single schedule

Get information about a single schedule configured in Aspire

GET /aspire/_api/schedules/:id

Path Parameters

Name	Type	Required	Description
id	string	Required	The id of the schedule to return

Response

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

Add schedules

Add one or more schedules to Aspire

POST /aspire/_api/schedules

Request 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

Examples

Add a single schedule

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

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": "incremental"
}]

Response

{
  "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 code	Description
201	Created
406	Not acceptable - there was an issue validating the input

Update schedules

Update one or more schedules in Aspire.

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

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

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

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

{
  "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 code	Description
200	Success
404	Not found - a given schedule identifier was not found
406	Not acceptable - there was an issue validating the input

Delete schedules

Delete one or more schedules from Aspire.

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

Examples

Delete a single schedule

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

Delete multiple schedules

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

Response

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

Page tree

Get all schedules

Get a single schedule

Add schedules

Update schedules

Delete schedules

Contact Us: [email protected]

Page tree

Schedules API

Get all schedules

Get a single schedule

Add schedules

Update schedules

Delete schedules

Contact Us: [email protected]