UnifiedViews Method - Create a Pipeline Schedule

Abstract

Description
Creates a schedule for a pipeline.

URL: http://{host:port}/master/api/1/pipelines/{pipeline_id}/schedules/

Content Type

application/json

Request

Supported Method
POST

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 queue. AFTER_PIPELINE: at certain intervals schedule will be executed, after other pipelines have finished running, and the pipeline be put into the queue.
firstExecution	string	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

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

ResponseContent-Type

application/json

Status: 200 - OK

Response Attributes

Attribute	Type	Required	Description
id	number	true	ID of the requested pipeline.
description	string	false	A description of the pipeline schedule details.
enabled	string	true	Shows if scheduler is enabled or not. Possible return values: `true/false`
scheduleType	string	false	According to the available schedule types, displays the respective one defined for the current schedule.
firstExecution	string	true	Returns the date and time set for the respective pipeline execution schedule's first run.
lastExecution	string	false	Returns the date and time set for the last time the respective pipeline schedule was triggered. If not set, return value will be: 'null'
nextExecution	string	false	Returns the date and time set for the respective pipeline execution schedule's next run. If not set, return value will be: 'null'
afterPipelines	string	false	Returns the IDs or names of pipelines that are scheduled to finish running before the execution of the current one.
justOnce	string	false	Returns if the current pipeline schedule should be executed just once. Possible values: true/false
period	number	false	Duration of the execution. 'null' for none.
periodUnit	string	false	Possible values: MINUTE \| HOUR \| DAY \| WEEK \| MONTH \| YEAR or null

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: