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

toc

Easy Heading Free

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

Pagination query string parameters

Sorting query string parameters

Section

Get all schedules

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

Panel

borderColor	black
bgColor	#fafafb

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

Section

Get all schedules, filtered

Lists schedules configured in Aspire, filtered by the specified criteria, this endpoint needs 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: Find the schedule filter definition here

Response

Code Block

language	js
theme	RDark

{
    "count": {
        "totalItems": 1
    }

Response

Code Block

language	js

{
  "schedule": [{
    "id": "AAABcID5GBc=",
    "type": "time",
    "description": "Weekend after office",
    "runningschedule": false,[
     "enabled": true,   {
    "seed        "id": ["AAABcIueWUd="258962bd-1ad0-4881-af16-ed7774857ab5",
 "AAABcIueWUe="],
    "properties": {
      "actiontype": "starttime",
            "crawlTypedescription": "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,
      "seed": ["AAABcIueWUd=", "AAABcIueWUe="],"09db4593-ce57-4edd-9e24-1dc0d8dc4e24"
      "properties": {
     ],
   "action": "start",
        "crawlTypecrawlMode": "incrementalfull",
    
        "afterScheduleaction": "AAABcID5GBc=start",
        }
 "last": 123456789
      }
    },
    ...
  ],
  "from": 100,
  "size": 10,
  "totalItems": 10000,
  "message": "optional response message"
}

Status

Response codeDescription200Success

]
}

Status: 200

: 200, 404

Section

Get a single schedule information

This endpoint needs at least the ADMINISTRATOR role to be executed.

Panel

Section

Get a single schedule

Get information about a single schedule configured in Aspire

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": "AAABcID5GBc=258962bd-1ad0-4881-af16-ed7774857ab5",
        "type": "time",
        "description": "WeekendTest after officeschedules",
    "running": false,
    "enabled": "true",
        "seedschedule": ["AAABcIueWUd=", "AAABcIueWUe="],
    "properties": {
0 3 1/5 ? * *",
        "actionafter": "startpepo",
        "crawlTypeseeds": "incremental",[
     
      "scheduleType": "custom81e23e44-4952-4938-8b1c-67b9101a3aad",
       "schedule": "* * * * 1"     "09db4593-ce57-4edd-9e24-1dc0d8dc4e24"
        ],
        "lastcrawlMode": 123456789"full",
        "nextaction": 123456789
  },
  "message": "optional response message" "start"
    }
}

Status

Response code Description

200 Success

404 The given schedules id was not found

crawlType

Section

Add schedule(s) to Aspire

This endpoint needs at least the ADMINISTRATOR role to be executed.

Section

Add schedules

Add one or more schedules to Aspire

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/schedules

Request Body ParametersParameters

Name

Type

Required

Description

type

string

Required

The type of schedule to add

"time"
"sequence"

description

string

Optional

Required

An optional description

Description of the schedule

action

seeds

string

Optional

The action to perform by the scheduled task

start
stop
pause
resume

the seed(s) this schedule applies to (If we do not insert seeds, the schedule is useful just for testing purposes)
seedsFilter	string	Optional	The

type of crawl to perform by the scheduled task

full
incremental
sequential
cache groups

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

NameTypeRequiredDescriptionenabledbooleanOptionalWhether this schedule is enabled or notscheduleTypestringOptional

The type of the time based schedule

hourly
daily
weekly
monthly
custom

schedulestringOptionalthe cron like schedule for a time based scheduleafterstringOptionalthe id of the schedule after which this schedule should run (for a sequence based schedule)seedstringOptionalthe seed(s) this schedule applies to

filter for finding seeds this schedules applies to. JSON format follows the format of the filter for seeds. If the above "seeds" parameter has been used, then the "seedsFilter" will be ignored when the schedule starts.
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"
completeThreshold	number	Optional	Percentage of seeds to complete their crawl before continuing with the next schedule in the sequence. The value is a number up to 1. E.g. 0.69 means 69 %. Default is 1.
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
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

language	js
theme	RDark

Examples

Add a single schedule

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,
  "stopOnFail": true, 
  "scheduleTypescheduleTimeType": "weekly",
  "schedule": "*0 0 0 ? * *SUN * 1",
  "seedcompleteThreshold": [0.65,
  "seeds": ["AAABcIueWUd=", "AAABcIueWUe="],
  "seedsFilter":{"tags":["tag1","tag2"]},
  "action": "start",
  "crawlTypecrawlMode": "full"
},
{
  "type": "sequence",
  "description": "Rollup"
  "enabled": false,
  "stopOnFail": true,  
  "after": "*0 0 0 ? * *SUN * 1",    
  "seedcompleteThreshold": ["0.65,
  "seeds": ["AAABcIudWUd=", "AAABcIudWUe="],    
  "seedsFilter":{"tags":["tag1","tag2"]},
  "action": "start",
  "crawlTypecrawlMode": "incremental"
}]

ResponseResponse

Code Block

language	js
theme	RDark

{
  "schedule": [{
    "id": "AAABcIueWU0",
    "type": "time",
    "description": "Weekly seeds"
    "enabled": true,
    "scheduleTypestopOnFail": "weekly"true,  
     "schedulescheduleTimeType": "* * * * 1weekly",
    "seedschedule": ["AAABcIueWUd=", "AAABcIueWUe="],"0 0 0 ? * SUN *",    
    "actioncompleteThreshold": "start"0.65,
    "crawlTypeseeds": ["fullAAABcIueWUd="
 , "AAABcIueWUe="],  },
   {
    "id"seedsFilter":{"tags": "AAABcIueWU1"["tag1","tag2"]},
     "typeaction": "sequencestart",
    "descriptioncrawlMode": "Rollup"full"
   },
   {
    "enabledid": false"AAABcIueWU1",
    "aftertype": "* * * * 1sequence",
    "seeddescription": ["AAABcIudWUd=",Rollup"
    "AAABcIudWUe="]enabled": false,
    "actionstopOnFail": "start"true,  
     "crawlTypeafter": "incremental"
 }]
}

Status

Response codeDescription201Created406Not acceptable - there was an issue validating the input

0 0 0 ? * SUN *",
    "completeThreshold": 0.65,
    "seeds": ["AAABcIudWUd=", "AAABcIudWUe="],    
    "seedsFilter":{"tags":["tag1","tag2"]},
    "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 needs at least the ADMINISTRATOR role to be executed.

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

Body Parameters

typestring

Name	Type	Required	Description
id	The type of schedule	description	string	Optional	Required	The identifier 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

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",
    "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 code Description

200 Success

404 Not found - a given schedule identifier was not found

406 Not acceptable - there was an issue validating the input

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,
	"stopOnFail": true,  
    "scheduleTimeType": "weekly",
    "schedule": "0 0 0 ? * SUN *",
    "seeds": ["AAABcIueWUd=", "AAABcIueWUe="],    
    "seedsFilter":{"tags":["tag1","tag2"]},
    "action": "start",
    "crawlMode": "full"
  },
  "AAABcIueWU1": {
    "id": "AAABcIueWU1",
    "description": "Rollup"
    "enabled": false,
	"stopOnFail": true,  
    "schedule": "0 0 0 ? * SUN *",
    "seeds": ["AAABcIudWUd=", "AAABcIudWUe="],
    "seedsFilter":{"tags":["tag1","tag2"]},
    "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 specified criteria. This endpoint needs at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/schedules/updateAll

Filters: Check 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",
    "stopOnFail": true,  
    "scheduleTimeType" : "SCHEDULE_TIME_TYPE",
    "seeds" : ["SEED1", "SEED2", "SEED3", ...],      
    "seedsFilter":{"tags":["tag1","tag2"]},
    "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 schedules(s)

Delete one or more schedules from Aspire. This endpoint needs 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

Delete multiple schedules, filtered

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

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/schedules/deleteAll

Filters: See the schedule filter definition here.

Response

Code Block

language	js
theme	RDark

{
  "message": "optional response message"
}

Status: 200

Section

Export schedule(s)

Export one or more schedule from Aspire, this endpoint needs at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/schedule/export

GET /aspire/_api/schedules/export/:id

POST /aspire/_api/schedules/exportAll

Info

Every configuration item has the option to export from the UI, using the single menu or by the bulk actions:

Image AddedImage Added

Note
Something important that you need to know is that when you export a config item that depends on another, the export will contain also all the dependencies.

Note
Take into consideration that components with resources loaded into elastic, will be exported, but the resource itself will not, so you will need to reupload the resource and go and select your resource in the component again.

Path Parameters and Query parameters

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

Body Parameter

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

Examples

Code Block

language	js
theme	RDark

GET /aspire/_api/schedules/export/AAABcID5GBc

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

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

Response

Code Block

language	js
theme	RDark

{
  "export": {
    "schedules": {
      "schedule": {
        "id": "<schedule_id>",
        "type": "time",
        "description": "test",
        "enabled": "false",
        "scheduleTimeType": "daily",
        "stopOnFail": false,
        "schedule": "0 0 0 1\/1 * ?",
        "after": null,
        "seeds": "<seed_id>",
        "crawlMode": "full",
        "completeThreshold": 1.0,
        "action": "pause"
      },
      ...
    },
    "seeds": {
      "seed": [
        {
          "id": "<seed_id>",
          "type": "rest-api",
          "description": "RestSeed",
          "connector": "<connector_id>",
          "seed": "N\/A",
          "priority": "medium",          
          "connection": "<connectio_id>",
          "workflows": [
            "<workflow_id>"
          ],
          "properties": {
            "seed": "N\/A",
            "crawlRules": [
              ...
            ],
            "stopOnScannerError": true
          }
        },
        ...
      ]
    },
    "connectors": {
      "connector": [
        {
          "id": "<connector_id>",
          "artifact": "com.accenture.aspire:aspire-rest-source",
          "type": "rest-api",
          "description": "RestConnector",
          "properties": {
            "debug": false,
            "wDebug": false,
            ...
          }
        },
        ...
      ]
    },
    "connections": {
      "connection": [
        {
          "id": "<connection_id>",
          "type": "rest-api",
          "description": "RestConnection",
          "properties": {
            ....
          }
        },
        ...
      ]
    },
    "workflows": {
      "workflow": [
        {
          "id": "<workflow_id>",
          "type": "connector",
          "description": "myWorkFlow",
          "templates": {
            ...            
          },
          "events": {
            "event": [
              ...
            ]
          },
          "rules": {
            "rule": [
              ...
            ]
          }
        },
        ...
      ]
    }
  }
}

Status: 200, 404, 406

Section

Export multiple schedules, filtered

Export multiple schedules from Aspire, filtered by a specified criteria, this endpoint needs at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/schedules/exportAll

Filters: The connection filter definition here

Response

Code Block

language	js
theme	RDark

{
  "export": {
    "schedules": {
      "schedule": {
        "id": "<schedule_id>",
        "type": "time",
        "description": "test",
        "enabled": "false",
        "scheduleTimeType": "daily",
        "stopOnFail": false,
        "schedule": "0 0 0 1\/1 * ?",
        "after": null,
        "seeds": "<seed_id>",
        "crawlMode": "full",
        "completeThreshold": 1.0,
        "action": "pause"
      },
      ...
    },
    "seeds": {
      "seed": [
        {
          "id": "<seed_id>",
          "type": "rest-api",
          "description": "RestSeed",
          "connector": "<connector_id>",
          "seed": "N\/A",
          "priority": "medium",          
          "connection": "<connectio_id>",
          "workflows": [
            "<workflow_id>"
          ],
          "properties": {
            "seed": "N\/A",
            "crawlRules": [
              ...
            ],
            "stopOnScannerError": true
          }
        },
        ...
      ]
    },
    "connectors": {
      "connector": [
        {
          "id": "<connector_id>",
          "artifact": "com.accenture.aspire:aspire-rest-source",
          "type": "rest-api",
          "description": "RestConnector",
          "properties": {
            "debug": false,
            "wDebug": false,
            ...
          }
        },
        ...
      ]
    },
    "connections": {
      "connection": [
        {
          "id": "<connection_id>",
          "type": "rest-api",
          "description": "RestConnection",
          "properties": {
            ....
          }
        },
        ...
      ]
    },
    "workflows": {
      "workflow": [
        {
          "id": "<workflow_id>",
          "type": "connector",
          "description": "myWorkFlow",
          "templates": {
            ...            
          },
          "events": {
            "event": [
              ...
            ]
          },
          "rules": {
            "rule": [
              ...
            ]
          }
        },
        ...
      ]
    }
  }
}

Status: 200

Section

Import

The import usage can be found here

Section

Filters
Anchor
FiltersAnchor
FiltersAnchor

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

Schedule filter:

Code Block

language	js
theme	RDark

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

Not acceptable - there was an issue validating the input

Section

Execute schedules

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

Section

Delete schedules

Delete one or more schedules from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/schedule/:id

DELETE POST /aspire/_api/schedules/scheduleexecute

Path and Request Body Parameters

identifier(s) (s) to delete

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

Examples

Delete Executes a single schedule

Code Block

language	js

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

theme	RDark

{
  "id" : "AAABcIueWU1"
}

Executes multiple schedules

Code Block

theme	RDark

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

ResponseDelete multiple schedules

Code Block

language	js

DELETE /aspire/_api/schedule?id=AAABcID5GBc%3d&id=AAABcIueWUc%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


theme	RDark

{
    "AAABcIueWU1": {
        "status": "success"
    },
	"AAABcIueWU2": {
        "status": "failed"
    }
}

Status: 200, 404

Page tree

Versions Compared

Old Version 13

New Version Current

Key

Get all schedules

Get all schedules, filtered

Get a single schedule information

Get a single schedule

Add schedule(s) to Aspire

Add schedules

Update schedule(s)

Update schedules

Update schedules, filtered

Delete schedules(s)

Delete multiple schedules, filtered

Export schedule(s)

Export multiple schedules, filtered

Import

Filters
Anchor
FiltersAnchor
FiltersAnchor

Execute schedules

Delete schedules

Page tree

Page History

Versions Compared

Old Version 13

New Version Current

Key

Get all schedules

Get all schedules, filtered

Get a single schedule information

Get a single schedule

Add schedule(s) to Aspire

Add schedules

Update schedule(s)

Update schedules

Update schedules, filtered

Delete schedules(s)

Delete multiple schedules, filtered

Export schedule(s)

Export multiple schedules, filtered

Import

Filters AnchorFiltersAnchorFiltersAnchor

Execute schedules

Delete schedules

Filters
Anchor
FiltersAnchor
FiltersAnchor