You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Page in development

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

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

List schedules

Lists all the schedules configured in the Aspire

GET /aspire_api/schedules

Query String Parameters

NameTypeRequiredDescription
typestringOptionalFilter returned schedules to only those with the given type
descriptionstringOptionalFilter returned schedules to only those whose description matches the given expression

Response

{
  "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 codeDescription
200Success



Get a single schedule

Get information about a single schedule configured in Aspire

GET /aspire_api/schedules/:id

Path Parameters

NameTypeRequiredDescription
idstringRequiredThe id of the schedule to return

Response

{
  "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 codeDescription
200Success
404The given schedules id was not found



Add schedules

Add one or more schedules to Aspire

POST /aspire_api/schedules

Request Body Parameters

NameTypeRequiredDescription
typestringRequired

The type of schedule to add

  • time
  • sequence
descriptionstringOptionalAn 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

NameDescription
enabledWhether this schedule is enabled or not
scheduleType

The type of the time based schedule

  • hourly
  • daily
  • weekly
  • monthly
  • custom
schedulethe cron like schedule for a time based schedule
afterthe id of the schedule after which this schedule should run (for a sequence based schedule)
seedthe 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="]
}

Add multiple schedules

POST /aspire_api/schedules
[{
  "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

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



Update schedules

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

PUT /aspire_api/schedules/:id

PUT /aspire_api/schedules

Path and Request Body Parameters

NameTypeRequiredDescription
idstringRequiredThe identifier of the schedule to update
typestringRequiredThe type of schedule
descriptionstringOptionalAn 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="]
}

Update multiple schedules

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

Response

{
  "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 codeDescription
201Created
404Not found - a given schedule identifier was not found
406Not 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 Request Body Parameters

NameTypeRequiredDescription
idstringRequiredThe 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 codeDescription
200Success
404Not found - a given schedule identifier was not found
406Not acceptable - there was an issue validating the input
  • No labels

Copyright © 2024 Accenture

Contact Us: [email protected]