UnifiedViews Method - Request Pipeline Schedule - Next Scheduled Execution

Description

For the given pipeline, request the next scheduled executions.

URL: http://{server}/master/api/1/pipelines/{pipeline_id}/schedules/~all/scheduledexecutions

Content Type

application/json

Request

Supported Method

GET

Response

Content-Type

application/json

Status: 200 - OK

Response Attributes

Attribute

Type

Required

Description

start

number

true

Date and time of the scheduled start.

Format: <yyyy-mm-dd>T<hh:mm:ss.ms>Z

If not scheduled, return will be 'null'.

schedule

number

false

Position of the schedule in the queue.

afterPipelines

string

false

An array of pipeline objects.

Additional attributes can be ID and name of a pipeline.

Example Response

For schedule with starting time:

[{
        "start": "2014-08-08T15:15:15.555Z",
    "schedule": 12,
        "afterPipelines": null
}]

Response for pipeline that is scheduled after another pipeline:

[{
        "start": null,
    "schedule": 12,
        "afterPipelines": [
        {"1": "pipeline name for pipe with id 1"},
        {"2": "pipeline name for pipe with id 2"}
        ]
}]