Warning

title	Page in development

This page is in development and as such, its contents may be incorrect

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

Table of Contents

Section

List schedules

Lists all the schedules configured in the Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/schedule

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

Response

Code Block

language	js

{
  "schedule": [{
    "id": "AAABcID5GBc=",
    "type": "time",
    "description": "Weekly seeds"
    "running": false,
    "enabled": true,
    "time": {
      "scheduleType": "weekly",
      "schedule": "* * * * 1",
      "last": 123456789,
      "next": 123456789,
    },
    "seed": ["AAABcIueWUd=", "AAABcIueWUe="]
  },
  {
    "id": "AAABcIueWUc=",
    "type": "sequential",
    "description": "Rollup"
    "running": false,
    "enabled": false,
    "sequence": {
      "after": "AAABcID5GBc=",
      "last": 123456789,
    },
    "seed": ["AAABcIueWUd=", "AAABcIueWUe="]
  },
    ...
  }],
  "message": "optional response message"
}

Status

Response code	Description
200	Success

Section

Get a single schedule

Get information about a single schedule configured in Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/schedule?id=:id

GET /aspire_api/schedule/:id

Query String and Path Parameters

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

Response

Code Block

language	js

{
  "schedule": {
    "id": "AAABcID5GBc=",
    "type": "time",
    "description": "Weekly seeds"
    "running": false,
    "enabled": true,
    "time": {
      "scheduleType": "weekly",
      "schedule": "* * * * 1",
      "last": 123456789,
      "next": 123456789,
    },
    "seed": ["AAABcIueWUd=", "AAABcIueWUe="]
  },
  "message": "optional response message"
}

Status

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

Section

Add schedule(s)

Add one or more schedules to Aspire

Panel

borderColor	black
bgColor	#fafafb

POST /aspire_api/schedule

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

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

Name	Description
enabled	Whether this schedule is enabled or not
scheduleType	The type of the time based schedule hourly daily weekly monthly custom
schedule	the cron like schedule for a time based schedule
after	the id of the schedule after which this schedule should run (for a sequence based schedule)
seed	the seed(s) this schedule applies to

Examples

Add a single schedule

Code Block

language	js

{
  "type": "time",
  "description": "Weekly seeds"
  "enabled": true,
  "scheduleType": "weekly",
  "schedule": "* * * * 1",
  "seed": ["AAABcIueWUd=", "AAABcIueWUe="]
}

Add multiple schedules

Code Block

language	js

[{
  "type": "time",
  "description": "Weekly seeds"
  "enabled": true,
  "scheduleType": "weekly",
  "schedule": "* * * * 1",
  "seed": ["AAABcIueWUd=", "AAABcIueWUe="]
},
{
  "type": "sequence",
  "description": "Rollup"
  "enabled": false,
  "after": "* * * * 1",
  "seed": ["AAABcIudWUd=", "AAABcIudWUe="]
}]

Response

Code Block

language	js

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

  "message": "optional response message"
}

Status

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

Section

Update schedule(s)

Update one or more schedules in Aspire. Updates will be treated as partial updates rather than overwrites. If a field is not present in the input, any previous value will remain after the update. If you wish to "delete" a value, pass a value of null

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire_api/schedule

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 Schedule API above

Examples

Update a single schedule

Code Block

language	js

{
  "id": "AAABcIueWU0",
  "type": "time",
  "description": "Weekly seeds"
  "enabled": true,
  "scheduleType": "weekly",
  "schedule": "* * * * 1",
  "seed": ["AAABcIueWUd=", "AAABcIueWUe="]
}

Update multiple schedules

Code Block

language	js

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

Response

Code Block

language	js

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

  "message": "optional response message"
}

Status

Response code	Description
201	Created
404	Not found - a given schedule identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Delete schedule(s)

Delete one or more schedules from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire_api/schedule?id=:id

DELETE /aspire_api/schedule/:id

DELETE /aspire_api/schedule

Query String, Path and Request Body Parameters

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

Examples

Delete a single schedule

Code Block

language	js

{
  "id": "AAABcID5GBc="
}

Delete multiple schedules

Code Block

language	js

[{
  "id": "AAABcID5GBc="
},
{
  "id": "AAABcIueWUc="
}]

Delete multiple schedules (alternative form)

Code Block

language	js

{
  "id": ["AAABcID5GBc=", "AAABcIueWUc="]
}

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

Page tree

Versions Compared

Old Version 2

New Version 3

Key

List schedules

Get a single schedule

Add schedule(s)

Update schedule(s)

Delete schedule(s)

Page tree

Page History

Versions Compared

Old Version 2

New Version 3

Key

List schedules

Get a single schedule

Add schedule(s)

Update schedule(s)

Delete schedule(s)