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

Easy Heading Free

navigationTitle	On this Page
navigationExpandOption	expand-all-by-default

Section

Get all schedules

Lists all the schedules configured in the Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/schedules

Pagination query string parameters

Sorting query string parameters

Section

Get all schedules, filtered

Lists schedules configured in the Aspire, filtered by a specified criteria, this endpoint need the at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/schedules/getAll

Pagination query string parameters

Sorting query string parameters

Filters: The schedule filter definition here

Response

Code Block

language	js
theme	RDark

{
    "count": {
        "totalItems": 1
    },
    "schedule": [
        {
            "id": "258962bd-1ad0-4881-af16-ed7774857ab5",
            "type": "time",
            "description": "Test schedules",
            "enabled": "true",
            "schedule": "0 3 1/5 ? * *",
            "after": "pepo",
            "seeds": [
                "81e23e44-4952-4938-8b1c-67b9101a3aad",
                "09db4593-ce57-4edd-9e24-1dc0d8dc4e24"
            ],
            "crawlMode": "full",
            "action": "start"
        }
    ]
}

Status: 200

Section

Get a single schedule

Get information about a single schedule configured in Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/schedules/:id

Path Parameters

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

Response

Code Block

language	js
theme	RDark

{
    "schedule": {
        "id": "258962bd-1ad0-4881-af16-ed7774857ab5",
        "type": "time",
        "description": "Test schedules",
        "enabled": "true",
        "schedule": "0 3 1/5 ? * *",
        "after": "pepo",
        "seeds": [
            "81e23e44-4952-4938-8b1c-67b9101a3aad",
            "09db4593-ce57-4edd-9e24-1dc0d8dc4e24"
        ],
        "crawlMode": "full",
        "action": "start"
    }
}

Status: 200, 404

Section

Add schedule(s)

Add schedules to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

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	Required	Description of the schedule
seeds	string	Optional	the seed(s) this schedule applies to (If we do not insert seeds the schedule is useful just for testing purposes)
action	string	Required if seeds are used	The action to perform by the scheduled task "start" "stop" "pause" "resume"
crawlMode	string	Required if seeds are used and action = start	The type of crawl to perform by the scheduled task "full" "incremental" "identity"
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

"hourly"
"daily"
"weekly"
"monthly"
"custom"

after

string

Required if type is "sequence"

the id of the schedule after which this schedule should run

Example

Code Block

language	js
theme	RDark

POST /aspire/_api/schedules
[{
  "type": "time",
  "description": "Weekly seeds"
  "enabled": true,
  "scheduleTimeType": "weekly",
  "schedule": "0 0 0 ? * SUN *",
  "seeds": ["AAABcIueWUd=", "AAABcIueWUe="],
  "action": "start",
  "crawlMode": "full"
},
{
  "type": "sequence",
  "description": "Rollup"
  "enabled": false,
  "after": "0 0 0 ? * SUN *",
  "seeds": ["AAABcIudWUd=", "AAABcIudWUe="],
  "action": "start",
  "crawlMode": "incremental"
}]

Response

Code Block

language	js
theme	RDark

{
  "schedule": [{
    "id": "AAABcIueWU0",
    "type": "time",
    "description": "Weekly seeds"
    "enabled": true,
    "scheduleTimeType": "weekly",
    "schedule": "0 0 0 ? * SUN *",
    "seeds": ["AAABcIueWUd=", "AAABcIueWUe="],
    "action": "start",
    "crawlMode": "full"
   },
   {
    "id": "AAABcIueWU1",
    "type": "sequence",
    "description": "Rollup"
    "enabled": false,
    "after": "0 0 0 ? * SUN *",
    "seeds": ["AAABcIudWUd=", "AAABcIudWUe="],
    "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 schedules in Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/schedules/:id

PUT /aspire/_api/schedules

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the schedule to update

Body Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the schedule to update
(see add schedule)		x

x - at least one field must be present

Example

Code Block

language	js
theme	RDark

PUT /aspire/_api/schedules
{
  "AAABcIueWU0=": {
    "id": "AAABcIueWU0",
    "description": "Weekly seeds"
    "enabled": true,
    "scheduleTimeType": "weekly",
    "schedule": "0 0 0 ? * SUN *",
    "seeds": ["AAABcIueWUd=", "AAABcIueWUe="],
    "action": "start",
    "crawlMode": "full"
  },
  "AAABcIueWU1": {
    "id": "AAABcIueWU1",
    "description": "Rollup"
    "enabled": false,
    "schedule": "0 0 0 ? * SUN *",
    "seeds": ["AAABcIudWUd=", "AAABcIudWUe="],
    "action": "start",
    "crawlMode": "incremental"
  }
}

Response

Code Block

language	js
theme	RDark

{"schedule":[{"updated":true,"id":"AAABcID5GBc="},{"updated":true,"id":"AAABcID5GBd="}]}

Status: 200, 404, 406

Section

Update schedules, filtered

Update schedules configured in the Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/schedules/updateAll

Filters: The schedule filter definition here

Update body parameter

Code Block

theme	RDark

{
  "update" : {
    "description" : "DESCRIPTION",
    "schedule" : "SCHEDULE",
    "action" : "ACTION",
    "after" : "AFTER",
    "crawlMode" : "crawlMode",
    "enabled" : "ENABLED",
    "scheduleTimeType" : "SCHEDULE_TIME_TYPE",
    "seeds" : ["SEED1", "SEED2", "SEED3", ...],
    "seeds.add" : ["SEED1", "SEED2", "SEED3", ...],
    "seeds.remove" : ["SEED1", "SEED2", "SEED3", ...],  }
}

Response

Code Block

language	js
theme	RDark

{
  "message": "update result response message"
}

Status: 200, 406

Section

Delete multiple schedules, filtered

Delete multiple schedules from Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/schedules/deleteAll

Filters: The schedule filter definition here

Response

Code Block

language	js
theme	RDark

{
  "message": "optional response message"
}

Status: 200

Section

Delete schedules(s)

Delete one or more schedules from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/schedules/:id

DELETE /aspire/_api/schedules

POST /aspire/_api/schedules/delete

Path Parameters and Query parameters

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

Body Parameter

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

Examples

Code Block

language	js
theme	RDark

DELETE /aspire/_api/schedules/AAABcID5GBc

DELETE /aspire/_api/schedules?id=AAABcID5GBc&id=AAABcID5GBd

POST /aspire/_api/schedules/delete
{
  "ids":["AAABcID5GBc","AAABcID5GBd"]
}

Response

Code Block

language	js
theme	RDark

{
  "message": "delete result response message"
}

Status: 200, 404, 406

Section

Filters
Anchor
FiltersAnchor
FiltersAnchor

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

Seed filter:

Code Block

language	js
theme	RDark

{ 
 "filter" : {
    "ids" : ["ID1", "ID2", "ID3", ...],
    "type" : "TYPE",
    "description" : "DESCRIPTION",
	"seeds" : ["SEED1", "SEED2", "SEED3", ...]
  }
}

Section

Execute schedules

Execute schedules, either sequence or time based, in Aspire. This endpoint needs at least an ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/schedules/execute

Body Parameters

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

Examples

Executes a single schedule

Code Block

theme	RDark

{
  "id" : "AAABcIueWU1"
}

Executes multiple schedules

Code Block

theme	RDark

{   
	"id" : ["AAABcIueWU1", "AAABcIueWU2"] 
}

Response

Code Block

language	js
theme	RDark

{
    "responseAAABcIueWU1": {
        "scheduleIdstatus": "AAABcIueWU1",success"
    },
	"AAABcIueWU2": {
        "status": "successfailed"
    }
}

Status: 200, 404

Page tree

Versions Compared

Old Version 56

New Version 57

Key

Get all schedules

Get all schedules, filtered

Get a single schedule

Add schedule(s)

Update schedule(s)

Update schedules, filtered

Delete multiple schedules, filtered

Delete schedules(s)

Filters
Anchor
FiltersAnchor
FiltersAnchor

Execute schedules

Page tree

Page History

Versions Compared

Old Version 56

New Version 57

Key

Get all schedules

Get all schedules, filtered

Get a single schedule

Add schedule(s)

Update schedule(s)

Update schedules, filtered

Delete multiple schedules, filtered

Delete schedules(s)

Filters AnchorFiltersAnchorFiltersAnchor

Execute schedules

Filters
Anchor
FiltersAnchor
FiltersAnchor