Sign in

v10

latestSwagger 2.0raw.githubusercontent.com2019-06-25133266.6 KB
Pipeline

Gets the Pipeline information for the specified pipeline ID.

get/pipelines/{pipelineIdentity}

Path parameters

pipelineIdentitystring uuid required

Pipeline ID.

Query parameters

startDateTimestring date-time

The start date for when to get the pipeline and aggregate its data. The startDateTime and endDateTime can be no more than 30 days apart.

endDateTimestring date-time

The end date for when to get the pipeline and aggregate its data. The startDateTime and endDateTime can be no more than 30 days apart.

api-versionstring required

Client Api Version.

Response

Successfully retrieved details of the specified pipeline.

pipelineIdstring uuid

The job relationship pipeline identifier (a GUID).

pipelineNamestring

The friendly name of the job relationship pipeline, which does not need to be unique.

pipelineUristring

The pipeline uri, unique, links to the originating service for this pipeline.

numJobsFailedinteger

The number of jobs in this pipeline that have failed.

numJobsCanceledinteger

The number of jobs in this pipeline that have been canceled.

numJobsSucceededinteger

The number of jobs in this pipeline that have succeeded.

auHoursFailednumber double

The number of job execution hours that resulted in failed jobs.

auHoursCancelednumber double

The number of job execution hours that resulted in canceled jobs.

auHoursSucceedednumber double

The number of job execution hours that resulted in successful jobs.

lastSubmitTimestring date-time

The last time a job in this pipeline was submitted.

recurrencesstring[]

The list of recurrence identifiers representing each run of this pipeline.