Skip to navigation

Create a schedule

Creates a recurring schedule for a service.

Authentication

AuthorizationBasic

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

Path parameters

serviceIdstringRequired

The scheduled service’s unique identifier (services._id), a UUIDv7.

Request

body
scheduleobjectRequired

When the schedule fires: a recurrence, or a single one-time date.

inputsobjectRequired
Inputs the service is requested with each time the schedule fires.
missedRunPolicyenumOptional
What to do with an occurrence found overdue. Defaults to skip.
Allowed values:
legacyWrapperbooleanOptional

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. Defaults to false. Turning it on is refused unless the service’s asset is a workflow.

Response

result
scheduleIdstring

Errors

500
Internal Server Error