Create a new schedule

Creates a new schedule with the specified configuration. For site/asset targets, sub-schedules are created asynchronously. Poll the schedule state to check creation progress.

Creates a recurring schedule that automatically generates work items for
assigned users, sites, or assets. A schedule can be created with or without a target:

  • No target: Occurrences are created directly for the assigned users.
  • Sites (target.sites): A separate occurrence is created for each site at each recurrence.
  • Assets (target.assets): A separate occurrence is created for each asset at each recurrence.

When targeting sites or assets, use recurrence.use_site_timezone to fire
each occurrence at the same local clock time across sites in different time
zones, rather than at a single fixed UTC time.

Use completion_rule to control whether any one assignee or all assignees must complete the work for an occurrence to be marked complete. Defaults to COMPLETION_RULE_ANY when not specified.

πŸ“˜

When sites or assets are specified, sub-schedules are created asynchronously after the request returns. The id in the response represents the parent schedule. Polling support and schedule state values will be documented when available.

πŸ“•

This endpoint supersedes Create schedule items. See Schedules (legacy) for field mapping guidance.

Requirements

Body Params

CreateNewSchedule creates a schedule that generates recurring work items (e.g., inspections).

Schedules can target:

  • Specific users (no target, just assignment.users)
  • Sites (target.sites) - creates sub-schedules per site
  • Assets (target.assets) - creates sub-schedules per asset

For site/asset targets, sub-schedules are created asynchronously.

CreateNewSchedule creates a schedule that generates recurring work items (e.g., inspections).

Schedules can target:

  • Specific users (no target, just assignment.users)
  • Sites (target.sites) - creates sub-schedules per site
  • Assets (target.assets) - creates sub-schedules per asset

For site/asset targets, sub-schedules are created asynchronously.

string
required

Title of the schedule.

work_type

The type of work to be done as part of the schedule. Exactly one must be set.

recurrence
object
required

ScheduleRecurrence defines when and how often the schedule repeats.

RFC 5545 recurrence definition combining DTSTART and RRULE properties.
DTSTART specifies the start time and timezone. RRULE defines the recurrence pattern.
Timezone defaults to UTC if unspecified, or if use_site_timezone is true.

Expected format: "DTSTART;TZID=America/New_York:20240101T140000\nRRULE:FREQ=DAILY;INTERVAL=1"

string
enum
Defaults to COMPLETION_RULE_UNSPECIFIED

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.
Allowed:
target

Specifies which sites or assets this schedule applies to. Exactly one must be set.

assignment
required

Specifies which users are assigned to complete the scheduled work. Exactly one rule must be set.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json