JobRecurrences

Get a job recurrence

Retrieve the details of a single recurrence series (required scope jobs:read)

get/v1/jobRecurrences/{recurrenceId}

Path parameters

recurrenceIdinteger required

The unique identifier of the recurrence series

Headers

Customer-Idinteger required

The customer identifier

Response

idinteger

The unique identifier of the recurrence series

patternNamestring

The name of the recurrence pattern

cronExpressionstring nullable

The cron expression describing the recurrence schedule (reserved for future POST/PUT support)

startDateAtstring date-time

The UTC date and time the recurrence series starts

endDateAtstring date-time nullable

The UTC date and time the recurrence series ends

createdAtstring date-time

The UTC timestamp of when this recurrence series was created

Example response

{
  "id": 789012,
  "patternName": "Weekly Unit Test Service",
  "cronExpression": "0 0 9 * * MON",
  "startDateAt": "2022-11-29T09:00:00.0000000+00:00",
  "endDateAt": "2023-11-29T09:00:00.0000000+00:00",
  "createdAt": "2022-11-29T16:50:16.0000000+00:00"
}