Sign in

v1

latestOpenAPI 3.1.02026-07-22106199311.5 KB
Schedules

Get a schedule summary for a given schedule id

An endpoint to get schedule details for a given schedule id

get/v1/projects/{projectId}/schedules/{scheduleId}

Path parameters

projectIdstring uuid required
scheduleIdstring uuid required

Response

Schedule details returned successfully with no errors

cronExpressionstring

Either an intervalExpression or cronExpression must be present for a schedule. This this is formatted in the Quartz format.

cronTimezonestring

The timezone region value used to determine in what timezone the CronExpression is applied.

It will be used to in combination with the cronExpression to determine the schedule run times in the specified timezone region.

effectiveFromstring date-time
A date time value specifying at what point the schedule becomes effective, before this time
the schedule will not run.

The format of the date time will be yyyy-MM-dd'T'HH:mm:ssZ and is always returned in UTC
environmentNamestring

The environment name to run the pipeline that the schedule is associated with

gridVariablesobject

The map of grid variables to be overridden when ETL pipeline is executed

lastRunAtstring date-time

A datetime value for when the schedule last ran.

The format of the date time will be yyyy-MM-dd'T'HH:mm:ssZ and is always returned in UTC

namestring

An optional name for the schedule, if not provided then it will constructed from pipelinename_environment_currentTimestamp

nextRunAtstring date-time

A datetime value for when the schedule should next run.

The format of the date time will be yyyy-MM-dd'T'HH:mm:ssZ and is always returned in UTC

pipelineNamestring

Name of the pipeline that the schedule is associated with

scalarVariablesobject

The map of scalar variables to be overridden when ETL pipeline is executed

scheduleEnabledboolean

An enabled boolean flag for whether the schedule is enabled.

scheduleIdstring

The generated unique schedule Id used to identify a specific schedule

versionNamestring

Optional artifact version name of the pipeline that the schedule is associated with

Example response

{
  "cronExpression": "0 * * ? * * *",
  "cronTimezone": "Europe/Dublin",
  "effectiveFrom": "2022-05-19T12:37:44.000Z",
  "environmentName": "Dev Environment",
  "gridVariables": {
    "grid1": [
      [
        "col1",
        "col2",
        "col3"
      ],
      [
        "col1a",
        "col2a",
        "col3a"
      ]
    ]
  },
  "lastRunAt": "2022-06-30T01:14:00.000Z",
  "name": "Nightly database backup",
  "nextRunAt": "2022-06-30T01:15:00.000Z",
  "pipelineName": "Nightly database backup",
  "scalarVariables": {
    "variable1": "value1",
    "variable2": "value2"
  },
  "scheduleId": "a2239897-51f8-4c09-83ab-0b2c28bd5a37",
  "versionName": "1.2.0"
}