Skip to main content

    UnifiedViews Method - Request One Pipeline Schedule Event

    Abstract

    UnifiedViews Method - Request One Pipeline Schedule Event

    Description

    Request one scheduled event (with the given ID) for the given pipeline ID.

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

    Content Type

    application/json

    Request

    Supported Method

    GET

    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

    date/time

    true

    Returns the date and time set for the respective pipeline execution schedule's first run.

    lastExecution

    date/time

    false

    Returns the date and time set for the respective pipeline execution schedule's last run.

    If not set, return value will be: 'null'

    nextExecution

    date/time

    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

    string

    false

    Duration of the execution. 'null' for none.

    periodUnit

    string

    false

    Allowed values:

    MINUTE | HOUR | DAY | WEEK | MONTH | YEAR or null

    Example Response
    {
    id: 6,
    description: "Runs it just once, had not run till now",
    enabled: false,
    scheduleType: "PERIODICALLY",
    firstExecution: "2014-08-08T15:15:15.555Z",
    lastExecution: null,
    nextExecution: null,
    afterPipelines: null,
    justOnce: true,
    period: null,
    periodUnit: null,
}