Sign in
Recurrence

Gets the recurrence information for the specified recurrence ID.

get/recurrences/{recurrenceIdentity}

Path parameters

recurrenceIdentitystring uuid required

Recurrence ID.

Query parameters

startDateTimestring date-time

The start date for when to get the recurrence 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 recurrence 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.

recurrenceIdstring uuid

The recurrence identifier (a GUID), unique per activity/script, regardless of iterations. This is something to link different occurrences of the same job together.

recurrenceNamestring

The recurrence name, user friendly name for the correlation between jobs.

numJobsFailedinteger

The number of jobs in this recurrence that have failed.

numJobsCanceledinteger

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

numJobsSucceededinteger

The number of jobs in this recurrence 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 recurrence was submitted.

Changes

No recorded changes to this endpoint across all 10 revisions of this API.