Sign in

v1

latestOpenAPI 3.1.02026-07-263911,4691.1 MB
Schedules

Get a schedule

Returns the full configuration of a schedule by its ID. For site and asset schedules, target counts are returned as totals only.

get/scheduling/v1/schedules/{schedule_id}

Path parameters

schedule_idstring required

The schedule ID.

Response

A successful response.

idstring

The schedule ID.

titlestring

The schedule title.

status'STATUS_UNSPECIFIED' | 'STATUS_FINISHED' | 'STATUS_ACTIVE' | 'STATUS_PAUSED' | 'STATUS_DELETED' | 'STATUS_PENDING' | 'STATUS_FAILED' | 'STATUS_ENDED'

Status enum.

  • STATUS_UNSPECIFIED: Unspecified status. Default value; do not use explicitly.
  • STATUS_FINISHED: Schedule has completed all occurrences defined by its recurrence rule.
  • STATUS_ACTIVE: Schedule is active and generating occurrences as expected.
  • STATUS_PAUSED: Schedule is temporarily suspended. No new occurrences will be generated until resumed.
  • STATUS_DELETED: Schedule has been deleted and is no longer active or available.
  • STATUS_PENDING: Schedule has been created but has not yet started generating occurrences.
  • STATUS_FAILED: Schedule encountered an error and could not continue generating occurrences.
  • STATUS_ENDED: Schedule has reached its end date and will no longer generate occurrences.
completion_rule'COMPLETION_RULE_UNSPECIFIED' | 'COMPLETION_RULE_ANY' | 'COMPLETION_RULE_ALL'

Completion rule enum.

  • COMPLETION_RULE_UNSPECIFIED: Unspecified completion rule.
  • COMPLETION_RULE_ANY: Any assignee can complete the schedule.
  • COMPLETION_RULE_ALL: All assignees must complete the schedule.
created_atstring date-time

When this schedule was created.

last_modified_atstring date-time

When this schedule was last modified.