curl --request PATCH \
  --url https://eu1.api.matillion.com/dpc/v2/projects/{projectId}/schedules/{scheduleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pipeline": {
    "scalarVariables": {
      "variable1": "value1"
    },
    "gridVariables": {
      "variable2": [
        [
          "row1col1",
          "row1col2"
        ],
        [
          "row2col1",
          "row2col2"
        ]
      ]
    }
  }
}
'

{
  "allowConcurrentExecutions": false,
  "cronExpression": "0 * * ? * * *",
  "cronTimezone": "Europe/Dublin",
  "effectiveFrom": "2022-05-19T12:37:44.000Z",
  "environmentName": "Dev Environment",
  "gridVariables": {
    "grid1": [
      [
        "col1",
        "col2",
        "col3"
      ],
      [
        "col1a",
        "col2a",
        "col3a"
      ]
    ]
  },
  "intervalExpression": {
    "interval": 123,
    "unit": "<string>"
  },
  "lastRunAt": "2022-06-30T01:14:00.000Z",
  "name": "Nightly database backup",
  "nextRunAt": "2022-06-30T01:15:00.000Z",
  "pipelineName": "Nightly database backup",
  "runnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "scalarVariables": {
    "variable1": "value1",
    "variable2": "value2"
  },
  "scheduleEnabled": false,
  "scheduleId": "a2239897-51f8-4c09-83ab-0b2c28bd5a37",
  "versionName": "1.2.0"
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

Schedules

Update the schedule by the given schedule id and schedule request

An endpoint for updating the schedule for the given schedule id and schedule request. Partial updates are accepted - any field that is omitted is left unchanged. In the pipeline block each field’s explicit null acts independently: a null versionName resets the schedule to the latest published version, a null runnerId resets it to the environment’s default runner, and a null scalarVariables or gridVariables clears that set of overrides.

PATCH

projects

{projectId}

schedules

{scheduleId}

curl --request PATCH \
  --url https://eu1.api.matillion.com/dpc/v2/projects/{projectId}/schedules/{scheduleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pipeline": {
    "scalarVariables": {
      "variable1": "value1"
    },
    "gridVariables": {
      "variable2": [
        [
          "row1col1",
          "row1col2"
        ],
        [
          "row2col1",
          "row2col2"
        ]
      ]
    }
  }
}
'

{
  "allowConcurrentExecutions": false,
  "cronExpression": "0 * * ? * * *",
  "cronTimezone": "Europe/Dublin",
  "effectiveFrom": "2022-05-19T12:37:44.000Z",
  "environmentName": "Dev Environment",
  "gridVariables": {
    "grid1": [
      [
        "col1",
        "col2",
        "col3"
      ],
      [
        "col1a",
        "col2a",
        "col3a"
      ]
    ]
  },
  "intervalExpression": {
    "interval": 123,
    "unit": "<string>"
  },
  "lastRunAt": "2022-06-30T01:14:00.000Z",
  "name": "Nightly database backup",
  "nextRunAt": "2022-06-30T01:15:00.000Z",
  "pipelineName": "Nightly database backup",
  "runnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "scalarVariables": {
    "variable1": "value1",
    "variable2": "value2"
  },
  "scheduleEnabled": false,
  "scheduleId": "a2239897-51f8-4c09-83ab-0b2c28bd5a37",
  "versionName": "1.2.0"
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

a valid bearer token

Path Parameters

projectId

string<uuid>

required

scheduleId

string<uuid>

required

Body

application/json

Partial schedule update. Omitted fields are left unchanged. The artifact version, variable overrides and runner are updated via the pipeline block, where each field's explicit null acts independently: a null versionName resets the schedule to the latest artifact version, a null runnerId resets it to the environment's default runner, and a null scalarVariables or gridVariables clears that set of overrides.

pipeline

object

Execution details to update on the schedule.

Show child attributes

schedule

object

Schedule-timing details to update.

Show child attributes

Response

Schedule updated successfully

allowConcurrentExecutions

boolean

A boolean flag for whether the scheduled pipeline is allowed to execute concurrently. If false, the pipeline will not be executed if it is already running. Defaults to true when not explicitly set.

Example:

false

cronExpression

string

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

Example:

"0 * * ? * * *"

cronTimezone

string

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.

Example:

"Europe/Dublin"

effectiveFrom

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

Example:

"2022-05-19T12:37:44.000Z"

environmentName

string

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

Example:

"Dev Environment"

gridVariables

object

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

Show child attributes

Example:

{
  "grid1": [
    ["col1", "col2", "col3"],
    ["col1a", "col2a", "col3a"]
  ]
}

intervalExpression

object

Either an intervalExpression or cronExpression must be present for a schedule. This intervalExpression details the interval between each scheduled run.

Show child attributes

lastRunAt

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

Example:

"2022-06-30T01:14:00.000Z"

name

string

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

Example:

"Nightly database backup"

nextRunAt

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

Example:

"2022-06-30T01:15:00.000Z"

pipelineName

string

Name of the pipeline that the schedule is associated with

Example:

"Nightly database backup"

runnerId

string

The UUID of the runner the schedule is assigned to run on. This is the same identifier as the create endpoint's agentId.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

scalarVariables

object

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

Show child attributes

Example:

{
  "variable1": "value1",
  "variable2": "value2"
}

scheduleEnabled

boolean

An enabled boolean flag for whether the schedule is enabled.

Example:

false

scheduleId

string

The generated unique schedule Id used to identify a specific schedule

Example:

"a2239897-51f8-4c09-83ab-0b2c28bd5a37"

versionName

string

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

Example:

"1.2.0"