Skip to navigation
ReferenceTrigger Service

Get a schedule

Returns the details of a schedule.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

scheduleIdstringRequired

The schedule’s unique identifier (triggers._id), a UUIDv7.

Response

result
scheduleIdstring
Identifier of the schedule.
serviceIdstring
Identifier of the service the schedule requests.
serviceNamestring
Name of that service.
triggerSetEnabledboolean
Master switch that determines whether the trigger and any services associated with it can fire. When false, they cannot fire, regardless of this schedule's own status.
createdByobject

The user who created the schedule. principalId is Pronghorn when no creator is recorded.

createdAtstring
When the schedule was created, ISO 8601 in UTC.
lastUpdatedAtstring

When the schedule was last changed by a user (an edit, a pause or a resume), ISO 8601 in UTC.

statusenum

active fires as scheduled; paused was stopped by a user; completed fired its last occurrence; expired ended without firing its last occurrence.

Allowed values:
scheduleTypeenum

recurring repeats on its schedule; concrete fires once, at concreteDate.

Allowed values:
inputobject
Inputs the service is requested with each time the schedule fires.
missedRunPolicyenum

What happens to an occurrence found overdue, such as after downtime: skip drops it and waits for the next one; fireOnce fires it, however late.

Allowed values:
legacyWrapperboolean

Legacy field, kept only to support workflows written for the old input shape: before July 2023, Operations Manager passed form values to the workflow inside one variable named formData. False unless it was turned on.

scheduleobjectOptional

How a recurring schedule repeats, and its start and end. Absent for a concrete schedule.

concreteDatestringOptional

The instant a concrete schedule fires, ISO 8601 in UTC. Set only when scheduleType is concrete. A request sets it as schedule.concreteDate.

formIdstringOptional
Id of the form the inputs were filled in on. Absent when the schedule has no form.
lastRunstringOptional
When the schedule last fired, ISO 8601 in UTC. Absent if it has never fired.
nextRunstringOptional

When the schedule is next due, ISO 8601 in UTC. Present only while the status is active.

Errors

500
Internal Server Error