Skip to main content
API Explorer|API Explorer
Alerting & Response/On-Call
POSTOnCallSince 1.0SynchronousAuth Required

ValidateOnCallSchedule

Validate a schedule configuration and return a conflict report

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • nameStringRequired

    Name of the schedule configuration to validate

    Example: Platform On-Call

  • descriptionStringRequired

    Description of the schedule configuration to validate

    Example: 24x7 platform on-call rotation

  • timezoneStringRequired

    IANA timezone name to validate

    Example: Asia/Shanghai

  • rotationTypeStringRequired

    Rotation type to validate

    Example: weekly

  • shiftDurationStringRequired

    Shift duration to validate

    Example: 168h

Responses

200 OK

On success, this API returns the following response structure.

  • hasConflictBoolean

    Whether any conflicts were detected in the schedule

    Example: true

  • conflictsList

    List of detected conflicts

    Example: (nested array)

    • typeString

      Category of the detected conflict

      Example: overlap

    • userIdString

      User ID involved in the conflict

      Example: user-abc123

    • userNameString

      Display name of the user involved in the conflict

      Example: Alice Smith

    • detailsString

      Additional context about the conflict

      Example: Overlapping shifts on 2024-06-01

  • suggestionsList

    List of resolution suggestions for the detected conflicts

    Example: (nested array)

    • typeString

      Category of the suggested resolution action

      Example: swap_shift

    • descriptionString

      Human-readable explanation of the suggestion

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

Endpoint

POST/api/v1/oncall/schedules/validate

/api/v1/oncall/schedules/validate

Operation ID

ValidateOnCallSchedule

Permalink

Request Example

curl -X POST '{host}/api/v1/oncall/schedules/validate' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"name":"Platform On-Call","description":"24x7 platform on-call rotation","timezone":"Asia/Shanghai","rotationType":"weekly","shiftDuration":"168h","members":"(nested array)","startDate":"2026-01-15T08:00:00Z"}'

Response Example

200
{
  "hasConflict": true,
  "conflicts": [
    {}
  ],
  "suggestions": [
    {}
  ]
}

Change History

This API has no change history records yet.

View all change history