UnifiedViews Method - Edit a Pipeline Schedule

Abstract

Description
Change values for an existing pipeline execution schedule.

URL: http://{server}/master/api/1/pipelines/{pipeline_id}/schedules/{schedule_id}

Content Type

application/json

Request

Supported Method
PUT

HTTP Parameters

Parameter	Type	Required	Description
id	number	true	ID of the pipeline.
description	string	false	A description of the pipeline schedule details.
enabled	string	true	Enable the schedule. Possible return values: `true/false`
scheduleType	string	false	Define the schedule type for the current schedule. Format: <yyyy-mm-dd>T<hh:mm:ss:ms>Z Available types: PERIODICALLY: at certain intervals schedule will be executed and the pipeline be put into the cue. AFTER_PIPELINE: at certain intervals schedule will be executed, after other pipelines have finished running, and the pipeline be put into the cue.
firstExecution	date/time	true	Set the date and time set for the respective schedule's first run.
afterPipelines	number	false	Sets the IDs or names of pipelines that are scheduled to finish running before the execution of the current one.
period	number	false	Duration of the execution. 'null' for none.
periodUnit	string	false	Allowed values: MINUTE \| HOUR \| DAY \| WEEK \| MONTH \| YEAR or 'null'

Example Request

{
    id: 4,
    description: "Runs after other pipelines",
    justOnce: false,
    enabled: false,
        firstExecution: "2014-08-08T15:15:15.555Z",
    lastExecution: null,
    afterPipelines: [15, 54],
    period: null,
    periodUnit: null,
}

ResponseContent-Type

application/json

Status: 200 - OK

Example Response

Returns the entity in its new version:

{
    id: 4,
    description: "Runs after other pipelines",
    justOnce: false,
    enabled: false,
        firstExecution: "2014-08-08T15:15:15.555Z",
    lastExecution: null,
    nextExecution: null,
    afterPipelines: [15, 54],
    period: null,
    periodUnit: null,
}

In this section: