Skip to main content
ZStack
Alerting & Response/On-Call

ValidateOnCallSchedule

Validate a schedule configuration and return a conflict report

POST/api/v1/oncall/schedules/validate

Operation ID

ValidateOnCallSchedule

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • name
    StringRequired

    Name of the schedule configuration to validate

    Example: Platform On-Call

  • description
    StringRequired

    Description of the schedule configuration to validate

    Example: 24x7 platform on-call rotation

  • timezone
    StringRequired

    IANA timezone name to validate

    Example: Asia/Shanghai

  • rotationType
    StringRequired

    Rotation type to validate

    Example: weekly

  • shiftDuration
    StringRequired

    Shift duration to validate

    Example: 168h

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • hasConflict
    Boolean

    Whether any conflicts were detected in the schedule

    Example: true

  • conflicts
    List

    List of detected conflicts

    Example: (nested array)

    • type
      String

      Category of the detected conflict

      Example: overlap

    • userId
      String

      User ID involved in the conflict

      Example: user-abc123

    • userName
      String

      Display name of the user involved in the conflict

      Example: Alice Smith

    • details
      String

      Additional context about the conflict

      Example: Overlapping shifts on 2024-06-01

  • suggestions
    List

    List of resolution suggestions for the detected conflicts

    Example: (nested array)

    • type
      String

      Category of the suggested resolution action

      Example: swap_shift

    • description
      String

      Human-readable explanation of the suggestion

      Example: Swap shift between user-abc123 and user-xyz789