Skip to main content
API Explorer|API Explorer
Infrastructure/Change Management
GETChangeManagementSince 1.0SynchronousAuth Required

GetCalendarConflicts

Detect scheduling conflicts between change requests in a time range

Execution Availability

Try It Out

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

Query Parameters

Request Inputs

Query Parameters

  • startString

    Start

  • endString

    The end value

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

GET/api/v1/change-management/calendar/conflicts

/api/v1/change-management/calendar/conflicts

Operation ID

GetCalendarConflicts

Permalink

Request Example

curl -X GET '{host}/api/v1/change-management/calendar/conflicts' -H 'Authorization: Bearer {token}'

Response Example

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

Change History

This API has no change history records yet.

View all change history