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

Section

Get all schedules

Lists all the schedules configured in the Aspire, this this endpoint need the needs 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 the specified criteria, this this endpoint need the 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: The Find the schedule filter definition 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"
            ],
            "crawl_modecrawlMode": "full",
            "action": "start"
        }
    ]
}

Status: 200

Section

Get a single schedule

information

This endpoint needs at least 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"
        ],
        "crawl_modecrawlMode": "full",
        "action": "start"
    }
}

Status: 200, 404

Section

Add schedule(s)

Add schedules

to Aspire

This endpoint needs , 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

action

seeds

string

Required

The action to perform by the scheduled task

"start"
"stop"
"pause"
"resume"

crawl_mode

string

Required

Optional	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 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

The type of crawl

to perform by the scheduled task:

"start"
"

full

stop"
"

incremental

pause"
"

identity"

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

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:

The type of the time based schedule

"hourly"

"daily"

"weekly"

"monthly"

"custom"

Name	Type	Required	Description
Name	Type	Required	Description
enabled	boolean	Optional	Whether this schedule is enabled or not. Defaults to false if omitted.
scheduleTimeType	string	Required if type is "time"
schedule	string	Required if type is "time"	the cron like schedule for a time-based schedule
afterscheduleTimeType	string	Optional	the id of the schedule after which this schedule should run (for a sequence based schedule)
seeds	string	Optional	the seed(s) this schedule applies to

Example

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

POST /aspire/_api/schedules
[{
  "type": "

Code Block

language	js

POST /aspire/_api/schedules
[{
  "type": "time",
  "description": "Weekly seeds"
  "enabled": true,
  "stopOnFail": true, 
  "scheduleTimeType": "weekly",
  "schedule": "*0 *0 0 ? * SUN * 1"",
  "completeThreshold": 0.65,
  "seeds": ["AAABcIueWUd=", "AAABcIueWUe="],
  "seedsFilter":{"tags":["tag1","tag2"]},
  "action": "start",
  "crawl_modecrawlMode": "full"
},
{
  "type": "sequence",
  "description": "Rollup"
  "enabled": false,
  "afterstopOnFail": "* * * * 1",true,  
  "seedsafter": ["AAABcIudWUd=", "AAABcIudWUe="]"0 0 0 ? * SUN *",    
  "completeThreshold": 0.65,
  "seeds": ["AAABcIudWUd=", "AAABcIudWUe="],    
  "seedsFilter":{"tags":["tag1","tag2"]},
  "action": "start",
  "crawl_modecrawlMode": "incremental"
}]

Response

Code Block

language	js
theme	RDark

{
  "schedule": [{
    "id": "AAABcIueWU0",
    "type": "time",
    "description": "Weekly seeds"
    "enabled": true,
    "stopOnFail": true,  
    "scheduleTimeType": "weekly",
    "schedule": "0 0 0 ? * SUN * * * 1"",    
    "completeThreshold": 0.65,
    "seeds": ["AAABcIueWUd=", "AAABcIueWUe="],    
    "seedsFilter":{"actiontags": "start"["tag1","tag2"]},
     "crawl_mode"action": "start",
    "crawlMode": "full"
   },
   {
    "id": "AAABcIueWU1",
    "type": "sequence",
    "description": "Rollup"
    "enabled": false,
    "stopOnFail": true,  
    "after": "0 0 0 ? * SUN *",
 *  * 1""completeThreshold": 0.65,
     "seeds": ["AAABcIudWUd=", "AAABcIudWUe="],
    "action": "start",
    "crawl_modeseedsFilter": {"incremental"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 need the . This endpoint needs 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
description	string	x	Description of the schedule
schedule	string	x	the cron like schedule for a time based schedule
action	string	x	The action to perform by the scheduled task "start" "stop" "pause" "resume"
after	string	x	the id of the schedule after which this schedule should run (for a sequence based schedule)
crawl_mode	string	x	The type of crawl to perform by the scheduled task "full" "incremental" "identity"
enabled	boolean	x	Whether this schedule is enabled or not
scheduleTimeType	string	x	The type of the time based schedule "hourly" "daily" "weekly" "monthly" "custom"
seeds	string	x	the seed(s) this schedule applies to

x - at least one field must be present

Example

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

Code Block

language	js

PUT /aspire/_api/schedules
{
  "AAABcIueWU0=": {
    "id": "AAABcIueWU0",
    "description": "Weekly seeds"
    "enabled": true,
    "scheduleTimeTypecrawlMode": "weeklyfull",
  },
  "scheduleAAABcIueWU1": "* * * * 1",{
    "seedsid": ["AAABcIueWUd=", "AAABcIueWUe="]AAABcIueWU1",
    "actiondescription": "startRollup",
    "crawl_modeenabled": "full"
  }false,
  	"AAABcIueWU1stopOnFail": {
  true,  "id": "AAABcIueWU1",
     "descriptionschedule": "Rollup"
0 0   "enabled": false,
    "schedule": "* * * * 10 ? * SUN *",
    "seeds": ["AAABcIudWUd=", "AAABcIudWUe="],
    "actionseedsFilter": {"start",tags":["tag1","tag2"]},
    "action": "start",
    "crawl_modecrawlMode": "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

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

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/schedules/updateAll

Filters:

The

Check the schedule filter

definition

definition here.

Update body parameter

Code Block

theme	RDark

{
  "update" : {
    "description" : "DESCRIPTION",
    "schedule" : "SCHEDULE",
    "action" : "ACTION",
    "after" : "AFTER",
    "

crawl_mode

crawlMode" : "

CRAWL_MODE

crawlMode",
    "enabled" : "ENABLED",
    "

scheduleTimeType

stopOnFail"

"SCHEDULE_TIME_TYPE",

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

Body Parameter

Section

Delete

multiple

schedules

, filtered

(s)

Delete multipleone or more schedules from Aspire, filtered by a specified criteria, this endpoint need the . This endpoint needs at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

POST DELETE /aspire/_api/schedules/deleteAll

Filters: The schedule filter definition here

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status: 200

Section

: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

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

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

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

Status: 200, 404, 406


{
  "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", ...]
  }
}

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

Seed filter:

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

Section

Execute schedules

Execute schedules, either sequence or time based. 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

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

Status: 200, 404

Section

Filters

Anchor

FiltersAnchor FiltersAnchor

Code Block

language	js

Page tree

Versions Compared

Old Version 41

New Version Current

Key

Get all schedules

Get all schedules, filtered

Get a single schedule

information

Add schedule(s)

to Aspire

Update schedule(s)

Update schedules, filtered

Delete

schedules

(s)

Delete schedules(s)

Delete multiple schedules, filtered

Export schedule(s)

Export multiple schedules, filtered

Import

Filters
Anchor
FiltersAnchor
FiltersAnchor

Execute schedules

Page tree

Page History

Versions Compared

Old Version 41

New Version Current

Key

Get all schedules

Get all schedules, filtered

Get a single schedule

information

Add schedule(s)

to Aspire

Update schedule(s)

Update schedules, filtered

Delete

schedules

(s)

Delete schedules(s)

Delete multiple schedules, filtered

Export schedule(s)

Export multiple schedules, filtered

Import

Filters AnchorFiltersAnchorFiltersAnchor

Execute schedules

Filters
Anchor
FiltersAnchor
FiltersAnchor