components: schemas: AddIncidentDebriefUserMessageAttributes: additionalProperties: false properties: messageContent: type: string required: - messageContent type: object AddIncidentDebriefUserMessageRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/AddIncidentDebriefUserMessageRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/AddIncidentDebriefUserMessageAttributes" required: - attributes type: object AddIncidentDebriefUserMessageResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/AddIncidentDebriefUserMessageResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IncidentDebriefMessage" required: - data type: object AddSystemAnalysisEdgeAttributes: additionalProperties: false properties: description: type: string snapshotRelationshipId: type: string required: - snapshotRelationshipId - description type: object AddSystemAnalysisEdgeRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/AddSystemAnalysisEdgeRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/AddSystemAnalysisEdgeAttributes" required: - attributes type: object AddSystemAnalysisEdgeResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/AddSystemAnalysisEdgeResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/SystemAnalysisEdge" required: - data type: object AddSystemAnalysisNodeAttributes: additionalProperties: false properties: description: type: string knowledgeEntityId: type: string position: $ref: "#/components/schemas/SystemAnalysisDiagramPosition" snapshotEntityId: type: string required: - position - description type: object AddSystemAnalysisNodeRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/AddSystemAnalysisNodeRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/AddSystemAnalysisNodeAttributes" required: - attributes type: object AddSystemAnalysisNodeResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/AddSystemAnalysisNodeResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/SystemAnalysisNode" required: - data type: object AddWatchedOncallRosterResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/AddWatchedOncallRosterResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/OncallRoster" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object AiAgentRun: additionalProperties: false properties: attributes: $ref: "#/components/schemas/AiAgentRunAttributes" id: type: string required: - id - attributes type: object AiAgentRunAttributes: additionalProperties: false properties: agentname: type: string createdAt: format: date-time type: string latestSnapshot: items: $ref: "#/components/schemas/AiAgentRunSnapshot" type: array ownerUserId: type: string permissionScopes: items: type: string type: array startedAt: format: date-time type: string required: - agentname - ownerUserId - permissionScopes - createdAt - latestSnapshot type: object AiAgentRunSnapshot: additionalProperties: false properties: attributes: $ref: "#/components/schemas/AiAgentRunSnapshotAttributes" id: type: string required: - id - attributes type: object AiAgentRunSnapshotAttributes: additionalProperties: false properties: created_at: format: date-time type: string error: type: string finish_reason: type: string heartbeat_at: format: date-time type: - string - "null" parent_id: type: string state: $ref: "#/components/schemas/AiAgentRunSnapshotState" status: type: string required: - status - finish_reason - parent_id - heartbeat_at - created_at type: object AiAgentRunSnapshotState: additionalProperties: false properties: artifacts: items: $ref: "#/components/schemas/AiAgentRunSnapshotStateArtifact" type: array custom: additionalProperties: {} type: object messages: items: $ref: "#/components/schemas/Message" type: array required: - artifacts - messages - custom type: object AiAgentRunSnapshotStateArtifact: additionalProperties: false properties: metadata: additionalProperties: {} type: object name: type: string parts: items: $ref: "#/components/schemas/Part" type: array required: - parts type: object Alert: additionalProperties: false properties: attributes: $ref: "#/components/schemas/AlertAttributes" id: type: string required: - id - attributes type: object AlertAttributes: additionalProperties: false properties: definition: type: string description: type: string roster: $ref: "#/components/schemas/ExpandableOncallRosterAttributes" title: type: string required: - title - description - definition type: object AlertIncidentLink: additionalProperties: false properties: attributes: $ref: "#/components/schemas/AlertIncidentLinkAttributes" id: type: string required: - id - attributes type: object AlertIncidentLinkAttributes: additionalProperties: false properties: alertId: type: string description: type: string incidentId: type: string required: - alertId - incidentId - description type: object AlertMetrics: additionalProperties: false properties: accurate: format: int64 type: integer accurateUnknown: format: int64 type: integer actionable: format: int64 type: integer docsAvailable: format: int64 type: integer docsNeedsUpdate: format: int64 type: integer feedbacks: format: int64 type: integer incidentLinks: format: int64 type: integer interrupts: format: int64 type: integer nightInterrupts: format: int64 type: integer triggers: format: int64 type: integer required: - triggers - interrupts - nightInterrupts - incidentLinks - feedbacks - actionable - accurate - accurateUnknown - docsAvailable - docsNeedsUpdate type: object CompleteIntegrationOAuthFlowRequestAttributes: additionalProperties: false properties: client_verifier: type: string code: type: string state: type: string required: - code type: object CompleteIntegrationOAuthFlowRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CompleteIntegrationOAuthFlowRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/CompleteIntegrationOAuthFlowRequestAttributes" required: - attributes type: object CompleteIntegrationOAuthFlowResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CompleteIntegrationOAuthFlowResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IntegrationOAuthInstallResult" required: - data type: object CreateEventAnnotationRequestAttributes: additionalProperties: false properties: eventId: type: string minutesOccupied: format: int64 type: integer notes: type: string tags: items: type: string type: array required: - eventId - notes - minutesOccupied - tags type: object CreateEventAnnotationRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateEventAnnotationRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/CreateEventAnnotationRequestAttributes" required: - attributes type: object CreateEventAnnotationResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateEventAnnotationResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/EventAnnotation" required: - data type: object CreateIncidentAttributes: additionalProperties: false properties: fieldSelectionIds: items: type: string type: array severityId: type: string summary: type: string tagIds: items: type: string type: array title: type: string typeId: type: string required: - title - severityId - typeId type: object CreateIncidentDebriefQuestionAttributes: additionalProperties: false properties: content: type: string required: - content type: object CreateIncidentDebriefQuestionRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateIncidentDebriefQuestionRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/CreateIncidentDebriefQuestionAttributes" required: - attributes type: object CreateIncidentDebriefQuestionResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateIncidentDebriefQuestionResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IncidentDebriefQuestion" required: - data type: object CreateIncidentFieldAttributes: additionalProperties: false properties: incidentType: type: string name: type: string options: items: $ref: "#/components/schemas/CreateIncidentFieldOptionAttributes" type: array required: type: boolean required: - name - required - options type: object CreateIncidentFieldOptionAttributes: additionalProperties: false properties: fieldOptionType: enum: - custom - derived type: string value: type: string required: - fieldOptionType - value type: object CreateIncidentFieldRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateIncidentFieldRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/CreateIncidentFieldAttributes" required: - attributes type: object CreateIncidentFieldResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateIncidentFieldResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IncidentField" required: - data type: object CreateIncidentMilestoneAttributes: additionalProperties: false properties: description: type: string kind: enum: - impact - detection - investigation - mitigation - resolution type: string timestamp: format: date-time type: string required: - kind - timestamp - description type: object CreateIncidentMilestoneRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateIncidentMilestoneRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/CreateIncidentMilestoneAttributes" required: - attributes type: object CreateIncidentMilestoneResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateIncidentMilestoneResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IncidentMilestone" required: - data type: object CreateIncidentRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateIncidentRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/CreateIncidentAttributes" required: - attributes type: object CreateIncidentResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateIncidentResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/Incident" required: - data type: object CreateIncidentRoleAttributes: additionalProperties: false properties: name: type: string required: type: boolean required: - name - required type: object CreateIncidentRoleRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateIncidentRoleRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/CreateIncidentRoleAttributes" required: - attributes type: object CreateIncidentRoleResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateIncidentRoleResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IncidentRole" required: - data type: object CreateIncidentSeverityAttributes: additionalProperties: false properties: rank: format: int64 type: integer title: type: string required: - title - rank type: object CreateIncidentSeverityRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateIncidentSeverityRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/CreateIncidentSeverityAttributes" required: - attributes type: object CreateIncidentSeverityResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateIncidentSeverityResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IncidentSeverity" required: - data type: object CreateIncidentTagAttributes: additionalProperties: false properties: value: type: string required: - value type: object CreateIncidentTagRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateIncidentTagRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/CreateIncidentTagAttributes" required: - attributes type: object CreateIncidentTagResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateIncidentTagResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IncidentTag" required: - data type: object CreateIncidentTimelineEventAttributes: additionalProperties: false properties: isKey: type: boolean kind: enum: - observation - action - decision - context type: string timestamp: format: date-time type: string title: type: string required: - title - kind - timestamp type: object CreateIncidentTimelineEventRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateIncidentTimelineEventRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/CreateIncidentTimelineEventAttributes" required: - attributes type: object CreateIncidentTimelineEventResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateIncidentTimelineEventResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IncidentTimelineEvent" required: - data type: object CreateIncidentTypeAttributes: additionalProperties: false properties: name: type: string required: - name type: object CreateIncidentTypeRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateIncidentTypeRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/CreateIncidentTypeAttributes" required: - attributes type: object CreateIncidentTypeResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateIncidentTypeResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IncidentType" required: - data type: object CreateMeetingScheduleAttributes: additionalProperties: false properties: attendees: $ref: "#/components/schemas/MeetingAttendees" description: type: string durationMinutes: format: int64 type: integer name: type: string numRepetitions: format: int64 type: integer repeatMonthlyOn: enum: - same_day - same_weekday type: string repeats: enum: - daily - weekly - monthly type: string repetitionStep: format: int64 type: integer sessionTitle: type: string startsAt: format: date-time type: string untilDate: format: date type: string required: - name - sessionTitle - startsAt - durationMinutes - attendees - repeats - repetitionStep type: object CreateMeetingScheduleRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateMeetingScheduleRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/CreateMeetingScheduleAttributes" required: - attributes type: object CreateMeetingScheduleResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateMeetingScheduleResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/MeetingSchedule" required: - data type: object CreateMeetingSessionAttributes: additionalProperties: false properties: attendees: $ref: "#/components/schemas/MeetingAttendees" description: type: string documentTemplateId: type: string durationMinutes: format: int64 type: integer startsAt: format: date-time type: string title: type: string required: - title - attendees - startsAt - durationMinutes type: object CreateMeetingSessionRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateMeetingSessionRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/CreateMeetingSessionAttributes" required: - attributes type: object CreateMeetingSessionResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateMeetingSessionResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/MeetingSession" required: - data type: object CreateOncallShiftHandoverTemplateRequestAttributes: additionalProperties: false properties: sections: items: $ref: "#/components/schemas/OncallShiftHandoverSection" type: array required: - sections type: object CreateOncallShiftHandoverTemplateRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateOncallShiftHandoverTemplateRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/CreateOncallShiftHandoverTemplateRequestAttributes" required: - attributes type: object CreateOncallShiftHandoverTemplateResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateOncallShiftHandoverTemplateResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/OncallShiftHandoverTemplate" required: - data type: object CreatePlaybookAttributes: additionalProperties: false properties: content: type: string title: type: string required: - title - content type: object CreatePlaybookRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreatePlaybookRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/CreatePlaybookAttributes" required: - attributes type: object CreatePlaybookResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreatePlaybookResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/Playbook" required: - data type: object CreateRetrospectiveCommentAttributes: additionalProperties: false properties: content: {} required: - content type: object CreateRetrospectiveCommentRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateRetrospectiveCommentRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/CreateRetrospectiveCommentAttributes" required: - attributes type: object CreateRetrospectiveCommentResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateRetrospectiveCommentResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/RetrospectiveComment" required: - data type: object CreateRetrospectiveReviewRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateRetrospectiveReviewRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/RetrospectiveReviewAttributes" required: - attributes type: object CreateRetrospectiveReviewResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateRetrospectiveReviewResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/RetrospectiveReview" required: - data type: object CreateSystemTopologySnapshotAttributes: additionalProperties: false properties: asOf: format: date-time type: string depth: format: int64 type: integer entityIds: items: type: string type: array entityKinds: items: type: string type: array includeAlerts: type: boolean includeChanges: type: boolean includeIncidents: type: boolean name: type: string relationshipKinds: items: type: string type: array rootEntityIds: items: type: string type: array scope: enum: - explicit_entities - root_entities - incident - retrospective - search - analysis type: string scopeProperties: additionalProperties: {} type: object required: - name - scope - scopeProperties - entityIds - rootEntityIds - depth - entityKinds - relationshipKinds - includeIncidents - includeChanges - includeAlerts type: object CreateSystemTopologySnapshotRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateSystemTopologySnapshotRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/CreateSystemTopologySnapshotAttributes" required: - attributes type: object CreateSystemTopologySnapshotResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateSystemTopologySnapshotResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/SystemTopologySnapshot" required: - data type: object CreateTaskAttributes: additionalProperties: false properties: title: type: string required: - title type: object CreateTaskRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateTaskRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/CreateTaskAttributes" required: - attributes type: object CreateTaskResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateTaskResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/Task" required: - data type: object CreateTeamAttributes: additionalProperties: false properties: name: type: string required: - name type: object CreateTeamMembershipAttributes: additionalProperties: false properties: role: enum: - admin - member type: string teamId: type: string userId: type: string required: - role - teamId - userId type: object CreateTeamMembershipRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateTeamMembershipRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/CreateTeamMembershipAttributes" required: - attributes type: object CreateTeamMembershipResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateTeamMembershipResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/TeamMembership" required: - data type: object CreateTeamRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateTeamRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/CreateTeamAttributes" required: - attributes type: object CreateTeamResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/CreateTeamResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/Team" required: - data type: object DocumentAccess: additionalProperties: false properties: canEdit: type: boolean canManage: type: boolean canView: type: boolean required: - canView - canEdit - canManage type: object DocumentSession: additionalProperties: false properties: access: $ref: "#/components/schemas/DocumentAccess" user: $ref: "#/components/schemas/User" required: - user - access type: object DocumentSessionAuth: additionalProperties: false properties: name: type: string serverUrl: type: string token: type: string required: - name - token - serverUrl type: object ErrorDetail: additionalProperties: false properties: location: description: Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object ErrorModel: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ErrorModel.json format: uri readOnly: true type: string detail: description: A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: "#/components/schemas/ErrorDetail" type: array instance: description: A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string type: object Event: additionalProperties: false properties: attributes: $ref: "#/components/schemas/EventAttributes" id: type: string required: - id - attributes type: object EventAnnotation: additionalProperties: false properties: attributes: $ref: "#/components/schemas/EventAnnotationAttributes" id: type: string required: - id - attributes type: object EventAnnotationAttributes: additionalProperties: false properties: creator: $ref: "#/components/schemas/ExpandableUserAttributes" event: $ref: "#/components/schemas/ExpandableEventAttributes" minutesOccupied: format: int64 type: integer notes: type: string tags: items: type: string type: array required: - event - creator - notes - tags - minutesOccupied type: object EventAttributes: additionalProperties: false properties: alert_id: type: string description: type: string kind: type: string roster_id: type: string timestamp: format: date-time type: string title: type: string required: - kind - title - description - timestamp type: object ExpandableEventAttributes: additionalProperties: false properties: attributes: $ref: "#/components/schemas/EventAttributes" id: type: string required: - id type: object ExpandableOncallRosterAttributes: additionalProperties: false properties: attributes: $ref: "#/components/schemas/OncallRosterAttributes" id: type: string required: - id type: object ExpandableRetrospectiveCommentAttributes: additionalProperties: false properties: attributes: $ref: "#/components/schemas/RetrospectiveCommentAttributes" id: type: string required: - id type: object ExpandableUser: additionalProperties: false properties: attributes: $ref: "#/components/schemas/User" id: type: string required: - id type: object ExpandableUserAttributes: additionalProperties: false properties: attributes: $ref: "#/components/schemas/UserAttributes" id: type: string required: - id type: object ExternalTicket: additionalProperties: false properties: provider: type: string required: - provider type: object GetAdjacentOncallShiftsResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetAdjacentOncallShiftsResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/OncallShiftsAdjacent" required: - data type: object GetAiAgentRunResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetAiAgentRunResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/AiAgentRun" required: - data type: object GetAlertMetricsResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetAlertMetricsResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/AlertMetrics" required: - data type: object GetAlertResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetAlertResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/Alert" required: - data type: object GetDocumentSessionResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetDocumentSessionResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/DocumentSession" required: - data type: object GetEventResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetEventResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/Event" required: - data type: object GetIncidentDebriefQuestionResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetIncidentDebriefQuestionResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IncidentDebriefQuestion" required: - data type: object GetIncidentDebriefResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetIncidentDebriefResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IncidentDebrief" required: - data type: object GetIncidentFieldResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetIncidentFieldResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IncidentField" required: - data type: object GetIncidentMetadataResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetIncidentMetadataResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IncidentMetadata" required: - data type: object GetIncidentResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetIncidentResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/Incident" required: - data type: object GetIncidentRoleResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetIncidentRoleResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IncidentRole" required: - data type: object GetIncidentSeverityResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetIncidentSeverityResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IncidentSeverity" required: - data type: object GetIncidentTagResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetIncidentTagResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IncidentTag" required: - data type: object GetIncidentTimelineEventMetadataResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetIncidentTimelineEventMetadataResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IncidentTimelineEventMetadata" required: - data type: object GetIncidentTypeResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetIncidentTypeResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IncidentType" required: - data type: object GetIncidentUserDebriefResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetIncidentUserDebriefResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IncidentDebrief" required: - data type: object GetInstallableIntegrationsResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetInstallableIntegrationsResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/InstallableIntegration" type: array required: - data type: object GetIntegrationInstallationResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetIntegrationInstallationResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IntegrationInstallation" required: - data type: object GetMeetingScheduleResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetMeetingScheduleResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/MeetingSchedule" required: - data type: object GetMeetingSessionResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetMeetingSessionResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/MeetingSession" required: - data type: object GetOncallRosterMetricsResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetOncallRosterMetricsResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/OncallRosterMetrics" required: - data type: object GetOncallRosterResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetOncallRosterResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/OncallRoster" required: - data type: object GetOncallShiftBurdenMetricWeightsResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetOncallShiftBurdenMetricWeightsResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/OncallShiftBurdenMetricWeights" required: - data type: object GetOncallShiftHandoverResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetOncallShiftHandoverResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/OncallShiftHandover" required: - data type: object GetOncallShiftHandoverTemplateResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetOncallShiftHandoverTemplateResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/OncallShiftHandoverTemplate" required: - data type: object GetOncallShiftMetricsResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetOncallShiftMetricsResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/OncallShiftMetrics" required: - data type: object GetOncallShiftResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetOncallShiftResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/OncallShift" required: - data type: object GetOrganizationResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetOrganizationResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/Organization" required: - data type: object GetPlaybookResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetPlaybookResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/Playbook" required: - data type: object GetRetrospectiveCommentResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetRetrospectiveCommentResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/RetrospectiveComment" required: - data type: object GetRetrospectiveResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetRetrospectiveResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/Retrospective" required: - data type: object GetSystemAnalysisEdgeResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetSystemAnalysisEdgeResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/SystemAnalysisEdge" required: - data type: object GetSystemAnalysisNodeResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetSystemAnalysisNodeResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/SystemAnalysisNode" required: - data type: object GetSystemAnalysisResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetSystemAnalysisResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/SystemAnalysis" required: - data type: object GetSystemTopologyEntityNeighborhoodResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetSystemTopologyEntityNeighborhoodResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/SystemTopologyGraph" required: - data type: object GetSystemTopologyEntityResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetSystemTopologyEntityResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/SystemTopologyEntity" required: - data type: object GetSystemTopologySnapshotResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetSystemTopologySnapshotResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/SystemTopologySnapshot" required: - data type: object GetTaskResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetTaskResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/Task" required: - data type: object GetTeamResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetTeamResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/Team" required: - data type: object GetUserOncallInformationResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetUserOncallInformationResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/UserOncallInformation" required: - data type: object GetUserResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetUserResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/User" required: - data type: object GetUserSessionResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/GetUserSessionResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/UserSession" required: - data type: object Incident: additionalProperties: false properties: attributes: $ref: "#/components/schemas/IncidentAttributes" id: type: string required: - id - attributes type: object IncidentAttributes: additionalProperties: false properties: chatChannel: $ref: "#/components/schemas/IncidentChatChannel" closedAt: format: date-time type: string currentStatus: enum: - started - mitigated - resolved - closed type: string fieldSelections: items: $ref: "#/components/schemas/IncidentFieldSelection" type: array linkedIncidents: items: $ref: "#/components/schemas/IncidentLink" type: array openedAt: format: date-time type: string primaryVideoConference: $ref: "#/components/schemas/VideoConference" retrospectiveId: type: string roles: items: $ref: "#/components/schemas/IncidentRoleAssignment" type: array severity: $ref: "#/components/schemas/IncidentSeverity" slug: type: string summary: type: string tags: items: $ref: "#/components/schemas/IncidentTag" type: array tasks: items: $ref: "#/components/schemas/Task" type: array teams: items: $ref: "#/components/schemas/IncidentTeamAssignment" type: array ticket: $ref: "#/components/schemas/ExternalTicket" title: type: string type: $ref: "#/components/schemas/IncidentType" required: - title - summary - slug - currentStatus - openedAt - closedAt - severity - type - tags - tasks - roles - teams - fieldSelections - linkedIncidents - chatChannel type: object IncidentChatChannel: additionalProperties: false properties: id: type: string private: type: boolean provider: enum: - slack - ms_teams type: string url: type: string required: - provider - id - url - private type: object IncidentDebrief: additionalProperties: false properties: attributes: $ref: "#/components/schemas/IncidentDebriefAttributes" id: type: string required: - id - attributes type: object IncidentDebriefAttributes: additionalProperties: false properties: incidentId: type: string required: type: boolean started: type: boolean userId: type: string required: - incidentId - userId - required - started type: object IncidentDebriefMessage: additionalProperties: false properties: attributes: $ref: "#/components/schemas/IncidentDebriefMessageAttributes" id: type: string required: - id - attributes type: object IncidentDebriefMessageAttributes: additionalProperties: false properties: body: type: string createdAt: format: date-time type: string type: enum: - user - assistant - question type: string required: - createdAt - type - body type: object IncidentDebriefQuestion: additionalProperties: false properties: attributes: $ref: "#/components/schemas/IncidentDebriefQuestionAttributes" id: type: string required: - id - attributes type: object IncidentDebriefQuestionAttributes: additionalProperties: false properties: content: type: string required: - content type: object IncidentDebriefSuggestion: additionalProperties: false properties: attributes: $ref: "#/components/schemas/IncidentDebriefSuggestionAttributes" id: type: string required: - id - attributes type: object IncidentDebriefSuggestionAttributes: additionalProperties: false properties: content: type: string ignored: type: boolean required: - ignored - content type: object IncidentField: additionalProperties: false properties: attributes: $ref: "#/components/schemas/IncidentFieldAttributes" id: type: string required: - id - attributes type: object IncidentFieldAttributes: additionalProperties: false properties: archived: type: boolean description: type: string incidentType: $ref: "#/components/schemas/IncidentType" name: type: string options: items: $ref: "#/components/schemas/IncidentFieldOption" type: array required: type: boolean required: - name - archived - description - required - incidentType - options type: object IncidentFieldOption: additionalProperties: false properties: attributes: $ref: "#/components/schemas/IncidentFieldOptionAttributes" id: type: string required: - id - attributes type: object IncidentFieldOptionAttributes: additionalProperties: false properties: archived: type: boolean optionType: enum: - custom - derived type: string value: type: string required: - optionType - value - archived type: object IncidentFieldSelection: additionalProperties: false properties: fieldId: type: string fieldName: type: string option: $ref: "#/components/schemas/IncidentFieldOption" required: - fieldId - fieldName - option type: object IncidentImpact: additionalProperties: false properties: attributes: $ref: "#/components/schemas/IncidentImpactAttributes" id: type: string required: - id - attributes type: object IncidentImpactAttributes: additionalProperties: false properties: knowledgeEntity: $ref: "#/components/schemas/IncidentImpactKnowledgeEntity" note: type: string source: type: string required: - knowledgeEntity type: object IncidentImpactKnowledgeEntity: additionalProperties: false properties: description: type: string displayName: type: string id: type: string kind: type: string required: - id - kind - displayName type: object IncidentLink: additionalProperties: false properties: incidentId: type: string incidentSummary: type: string incidentTitle: type: string linkType: enum: - duplicate_of - parent - sibling - child type: string required: - incidentId - incidentTitle - incidentSummary - linkType type: object IncidentMetadata: additionalProperties: false properties: fields: items: $ref: "#/components/schemas/IncidentField" type: array roles: items: $ref: "#/components/schemas/IncidentRole" type: array severities: items: $ref: "#/components/schemas/IncidentSeverity" type: array tags: items: $ref: "#/components/schemas/IncidentTag" type: array types: items: $ref: "#/components/schemas/IncidentType" type: array required: - severities - roles - types - tags - fields type: object IncidentMilestone: additionalProperties: false properties: attributes: $ref: "#/components/schemas/IncidentMilestoneAttributes" id: type: string required: - id - attributes type: object IncidentMilestoneAttributes: additionalProperties: false properties: description: type: string kind: enum: - impact - detection - investigation - mitigation - resolution type: string timestamp: format: date-time type: string required: - kind - description - timestamp type: object IncidentRole: additionalProperties: false properties: attributes: $ref: "#/components/schemas/IncidentRoleAttributes" id: type: string required: - id - attributes type: object IncidentRoleAssignment: additionalProperties: false properties: active: type: boolean endedAt: format: date-time type: string role: $ref: "#/components/schemas/IncidentRole" startedAt: format: date-time type: string user: $ref: "#/components/schemas/User" required: - user - role - active - startedAt - endedAt type: object IncidentRoleAttributes: additionalProperties: false properties: archived: type: boolean description: type: string name: type: string required: type: boolean required: - name - archived - required - description type: object IncidentSeverity: additionalProperties: false properties: attributes: $ref: "#/components/schemas/IncidentSeverityAttributes" id: type: string required: - id - attributes type: object IncidentSeverityAttributes: additionalProperties: false properties: archived: type: boolean color: type: string description: type: string name: type: string rank: format: int64 type: integer required: - name - rank - color - archived - description type: object IncidentTag: additionalProperties: false properties: attributes: $ref: "#/components/schemas/IncidentTagAttributes" id: type: string required: - id - attributes type: object IncidentTagAttributes: additionalProperties: false properties: archived: type: boolean description: type: string key: type: string value: type: string required: - key - value - archived - description type: object IncidentTeamAssignment: additionalProperties: false properties: active: type: boolean endedAt: format: date-time type: string startedAt: format: date-time type: string team: $ref: "#/components/schemas/Team" required: - team - active - startedAt - endedAt type: object IncidentTimelineEvent: additionalProperties: false properties: attributes: $ref: "#/components/schemas/IncidentTimelineEventAttributes" id: type: string required: - id - attributes type: object IncidentTimelineEventAttributes: additionalProperties: false properties: contributingFactors: items: $ref: "#/components/schemas/IncidentTimelineEventContributingFactor" type: array decisionContext: $ref: "#/components/schemas/IncidentTimelineEventDecisionContext" description: type: string evidence: items: $ref: "#/components/schemas/IncidentTimelineEventEvidence" type: array incidentId: type: string isKey: type: boolean kind: enum: - observation - action - decision - context type: string sequence: format: int64 type: integer systemContext: items: $ref: "#/components/schemas/IncidentTimelineEventTopologyContext" type: array timestamp: format: date-time type: string title: type: string required: - incidentId - kind - timestamp - isKey - title - sequence - contributingFactors - evidence - systemContext type: object IncidentTimelineEventContributingFactor: additionalProperties: false properties: attributes: $ref: "#/components/schemas/IncidentTimelineEventContributingFactorAttributes" id: type: string required: - id - attributes type: object IncidentTimelineEventContributingFactorAttributes: additionalProperties: false properties: description: type: string factorTypeId: type: string links: items: type: string type: array required: - factorTypeId - description - links type: object IncidentTimelineEventContributingFactorCategory: additionalProperties: false properties: attributes: $ref: "#/components/schemas/IncidentTimelineEventContributingFactorCategoryAttributes" id: type: string required: - id - attributes type: object IncidentTimelineEventContributingFactorCategoryAttributes: additionalProperties: false properties: description: type: string factorTypes: items: $ref: "#/components/schemas/IncidentTimelineEventContributingFactorType" type: array name: type: string required: - name - description - factorTypes type: object IncidentTimelineEventContributingFactorType: additionalProperties: false properties: attributes: $ref: "#/components/schemas/IncidentTimelineEventContributingFactorTypeAttributes" id: type: string required: - id - attributes type: object IncidentTimelineEventContributingFactorTypeAttributes: additionalProperties: false properties: description: type: string examples: items: type: string type: array name: type: string required: - name - description - examples type: object IncidentTimelineEventDecisionContext: additionalProperties: false properties: constraints: items: type: string type: array decisionRationale: type: string optionsConsidered: items: type: string type: array required: - optionsConsidered - constraints - decisionRationale type: object IncidentTimelineEventEvidence: additionalProperties: false properties: attributes: $ref: "#/components/schemas/IncidentTimelineEventEvidenceAttributes" id: type: string required: - id - attributes type: object IncidentTimelineEventEvidenceAttributes: additionalProperties: false properties: properties: additionalProperties: type: string type: object source: type: string value: type: string required: - source - value type: object IncidentTimelineEventMetadata: additionalProperties: false properties: contributingFactorCategories: items: $ref: "#/components/schemas/IncidentTimelineEventContributingFactorCategory" type: array required: - contributingFactorCategories type: object IncidentTimelineEventTopologyContext: additionalProperties: false properties: attributes: $ref: "#/components/schemas/IncidentTimelineEventTopologyContextAttributes" id: type: string required: - id - attributes type: object IncidentTimelineEventTopologyContextAttributes: additionalProperties: false properties: knowledgeEntityId: type: string relationship: type: string snapshotEntityId: type: string required: - relationship type: object IncidentType: additionalProperties: false properties: attributes: $ref: "#/components/schemas/IncidentTypeAttributes" id: type: string required: - id - attributes type: object IncidentTypeAttributes: additionalProperties: false properties: archived: type: boolean description: type: string name: type: string required: - name - archived - description type: object InstallIntegrationFromTargetsRequestAttributes: additionalProperties: false properties: externalRefs: items: type: string type: array required: - externalRefs type: object InstallIntegrationFromTargetsRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/InstallIntegrationFromTargetsRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/InstallIntegrationFromTargetsRequestAttributes" required: - attributes type: object InstallIntegrationFromTargetsResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/InstallIntegrationFromTargetsResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/IntegrationInstallation" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object InstallIntegrationRequestAttributes: additionalProperties: false properties: config: additionalProperties: {} type: object userSettings: additionalProperties: {} type: object required: - config - userSettings type: object InstallIntegrationRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/InstallIntegrationRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/InstallIntegrationRequestAttributes" required: - attributes type: object InstallIntegrationResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/InstallIntegrationResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IntegrationInstallation" required: - data type: object InstallableIntegration: additionalProperties: false properties: description: type: string displayName: type: string maxInstalls: format: int64 type: integer name: type: string oauthInstall: type: boolean provider: type: string required: - name - displayName - description - provider - oauthInstall type: object IntegrationEventSyncRun: additionalProperties: false properties: attributes: $ref: "#/components/schemas/IntegrationEventSyncRunAttributes" id: type: string required: - id - attributes type: object IntegrationEventSyncRunAttributes: additionalProperties: false properties: finishedAt: format: date-time type: - string - "null" startedAt: format: date-time type: string status: enum: - queued - started - complete - error type: string required: - status - startedAt - finishedAt type: object IntegrationInstallTarget: additionalProperties: false properties: displayName: type: string externalRef: type: string integrationName: type: string required: - integrationName - externalRef - displayName type: object IntegrationInstallation: additionalProperties: false properties: attributes: $ref: "#/components/schemas/IntegrationInstallationAttributes" id: type: string required: - id - attributes type: object IntegrationInstallationAttributes: additionalProperties: false properties: config: additionalProperties: {} type: object displayName: type: string externalRef: type: string integrationName: type: string providerName: type: string settings: additionalProperties: {} type: object required: - integrationName - providerName - displayName - externalRef - config - settings type: object IntegrationOAuthFlow: additionalProperties: false properties: flow_url: type: string required: - flow_url type: object IntegrationOAuthInstallResult: additionalProperties: false properties: installTargetOptions: items: $ref: "#/components/schemas/IntegrationInstallTarget" type: array installed: items: $ref: "#/components/schemas/IntegrationInstallation" type: array targetSelectionRequired: type: boolean required: - targetSelectionRequired type: object ListAiAgentRunsResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListAiAgentRunsResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/AiAgentRun" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListAlertIncidentLinksResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListAlertIncidentLinksResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/AlertIncidentLink" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListAlertsResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListAlertsResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/Alert" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListEventAnnotationsResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListEventAnnotationsResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/EventAnnotation" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListEventsResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListEventsResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/Event" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListIncidentDebriefMessagesResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListIncidentDebriefMessagesResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/IncidentDebriefMessage" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListIncidentDebriefQuestionsResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListIncidentDebriefQuestionsResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/IncidentDebriefQuestion" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListIncidentDebriefSuggestionsResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListIncidentDebriefSuggestionsResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/IncidentDebriefSuggestion" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListIncidentFieldsResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListIncidentFieldsResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/IncidentField" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListIncidentImpactsResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListIncidentImpactsResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/IncidentImpact" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListIncidentMilestonesResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListIncidentMilestonesResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/IncidentMilestone" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListIncidentRolesResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListIncidentRolesResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/IncidentRole" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListIncidentSeveritiesResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListIncidentSeveritiesResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/IncidentSeverity" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListIncidentTagsResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListIncidentTagsResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/IncidentTag" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListIncidentTimelineEventsResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListIncidentTimelineEventsResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/IncidentTimelineEvent" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListIncidentTypesResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListIncidentTypesResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/IncidentType" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListIncidentsResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListIncidentsResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/Incident" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListIntegrationEventSyncRunResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListIntegrationEventSyncRunResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/IntegrationEventSyncRun" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListIntegrationInstallTargetsResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListIntegrationInstallTargetsResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/IntegrationInstallTarget" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListIntegrationInstallationsResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListIntegrationInstallationsResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/IntegrationInstallation" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListMeetingSchedulesResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListMeetingSchedulesResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/MeetingSchedule" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListMeetingSessionsResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListMeetingSessionsResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/MeetingSession" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListNotificationsResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListNotificationsResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/UserNotification" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListOncallRostersResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListOncallRostersResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/OncallRoster" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListOncallShiftsResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListOncallShiftsResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/OncallShift" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListPlaybooksResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListPlaybooksResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/Playbook" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListRetrospectiveCommentsResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListRetrospectiveCommentsResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/RetrospectiveComment" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListRetrospectiveReviewsResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListRetrospectiveReviewsResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/RetrospectiveReview" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListRetrospectivesResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListRetrospectivesResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/Retrospective" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListSystemAnalysisEdgesResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListSystemAnalysisEdgesResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/SystemAnalysisEdge" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListSystemAnalysisNodesResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListSystemAnalysisNodesResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/SystemAnalysisNode" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListSystemTopologyEntitiesResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListSystemTopologyEntitiesResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/SystemTopologyEntity" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListSystemTopologyRelationshipsResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListSystemTopologyRelationshipsResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/SystemTopologyRelationship" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListTasksResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListTasksResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/Task" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListTeamMembershipsResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListTeamMembershipsResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/TeamMembership" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListTeamsResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListTeamsResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/Team" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListUsersResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListUsersResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/User" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object ListWatchedOncallRostersResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/ListWatchedOncallRostersResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/OncallRoster" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object MeetingAttendees: additionalProperties: false properties: private: type: boolean teams: items: type: string type: array users: items: type: string type: array required: - private - users - teams type: object MeetingSchedule: additionalProperties: false properties: attributes: $ref: "#/components/schemas/MeetingScheduleAttributes" id: type: string required: - id - attributes type: object MeetingScheduleAttributes: additionalProperties: false properties: attendees: $ref: "#/components/schemas/MeetingAttendees" documentTemplateId: type: string hostTeamId: type: string name: type: string sessionTitle: type: string timing: $ref: "#/components/schemas/MeetingScheduleTiming" required: - name - sessionTitle - attendees - hostTeamId - documentTemplateId - timing type: object MeetingScheduleTiming: additionalProperties: false properties: durationMinutes: format: int64 type: integer indefinite: type: boolean repeat: enum: - daily - weekly - monthly type: string repeatMonthlyOn: enum: - same_day - same_weekday type: - string - "null" repeatStep: format: int64 type: integer startsAt: format: date-time type: string untilDate: type: string untilNumRepetitions: format: int64 type: integer required: - startsAt - durationMinutes - repeat - repeatStep - repeatMonthlyOn - indefinite type: object MeetingSession: additionalProperties: false properties: attributes: $ref: "#/components/schemas/MeetingSessionAttributes" id: type: string required: - id - attributes type: object MeetingSessionAttributes: additionalProperties: false properties: attendees: $ref: "#/components/schemas/MeetingAttendees" documentName: type: string hostTeamId: type: string meetingScheduleId: type: string startsAt: format: date-time type: string title: type: string required: - meetingScheduleId - startsAt - title - hostTeamId - attendees - documentName type: object Message: additionalProperties: false properties: content: items: $ref: "#/components/schemas/Part" type: array metadata: additionalProperties: {} type: object role: type: string type: object OncallRoster: additionalProperties: false properties: attributes: $ref: "#/components/schemas/OncallRosterAttributes" id: type: string required: - id - attributes type: object OncallRosterAttributes: additionalProperties: false properties: handoverTemplateId: type: string name: type: string schedules: items: $ref: "#/components/schemas/OncallSchedule" type: array slug: type: string required: - name - slug - schedules - handoverTemplateId type: object OncallRosterMetrics: additionalProperties: false properties: backlogBurnRate: format: float type: number handoverCompletion: format: float type: number shiftMetrics: items: $ref: "#/components/schemas/OncallShiftMetrics" type: array required: - shiftMetrics - handoverCompletion - backlogBurnRate type: object OncallSchedule: additionalProperties: false properties: attributes: $ref: "#/components/schemas/OncallScheduleAttributes" id: type: string required: - id - attributes type: object OncallScheduleAttributes: additionalProperties: false properties: description: type: string participants: items: $ref: "#/components/schemas/OncallScheduleParticipant" type: array roster: $ref: "#/components/schemas/OncallRoster" timezone: type: string required: - roster - description - timezone - participants type: object OncallScheduleParticipant: additionalProperties: false properties: order: format: int64 type: integer user: $ref: "#/components/schemas/User" required: - user - order type: object OncallShift: additionalProperties: false properties: attributes: $ref: "#/components/schemas/OncallShiftAttributes" id: type: string required: - id - attributes type: object OncallShiftAttributes: additionalProperties: false properties: endAt: format: date-time type: string primaryShift: $ref: "#/components/schemas/OncallShift" role: type: string roster: $ref: "#/components/schemas/OncallRoster" startAt: format: date-time type: string user: $ref: "#/components/schemas/User" required: - user - roster - role - startAt - endAt - primaryShift type: object OncallShiftBurdenMetricWeights: additionalProperties: false type: object OncallShiftHandover: additionalProperties: false properties: attributes: $ref: "#/components/schemas/OncallShiftHandoverAttributes" id: type: string required: - id - attributes type: object OncallShiftHandoverAttributes: additionalProperties: false properties: content: items: $ref: "#/components/schemas/OncallShiftHandoverSection" type: array pinnedAnnotations: items: $ref: "#/components/schemas/EventAnnotation" type: array sentAt: format: date-time type: string shiftId: type: string required: - shiftId - sentAt - content - pinnedAnnotations type: object OncallShiftHandoverSection: additionalProperties: false properties: header: type: string jsonContent: type: string kind: enum: - regular - annotations type: string required: - header - kind type: object OncallShiftHandoverTemplate: additionalProperties: false properties: attributes: $ref: "#/components/schemas/OncallShiftHandoverTemplateAttributes" id: type: string required: - id - attributes type: object OncallShiftHandoverTemplateAttributes: additionalProperties: false properties: sections: items: $ref: "#/components/schemas/OncallShiftHandoverSection" type: array required: - sections type: object OncallShiftMetrics: additionalProperties: false properties: burden: $ref: "#/components/schemas/OncallShiftMetricsBurden" events: $ref: "#/components/schemas/OncallShiftMetricsEvents" required: - burden - events type: object OncallShiftMetricsBurden: additionalProperties: false properties: eventFrequency: format: float type: number finalScore: format: float type: number isolation: format: float type: number lifeImpact: format: float type: number responseRequirements: format: float type: number timeImpact: format: float type: number required: - finalScore - eventFrequency - lifeImpact - timeImpact - responseRequirements - isolation type: object OncallShiftMetricsEvents: additionalProperties: false properties: alertAccuracy: format: float type: number alertActionability: format: float type: number alertDocumentation: format: float type: number alertFeedbackCount: format: float type: number alertIncidentRate: format: float type: number incidentTime: format: float type: number interruptResponseTime: format: float type: number interruptsBusinessHours: format: float type: number interruptsNight: format: float type: number total: format: float type: number totalAlerts: format: float type: number totalIncidents: format: float type: number totalInterrupts: format: float type: number required: - total - totalInterrupts - interruptsBusinessHours - interruptsNight - interruptResponseTime - totalIncidents - incidentTime - totalAlerts - alertIncidentRate - alertFeedbackCount - alertActionability - alertAccuracy - alertDocumentation type: object OncallShiftsAdjacent: additionalProperties: false properties: next: $ref: "#/components/schemas/OncallShift" previous: $ref: "#/components/schemas/OncallShift" type: object Organization: additionalProperties: false properties: attributes: $ref: "#/components/schemas/OrganizationAttributes" id: type: string required: - id - attributes type: object OrganizationAttributes: additionalProperties: false properties: name: type: string preferences: $ref: "#/components/schemas/OrganizationPreferences" setupRequired: type: boolean required: - name - setupRequired - preferences type: object OrganizationPreferences: additionalProperties: false properties: enableIncidentManagement: type: boolean required: - enableIncidentManagement type: object Part: additionalProperties: false properties: contentType: type: string custom: additionalProperties: {} type: object kind: format: int32 type: integer metadata: additionalProperties: {} type: object resource: $ref: "#/components/schemas/ResourcePart" text: type: string toolRequest: $ref: "#/components/schemas/ToolRequest" toolResponse: $ref: "#/components/schemas/ToolResponse" type: object Playbook: additionalProperties: false properties: attributes: $ref: "#/components/schemas/PlaybookAttributes" id: type: string required: - id - attributes type: object PlaybookAttributes: additionalProperties: false properties: content: type: string title: type: string required: - title - content type: object RemoveWatchedOncallRosterResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/RemoveWatchedOncallRosterResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/OncallRoster" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object RequestAgentRunRequestAttributes: additionalProperties: false properties: input: additionalProperties: {} type: object workflow: type: string required: - workflow - input type: object RequestAiAgentRunRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/RequestAiAgentRunRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/RequestAgentRunRequestAttributes" required: - attributes type: object RequestAiAgentRunResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/RequestAiAgentRunResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/AiAgentRun" required: - data type: object RequestDocumentSessionAuthResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/RequestDocumentSessionAuthResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/DocumentSessionAuth" required: - data type: object RequestIntegrationEventSyncRequestAttributes: additionalProperties: false properties: sources: items: type: string type: array type: object RequestIntegrationEventSyncRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/RequestIntegrationEventSyncRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/RequestIntegrationEventSyncRequestAttributes" required: - attributes type: object ResourcePart: additionalProperties: false properties: uri: type: string type: object ResponsePagination: additionalProperties: false properties: next: type: string previous: type: string total: format: int64 type: integer required: - total type: object Retrospective: additionalProperties: false properties: attributes: $ref: "#/components/schemas/RetrospectiveAttributes" id: type: string required: - id - attributes type: object RetrospectiveAttributes: additionalProperties: false properties: documentId: type: string reportSections: items: $ref: "#/components/schemas/RetrospectiveReportSection" type: array state: enum: - draft - in_review - meeting_scheduled - completed type: string systemAnalysisId: type: string type: enum: - simple - full type: string required: - documentId - type - state - reportSections type: object RetrospectiveComment: additionalProperties: false properties: attributes: $ref: "#/components/schemas/RetrospectiveCommentAttributes" id: type: string required: - id - attributes type: object RetrospectiveCommentAttributes: additionalProperties: false properties: content: type: string replies: items: $ref: "#/components/schemas/RetrospectiveComment" type: array user: $ref: "#/components/schemas/User" required: - user - content - replies type: object RetrospectiveReportSection: additionalProperties: false properties: description: type: string field: type: string kind: enum: - field type: string title: type: string required: - kind - title - field - description type: object RetrospectiveReview: additionalProperties: false properties: attributes: $ref: "#/components/schemas/RetrospectiveReviewAttributes" id: type: string required: - id - attributes type: object RetrospectiveReviewAttributes: additionalProperties: false properties: comment: $ref: "#/components/schemas/ExpandableRetrospectiveCommentAttributes" requester: $ref: "#/components/schemas/ExpandableUser" reviewer: $ref: "#/components/schemas/ExpandableUser" required: - requester - reviewer - comment type: object SendOncallShiftHandoverAttributes: additionalProperties: false type: object SendOncallShiftHandoverRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/SendOncallShiftHandoverRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/SendOncallShiftHandoverAttributes" required: - attributes type: object SendOncallShiftHandoverResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/SendOncallShiftHandoverResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/OncallShiftHandover" required: - data type: object SetIncidentImpactAttributes: additionalProperties: false properties: description: type: string displayName: type: string kind: type: string knowledgeEntityId: type: string note: type: string source: type: string type: object SetIncidentImpactsAttributes: additionalProperties: false properties: impacts: items: $ref: "#/components/schemas/SetIncidentImpactAttributes" type: array required: - impacts type: object SetIncidentImpactsRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/SetIncidentImpactsRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/SetIncidentImpactsAttributes" required: - attributes type: object SetIncidentImpactsResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/SetIncidentImpactsResponseBody.json format: uri readOnly: true type: string data: items: $ref: "#/components/schemas/IncidentImpact" type: array pagination: $ref: "#/components/schemas/ResponsePagination" required: - data - pagination type: object StartIntegrationOAuthFlowResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/StartIntegrationOAuthFlowResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IntegrationOAuthFlow" required: - data type: object SystemAnalysis: additionalProperties: false properties: attributes: $ref: "#/components/schemas/SystemAnalysisAttributes" id: type: string required: - id - attributes type: object SystemAnalysisAttributes: additionalProperties: false properties: edges: items: $ref: "#/components/schemas/SystemAnalysisEdge" type: array nodes: items: $ref: "#/components/schemas/SystemAnalysisNode" type: array topologySnapshot: $ref: "#/components/schemas/SystemTopologySnapshot" required: - nodes - edges type: object SystemAnalysisDiagramPosition: additionalProperties: false properties: x: format: double type: number "y": format: double type: number z: format: double type: number required: - x - "y" type: object SystemAnalysisEdge: additionalProperties: false properties: attributes: $ref: "#/components/schemas/SystemAnalysisTopologyEdgeAttributes" id: type: string required: - id - attributes type: object SystemAnalysisNode: additionalProperties: false properties: attributes: $ref: "#/components/schemas/SystemAnalysisNodeAttributes" id: type: string required: - id - attributes type: object SystemAnalysisNodeAttributes: additionalProperties: false properties: description: type: string position: $ref: "#/components/schemas/SystemAnalysisDiagramPosition" snapshotEntity: $ref: "#/components/schemas/SystemTopologySnapshotEntity" required: - snapshotEntity - position - description type: object SystemAnalysisTopologyEdgeAttributes: additionalProperties: false properties: description: type: string snapshotRelationship: $ref: "#/components/schemas/SystemTopologySnapshotRelationship" required: - snapshotRelationship - description type: object SystemTopologyEntity: additionalProperties: false properties: attributes: $ref: "#/components/schemas/SystemTopologyEntityAttributes" id: type: string required: - id - attributes type: object SystemTopologyEntityAlias: additionalProperties: false properties: firstSeenAt: format: date-time type: string id: type: string lastSeenAt: format: date-time type: string provider: type: string providerSource: type: string subjectKind: type: string subjectRef: type: string required: - id - provider - providerSource - subjectKind - subjectRef - firstSeenAt - lastSeenAt type: object SystemTopologyEntityAttributes: additionalProperties: false properties: aliases: items: $ref: "#/components/schemas/SystemTopologyEntityAlias" type: array createdAt: format: date-time type: string description: type: string displayName: type: string kind: type: string properties: additionalProperties: {} type: object relationships: items: $ref: "#/components/schemas/SystemTopologyRelationship" type: array updatedAt: format: date-time type: string required: - kind - displayName - description - properties - aliases - createdAt - updatedAt type: object SystemTopologyGraph: additionalProperties: false properties: entities: items: $ref: "#/components/schemas/SystemTopologyEntity" type: array relationships: items: $ref: "#/components/schemas/SystemTopologyRelationship" type: array required: - entities - relationships type: object SystemTopologyRelationship: additionalProperties: false properties: attributes: $ref: "#/components/schemas/SystemTopologyRelationshipAttributes" id: type: string required: - id - attributes type: object SystemTopologyRelationshipAttributes: additionalProperties: false properties: createdAt: format: date-time type: string description: type: string displayName: type: string firstSeenAt: format: date-time type: string kind: type: string lastSeenAt: format: date-time type: string properties: additionalProperties: {} type: object source: $ref: "#/components/schemas/SystemTopologyEntity" sourceEntityId: type: string target: $ref: "#/components/schemas/SystemTopologyEntity" targetEntityId: type: string updatedAt: format: date-time type: string required: - sourceEntityId - targetEntityId - kind - displayName - description - properties - firstSeenAt - lastSeenAt - createdAt - updatedAt type: object SystemTopologySnapshot: additionalProperties: false properties: attributes: $ref: "#/components/schemas/SystemTopologySnapshotAttributes" id: type: string required: - id - attributes type: object SystemTopologySnapshotAttributes: additionalProperties: false properties: asOf: format: date-time type: string createdAt: format: date-time type: string entities: items: $ref: "#/components/schemas/SystemTopologySnapshotEntity" type: array name: type: string relationships: items: $ref: "#/components/schemas/SystemTopologySnapshotRelationship" type: array scope: type: string scopeProperties: additionalProperties: {} type: object required: - name - asOf - scope - scopeProperties - entities - relationships - createdAt type: object SystemTopologySnapshotEntity: additionalProperties: false properties: attributes: $ref: "#/components/schemas/SystemTopologySnapshotEntityAttributes" id: type: string required: - id - attributes type: object SystemTopologySnapshotEntityAttributes: additionalProperties: false properties: aliases: items: additionalProperties: {} type: object type: array description: type: string displayName: type: string kind: type: string knowledgeEntityId: type: string properties: additionalProperties: {} type: object required: - kind - displayName - description - properties - aliases type: object SystemTopologySnapshotRelationship: additionalProperties: false properties: attributes: $ref: "#/components/schemas/SystemTopologySnapshotRelationshipAttributes" id: type: string required: - id - attributes type: object SystemTopologySnapshotRelationshipAttributes: additionalProperties: false properties: description: type: string displayName: type: string kind: type: string knowledgeRelationshipId: type: string properties: additionalProperties: {} type: object sourceSnapshotEntityId: type: string targetSnapshotEntityId: type: string required: - sourceSnapshotEntityId - targetSnapshotEntityId - kind - displayName - description - properties type: object Task: additionalProperties: false properties: attributes: $ref: "#/components/schemas/TaskAttributes" id: type: string required: - id - attributes type: object TaskAttributes: additionalProperties: false properties: description: type: string name: type: string required: - name - description type: object Team: additionalProperties: false properties: attributes: $ref: "#/components/schemas/TeamAttributes" id: type: string required: - id - attributes type: object TeamAttributes: additionalProperties: false properties: name: type: string slug: type: string required: - slug - name type: object TeamMembership: additionalProperties: false properties: attributes: $ref: "#/components/schemas/TeamMembershipAttributes" id: type: string required: - id - attributes type: object TeamMembershipAttributes: additionalProperties: false properties: role: enum: - admin - member type: string team: $ref: "#/components/schemas/Team" teamId: type: string user: $ref: "#/components/schemas/User" userId: type: string required: - role - teamId - userId type: object ToolRequest: additionalProperties: false properties: input: {} name: type: string partial: type: boolean ref: type: string type: object ToolResponse: additionalProperties: false properties: content: items: $ref: "#/components/schemas/Part" type: array name: type: string output: {} ref: type: string type: object UpdateEventAnnotationRequestAttributes: additionalProperties: false properties: minutesOccupied: format: int64 type: integer notes: type: string tags: items: type: string type: array type: object UpdateEventAnnotationRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateEventAnnotationRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/UpdateEventAnnotationRequestAttributes" required: - attributes type: object UpdateEventAnnotationResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateEventAnnotationResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/EventAnnotation" required: - data type: object UpdateIncidentAttributes: additionalProperties: false properties: severityId: type: string summary: type: string title: type: string typeId: type: string type: object UpdateIncidentDebriefAttributes: additionalProperties: false properties: status: enum: - started - completed type: string required: - status type: object UpdateIncidentDebriefQuestionAttributes: additionalProperties: false properties: content: type: string type: object UpdateIncidentDebriefQuestionRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateIncidentDebriefQuestionRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/UpdateIncidentDebriefQuestionAttributes" required: - attributes type: object UpdateIncidentDebriefQuestionResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateIncidentDebriefQuestionResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IncidentDebriefQuestion" required: - data type: object UpdateIncidentDebriefRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateIncidentDebriefRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/UpdateIncidentDebriefAttributes" required: - attributes type: object UpdateIncidentDebriefResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateIncidentDebriefResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IncidentDebrief" required: - data type: object UpdateIncidentFieldAttributes: additionalProperties: false properties: archived: type: boolean incidentType: type: string name: type: string options: items: $ref: "#/components/schemas/UpdateIncidentFieldOptionAttributes" type: array required: type: boolean type: object UpdateIncidentFieldOptionAttributes: additionalProperties: false properties: archived: type: boolean fieldOptionType: enum: - custom - derived type: string id: type: string value: type: string required: - fieldOptionType - value - archived type: object UpdateIncidentFieldRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateIncidentFieldRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/UpdateIncidentFieldAttributes" required: - attributes type: object UpdateIncidentFieldResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateIncidentFieldResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IncidentField" required: - data type: object UpdateIncidentMilestoneAttributes: additionalProperties: false properties: description: type: string kind: enum: - impact - detection - investigation - mitigation - resolution type: string timestamp: format: date-time type: string type: object UpdateIncidentMilestoneRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateIncidentMilestoneRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/UpdateIncidentMilestoneAttributes" required: - attributes type: object UpdateIncidentMilestoneResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateIncidentMilestoneResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IncidentMilestone" required: - data type: object UpdateIncidentRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateIncidentRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/UpdateIncidentAttributes" required: - attributes type: object UpdateIncidentResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateIncidentResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/Incident" required: - data type: object UpdateIncidentRoleAttributes: additionalProperties: false properties: archived: type: boolean description: type: string name: type: string required: type: boolean type: object UpdateIncidentRoleRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateIncidentRoleRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/UpdateIncidentRoleAttributes" required: - attributes type: object UpdateIncidentRoleResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateIncidentRoleResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IncidentRole" required: - data type: object UpdateIncidentSeverityAttributes: additionalProperties: false properties: archived: type: boolean name: type: string rank: format: int64 type: integer type: object UpdateIncidentSeverityRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateIncidentSeverityRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/UpdateIncidentSeverityAttributes" required: - attributes type: object UpdateIncidentSeverityResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateIncidentSeverityResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IncidentSeverity" required: - data type: object UpdateIncidentTagAttributes: additionalProperties: false properties: archived: type: boolean value: type: string type: object UpdateIncidentTagRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateIncidentTagRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/UpdateIncidentTagAttributes" required: - attributes type: object UpdateIncidentTagResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateIncidentTagResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IncidentTag" required: - data type: object UpdateIncidentTimelineEventAttributes: additionalProperties: false properties: kind: enum: - observation - action - decision - context type: string timestamp: format: date-time type: string title: type: string type: object UpdateIncidentTimelineEventRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateIncidentTimelineEventRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/UpdateIncidentTimelineEventAttributes" required: - attributes type: object UpdateIncidentTimelineEventResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateIncidentTimelineEventResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IncidentTimelineEvent" required: - data type: object UpdateIncidentTypeAttributes: additionalProperties: false properties: archived: type: boolean name: type: string type: object UpdateIncidentTypeRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateIncidentTypeRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/UpdateIncidentTypeAttributes" required: - attributes type: object UpdateIncidentTypeResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateIncidentTypeResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IncidentType" required: - data type: object UpdateIntegrationInstallationRequestAttributes: additionalProperties: false properties: userSettings: additionalProperties: {} type: object required: - userSettings type: object UpdateIntegrationInstallationRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateIntegrationInstallationRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/UpdateIntegrationInstallationRequestAttributes" required: - attributes type: object UpdateIntegrationInstallationResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateIntegrationInstallationResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/IntegrationInstallation" required: - data type: object UpdateMeetingScheduleAttributes: additionalProperties: false type: object UpdateMeetingScheduleRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateMeetingScheduleRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/UpdateMeetingScheduleAttributes" required: - attributes type: object UpdateMeetingScheduleResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateMeetingScheduleResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/MeetingSchedule" required: - data type: object UpdateMeetingSessionAttributes: additionalProperties: false type: object UpdateMeetingSessionRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateMeetingSessionRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/UpdateMeetingSessionAttributes" required: - attributes type: object UpdateMeetingSessionResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateMeetingSessionResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/MeetingSession" required: - data type: object UpdateOncallShiftHandoverAttributes: additionalProperties: false properties: content: items: $ref: "#/components/schemas/OncallShiftHandoverSection" type: array pinnedAnnotationIds: items: type: string type: array type: object UpdateOncallShiftHandoverRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateOncallShiftHandoverRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/UpdateOncallShiftHandoverAttributes" required: - attributes type: object UpdateOncallShiftHandoverResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateOncallShiftHandoverResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/OncallShiftHandover" required: - data type: object UpdateOncallShiftHandoverTemplateRequestAttributes: additionalProperties: false properties: sections: items: $ref: "#/components/schemas/OncallShiftHandoverSection" type: array required: - sections type: object UpdateOncallShiftHandoverTemplateRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateOncallShiftHandoverTemplateRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/UpdateOncallShiftHandoverTemplateRequestAttributes" required: - attributes type: object UpdateOncallShiftHandoverTemplateResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateOncallShiftHandoverTemplateResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/OncallShiftHandoverTemplate" required: - data type: object UpdateOrganizationPreferencesRequestAttributes: additionalProperties: false properties: enableIncidentManagement: type: boolean initialSetupComplete: type: boolean type: object UpdateOrganizationPreferencesRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateOrganizationPreferencesRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/UpdateOrganizationPreferencesRequestAttributes" required: - attributes type: object UpdateOrganizationPreferencesResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateOrganizationPreferencesResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/OrganizationPreferences" required: - data type: object UpdatePlaybookAttributes: additionalProperties: false properties: content: type: string title: type: string type: object UpdatePlaybookRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdatePlaybookRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/UpdatePlaybookAttributes" required: - attributes type: object UpdatePlaybookResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdatePlaybookResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/Playbook" required: - data type: object UpdateRetrospectiveAttributes: additionalProperties: false type: object UpdateRetrospectiveCommentAttributes: additionalProperties: false properties: content: type: string resolved: type: boolean type: object UpdateRetrospectiveCommentRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateRetrospectiveCommentRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/UpdateRetrospectiveCommentAttributes" required: - attributes type: object UpdateRetrospectiveCommentResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateRetrospectiveCommentResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/RetrospectiveComment" required: - data type: object UpdateRetrospectiveRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateRetrospectiveRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/UpdateRetrospectiveAttributes" required: - attributes type: object UpdateRetrospectiveResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateRetrospectiveResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/Retrospective" required: - data type: object UpdateRetrospectiveReviewRequestAttributes: additionalProperties: false type: object UpdateRetrospectiveReviewRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateRetrospectiveReviewRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/UpdateRetrospectiveReviewRequestAttributes" required: - attributes type: object UpdateRetrospectiveReviewResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateRetrospectiveReviewResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/RetrospectiveReview" required: - data type: object UpdateSystemAnalysisEdgeAttributes: additionalProperties: false properties: description: type: string type: object UpdateSystemAnalysisEdgeRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateSystemAnalysisEdgeRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/UpdateSystemAnalysisEdgeAttributes" required: - attributes type: object UpdateSystemAnalysisEdgeResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateSystemAnalysisEdgeResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/SystemAnalysisEdge" required: - data type: object UpdateSystemAnalysisNodeAttributes: additionalProperties: false properties: description: type: string position: $ref: "#/components/schemas/SystemAnalysisDiagramPosition" type: object UpdateSystemAnalysisNodeRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateSystemAnalysisNodeRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/UpdateSystemAnalysisNodeAttributes" required: - attributes type: object UpdateSystemAnalysisNodeResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateSystemAnalysisNodeResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/SystemAnalysisNode" required: - data type: object UpdateTaskAttributes: additionalProperties: false properties: name: nullable: true type: string type: object UpdateTaskRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateTaskRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/UpdateTaskAttributes" required: - attributes type: object UpdateTaskResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateTaskResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/Task" required: - data type: object UpdateTeamAttributes: additionalProperties: false properties: name: nullable: true type: string required: - name type: object UpdateTeamMembershipAttributes: additionalProperties: false properties: role: enum: - admin - member type: string type: object UpdateTeamMembershipRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateTeamMembershipRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/UpdateTeamMembershipAttributes" required: - attributes type: object UpdateTeamMembershipResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateTeamMembershipResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/TeamMembership" required: - data type: object UpdateTeamRequestBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateTeamRequestBody.json format: uri readOnly: true type: string attributes: $ref: "#/components/schemas/UpdateTeamAttributes" required: - attributes type: object UpdateTeamResponseBody: additionalProperties: false properties: $schema: description: A URL to the JSON Schema for this object. examples: - /v1/schemas/UpdateTeamResponseBody.json format: uri readOnly: true type: string data: $ref: "#/components/schemas/Team" required: - data type: object User: additionalProperties: false properties: attributes: $ref: "#/components/schemas/UserAttributes" id: type: string required: - id - attributes type: object UserAttributes: additionalProperties: false properties: email: type: string name: type: string required: - name - email type: object UserNotification: additionalProperties: false properties: attributes: $ref: "#/components/schemas/UserNotificationAttributes" id: type: string required: - id - attributes type: object UserNotificationAttributes: additionalProperties: false properties: text: type: string required: - text type: object UserOncallInformation: additionalProperties: false properties: activeShifts: items: $ref: "#/components/schemas/OncallShift" type: array pastShifts: items: $ref: "#/components/schemas/OncallShift" type: array rosters: items: $ref: "#/components/schemas/OncallRoster" type: array upcomingShifts: items: $ref: "#/components/schemas/OncallShift" type: array watchingRosters: items: $ref: "#/components/schemas/OncallRoster" type: array required: - rosters - watchingRosters - activeShifts - upcomingShifts - pastShifts type: object UserSession: additionalProperties: false properties: expiresAt: format: date-time type: string organization: $ref: "#/components/schemas/Organization" organizationRole: enum: - admin - member type: string user: $ref: "#/components/schemas/User" required: - user - organization - organizationRole - expiresAt type: object VideoConference: additionalProperties: false properties: attributes: $ref: "#/components/schemas/VideoConferenceAttributes" id: type: string required: - id - attributes type: object VideoConferenceAttributes: additionalProperties: false properties: createdByIntegration: type: string dialIn: type: string externalId: type: string hostUrl: type: string joinUrl: type: string metadata: additionalProperties: {} type: object passcode: type: string provider: type: string status: type: string required: - provider - joinUrl - status type: object securitySchemes: api-token: bearerFormat: JWT scheme: bearer type: http app-cookie: in: cookie name: rez_auth_session type: openIdConnect session-token: bearerFormat: paseto scheme: bearer type: http info: description: Rezible API Specification title: Rezible API version: 0.0.1 openapi: 3.1.0 paths: /ai/agents/runs: get: operationId: list-ai-agent-runs parameters: - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean - explode: false in: query name: agentTaskId schema: type: string - explode: false in: query name: name schema: type: string - explode: false in: query name: resulted schema: type: boolean responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListAiAgentRunsResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Agent Runs tags: - AI post: operationId: request-ai-agent-run requestBody: content: application/json: schema: $ref: "#/components/schemas/RequestAiAgentRunRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/RequestAiAgentRunResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Request Agent Run tags: - AI /ai/agents/runs/{id}: get: operationId: get-ai-agent-run parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetAiAgentRunResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get an Agent Run tags: - AI /alerts: get: operationId: list-alerts parameters: - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean - explode: false in: query name: rosterId schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListAlertsResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Alerts tags: - Alerts /alerts/{id}: get: operationId: get-alert parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetAlertResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get Alert tags: - Alerts /alerts/{id}/incident_links: get: operationId: list-alert-incident-links parameters: - in: path name: id required: true schema: type: string - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListAlertIncidentLinksResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Incident Links for an Alert tags: - Alerts /alerts/{id}/metrics: get: operationId: get-alert-metrics parameters: - in: path name: id required: true schema: type: string - explode: false in: query name: rosterId schema: type: string - explode: false in: query name: from required: true schema: format: date type: string - explode: false in: query name: to required: true schema: format: date type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetAlertMetricsResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get Alert Metrics tags: - Alerts /auth_session/notifications: get: operationId: list-user-notifications parameters: - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListNotificationsResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Notifications for the Current User tags: - User Session /debrief_questions: get: operationId: list-debrief-questions parameters: - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListIncidentDebriefQuestionsResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Incident Debrief Questions tags: - Incident Debriefs post: operationId: create-debrief-question requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateIncidentDebriefQuestionRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/CreateIncidentDebriefQuestionResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Create an Incident Debrief Question tags: - Incident Debriefs /debrief_questions/{id}: delete: operationId: archive-debrief-question parameters: - in: path name: id required: true schema: type: string responses: "204": description: No Content "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Archive an Incident Debrief Question tags: - Incident Debriefs get: operationId: get-debrief-question parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetIncidentDebriefQuestionResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get an Incident Debrief Question tags: - Incident Debriefs patch: operationId: update-debrief-question parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateIncidentDebriefQuestionRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/UpdateIncidentDebriefQuestionResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Update an Incident Debrief Question tags: - Incident Debriefs /documents/{id}/session: get: operationId: get-document-session parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetDocumentSessionResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error security: - session-token: - documents:* summary: Get document session tags: - documents /documents/{id}/session/new: post: operationId: request-document-session-auth parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/RequestDocumentSessionAuthResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Request a session for a document tags: - documents /event_annotations: get: operationId: list-event-annotations parameters: - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean - explode: false in: query name: from schema: format: date-time type: string - explode: false in: query name: to schema: format: date-time type: string - explode: false in: query name: userIds schema: type: string - explode: false in: query name: shiftIds schema: type: string - explode: false in: query name: withEvents schema: type: boolean responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListEventAnnotationsResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Event Annotations tags: - Event Annotations post: operationId: create-event-annotation requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateEventAnnotationRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/CreateEventAnnotationResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Create an Event Annotation tags: - Event Annotations /event_annotations/{id}: delete: operationId: delete-event-annotation parameters: - in: path name: id required: true schema: type: string responses: "204": description: No Content "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Delete an Event Annotation tags: - Event Annotations patch: operationId: update-event-annotation parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateEventAnnotationRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/UpdateEventAnnotationResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Update an Event Annotation tags: - Event Annotations /events: get: operationId: list-events parameters: - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean - explode: false in: query name: from schema: format: date-time type: string - explode: false in: query name: to schema: format: date-time type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListEventsResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Events tags: - Events /events/{id}: get: operationId: get-event parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetEventResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get Event tags: - Events /incident_debriefs/{id}: get: operationId: get-incident-debrief parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetIncidentDebriefResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get Incident Debrief tags: - Incident Debriefs patch: operationId: update-incident-debrief parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateIncidentDebriefRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/UpdateIncidentDebriefResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Update Incident Debrief tags: - Incident Debriefs /incident_debriefs/{id}/messages: get: operationId: list-debrief-messages parameters: - in: path name: id required: true schema: type: string - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListIncidentDebriefMessagesResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Incident Debrief Messages tags: - Incident Debriefs post: operationId: add-incident-debrief-user-message parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/AddIncidentDebriefUserMessageRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/AddIncidentDebriefUserMessageResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Add an Incident Debrief message tags: - Incident Debriefs /incident_debriefs/{id}/suggestions: get: operationId: list-debrief-suggestions parameters: - in: path name: id required: true schema: type: string - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListIncidentDebriefSuggestionsResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Incident Debrief Suggestions tags: - Incident Debriefs /incident_metadata: get: operationId: get-incident-metadata responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetIncidentMetadataResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get available incident metadata options tags: - Incidents /incident_metadata/fields: get: operationId: list-incident-fields parameters: - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListIncidentFieldsResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Incident Fields tags: - Incident Fields post: operationId: create-incident-field requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateIncidentFieldRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/CreateIncidentFieldResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Create an Incident Field tags: - Incident Fields /incident_metadata/fields/{id}: delete: operationId: archive-incident-field parameters: - in: path name: id required: true schema: type: string responses: "204": description: No Content "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Archive an Incident Field tags: - Incident Fields get: operationId: get-incident-field parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetIncidentFieldResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get an Incident Field tags: - Incident Fields patch: operationId: update-incident-field parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateIncidentFieldRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/UpdateIncidentFieldResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Update an Incident Field tags: - Incident Fields /incident_metadata/roles: get: operationId: list-incident-roles parameters: - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListIncidentRolesResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Incident Roles tags: - Incident Roles post: operationId: create-incident-role requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateIncidentRoleRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/CreateIncidentRoleResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Create an Incident Role tags: - Incident Roles /incident_metadata/roles/{id}: delete: operationId: archive-incident-role parameters: - in: path name: id required: true schema: type: string responses: "204": description: No Content "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Archive an Incident Role tags: - Incident Roles get: operationId: get-incident-role parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetIncidentRoleResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get an Incident Role tags: - Incident Roles patch: operationId: update-incident-role parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateIncidentRoleRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/UpdateIncidentRoleResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Update an Incident Role tags: - Incident Roles /incident_metadata/severities: get: operationId: list-incident-severities parameters: - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListIncidentSeveritiesResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Severities tags: - Incident Severities post: operationId: create-incident-severity requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateIncidentSeverityRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/CreateIncidentSeverityResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Create a Severity tags: - Incident Severities /incident_metadata/severities/{id}: delete: operationId: archive-incident-severity parameters: - in: path name: id required: true schema: type: string responses: "204": description: No Content "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Archive a Severity tags: - Incident Severities get: operationId: get-incident-severity parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetIncidentSeverityResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get a Severity tags: - Incident Severities patch: operationId: update-incident-severity parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateIncidentSeverityRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/UpdateIncidentSeverityResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Update a Severity tags: - Incident Severities /incident_metadata/tags: get: operationId: list-incident-tags parameters: - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListIncidentTagsResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Incident Tags tags: - Incident Tags post: operationId: create-incident-tag requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateIncidentTagRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/CreateIncidentTagResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Create an Incident Tag tags: - Incident Tags /incident_metadata/tags/{id}: delete: operationId: archive-incident-tag parameters: - in: path name: id required: true schema: type: string responses: "204": description: No Content "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Archive an Incident Tag tags: - Incident Tags get: operationId: get-incident-tag parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetIncidentTagResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get an Incident Tag tags: - Incident Tags patch: operationId: update-incident-tag parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateIncidentTagRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/UpdateIncidentTagResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Update an Incident Tag tags: - Incident Tags /incident_metadata/types: get: operationId: list-incident-types parameters: - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListIncidentTypesResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Types tags: - Incident Types post: operationId: create-incident-type requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateIncidentTypeRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/CreateIncidentTypeResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Create an Incident Type tags: - Incident Types /incident_metadata/types/{id}: delete: operationId: archive-incident-type parameters: - in: path name: id required: true schema: type: string responses: "204": description: No Content "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Archive an Incident Type tags: - Incident Types get: operationId: get-incident-type parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetIncidentTypeResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get a Severity tags: - Incident Types patch: operationId: update-incident-type parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateIncidentTypeRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/UpdateIncidentTypeResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Update an Incident Type tags: - Incident Types /incident_milestones/{id}: delete: operationId: delete-incident-milestone parameters: - in: path name: id required: true schema: type: string responses: "204": description: No Content "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Delete an Incident Milestone tags: - Incident Milestones patch: operationId: update-incident-milestone parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateIncidentMilestoneRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/UpdateIncidentMilestoneResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Update an Incident Milestone tags: - Incident Milestones /incident_timeline/event_metadata: get: operationId: list-incident-timeline-event-metadata responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetIncidentTimelineEventMetadataResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get metadata available for incident timeline events tags: - Incident Timeline /incident_timeline/events/{id}: delete: operationId: delete-incident-timeline-event parameters: - in: path name: id required: true schema: type: string responses: "204": description: No Content "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Delete an Incident Event tags: - Incident Timeline patch: operationId: update-incident-timeline-event parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateIncidentTimelineEventRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/UpdateIncidentTimelineEventResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Update an Incident Event tags: - Incident Timeline /incidents: get: operationId: list-incidents parameters: - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean - explode: false in: query name: teamId schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListIncidentsResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Incidents tags: - Incidents post: operationId: create-incident requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateIncidentRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/CreateIncidentResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Create an Incident tags: - Incidents /incidents/{id}: delete: operationId: archive-incident parameters: - in: path name: id required: true schema: type: string responses: "204": description: No Content "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Archive an Incident tags: - Incidents get: operationId: get-incident parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetIncidentResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get Incident tags: - Incidents patch: operationId: update-incident parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateIncidentRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/UpdateIncidentResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Update an Incident tags: - Incidents /incidents/{id}/debrief: get: operationId: get-incident-user-debrief parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetIncidentUserDebriefResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get Debrief For Incident tags: - Incident Debriefs /incidents/{id}/impacts: get: operationId: list-incident-impacts parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListIncidentImpactsResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Incident Impacts tags: - Incidents put: operationId: set-incident-impacts parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/SetIncidentImpactsRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/SetIncidentImpactsResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Set Incident Impacts tags: - Incidents /incidents/{id}/milestones: get: operationId: list-incident-milestones parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListIncidentMilestonesResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Milestones for Incident tags: - Incidents - Incident Milestones post: operationId: create-incident-milestone parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateIncidentMilestoneRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/CreateIncidentMilestoneResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Create an Incident Milestone tags: - Incident Milestones /incidents/{id}/timeline_events: get: operationId: list-incident-timeline-events parameters: - in: path name: id required: true schema: type: string - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListIncidentTimelineEventsResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Events for Incident tags: - Incidents - Incident Timeline post: operationId: create-incident-timeline-event parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateIncidentTimelineEventRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/CreateIncidentTimelineEventResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Create an Incident Event tags: - Incident Timeline /integrations: get: operationId: get-installable-integrations parameters: - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetInstallableIntegrationsResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get Installable Integrations tags: - Integrations /integrations/install/{name}: post: operationId: install-integration parameters: - in: path name: name required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/InstallIntegrationRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/InstallIntegrationResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Install an Integration tags: - Integrations /integrations/install/{name}/oauth/complete: post: operationId: complete-integration-oauth-flow parameters: - in: path name: name required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/CompleteIntegrationOAuthFlowRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/CompleteIntegrationOAuthFlowResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Complete OAuth flow for an Integration tags: - Integrations /integrations/install/{name}/oauth/start: post: operationId: start-integration-oauth-flow parameters: - in: path name: name required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/StartIntegrationOAuthFlowResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Start OAuth flow for an Integration tags: - Integrations /integrations/install/{name}/targets: post: operationId: install-integration-from-targets parameters: - in: path name: name required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/InstallIntegrationFromTargetsRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/InstallIntegrationFromTargetsResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Select installation targets for an Integration tags: - Integrations /integrations/install_targets: get: operationId: list-integration-install-targets responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListIntegrationInstallTargetsResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List integration installation targets requiring selection tags: - Integrations /integrations/installations: get: operationId: list-integration-installations parameters: - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListIntegrationInstallationsResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Installed Integrations tags: - Integrations /integrations/installations/{id}: delete: operationId: delete-integration-installation parameters: - in: path name: id required: true schema: type: string responses: "204": description: No Content "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Delete an Integration tags: - Integrations get: operationId: get-integration-installation parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetIntegrationInstallationResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get an Integration tags: - Integrations patch: operationId: update-integration-installation parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateIntegrationInstallationRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/UpdateIntegrationInstallationResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Update an installed Integration tags: - Integrations /integrations/installations/{id}/sync: get: operationId: list-integration-event-sync-runs parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListIntegrationEventSyncRunResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get event sync runs for an integration tags: - Integrations /integrations/installations/{id}/sync/start: post: operationId: request-integration-event-sync parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/RequestIntegrationEventSyncRequestBody" required: true responses: "204": description: No Content "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Request a manual event sync for an integration tags: - Integrations /meeting_schedules: get: operationId: list-meeting-schedules parameters: - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListMeetingSchedulesResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Meeting Schedules tags: - Meetings post: operationId: create-meeting-schedule requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateMeetingScheduleRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/CreateMeetingScheduleResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Create a Meeting Schedule tags: - Meetings /meeting_schedules/{id}: delete: operationId: archive-meeting-schedule parameters: - in: path name: id required: true schema: type: string responses: "204": description: No Content "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Archive a Meeting Schedule tags: - Meetings get: operationId: get-meeting-schedule parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetMeetingScheduleResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get a Meeting Schedule tags: - Meetings patch: operationId: update-meeting-schedule parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateMeetingScheduleRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/UpdateMeetingScheduleResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Update a Meeting Schedule tags: - Meetings /meeting_sessions: get: operationId: list-meeting-sessions parameters: - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean - explode: false in: query name: meetingScheduleId schema: type: string - explode: false in: query name: userId schema: type: string - explode: false in: query name: teamId schema: type: string - explode: false in: query name: from schema: type: string - explode: false in: query name: to schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListMeetingSessionsResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Sessions tags: - Meetings post: operationId: create-meeting-session requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateMeetingSessionRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/CreateMeetingSessionResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Create a Meeting Session tags: - Meetings /meeting_sessions/{id}: delete: operationId: archive-meeting-session parameters: - in: path name: id required: true schema: type: string responses: "204": description: No Content "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Archive a Meeting Session tags: - Meetings get: operationId: get-meeting-session parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetMeetingSessionResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get a Meeting Session tags: - Meetings patch: operationId: update-meeting-session parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateMeetingSessionRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/UpdateMeetingSessionResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Update a Meeting Session tags: - Meetings /oncall/handover_templates: post: operationId: create-oncall-handover-template requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateOncallShiftHandoverTemplateRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/CreateOncallShiftHandoverTemplateResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Create an Oncall Handover Template tags: - Oncall Shifts /oncall/handover_templates/{id}: delete: operationId: archive-oncall-handover-template parameters: - in: path name: id required: true schema: type: string responses: "204": description: No Content "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Archive an Oncall Handover Template tags: - Oncall Shifts get: operationId: get-oncall-shift-handover-template parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetOncallShiftHandoverTemplateResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get handover for a shift tags: - Oncall Shifts patch: operationId: update-oncall-handover-template parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateOncallShiftHandoverTemplateRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/UpdateOncallShiftHandoverTemplateResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Update an Oncall Handover Template tags: - Oncall Shifts /oncall/handovers/{id}: patch: operationId: update-oncall-shift-handover parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateOncallShiftHandoverRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/UpdateOncallShiftHandoverResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Update an Oncall Shift Handover tags: - Oncall Shifts /oncall/handovers/{id}/send: post: operationId: send-oncall-shift-handover parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/SendOncallShiftHandoverRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/SendOncallShiftHandoverResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Send a Shift Handover tags: - Oncall Shifts /oncall/rosters: get: operationId: list-oncall-rosters parameters: - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean - explode: false in: query name: teamId schema: type: string - explode: false in: query name: userId schema: type: string - explode: false in: query name: pinned schema: type: boolean responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListOncallRostersResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Oncall Rosters tags: - Oncall Rosters /oncall/rosters/{id}: get: operationId: get-oncall-roster parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetOncallRosterResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get oncall roster tags: - Oncall Rosters /oncall/shifts: get: operationId: list-oncall-shifts parameters: - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean - explode: false in: query name: userId schema: type: string - explode: false in: query name: active schema: type: boolean responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListOncallShiftsResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Oncall Shifts tags: - Oncall Shifts /oncall/shifts/{id}: get: operationId: get-oncall-shift parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetOncallShiftResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get an Oncall Shift tags: - Oncall Shifts /oncall/shifts/{id}/adjacent: get: operationId: get-adjacent-oncall-shifts parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetAdjacentOncallShiftsResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get shifts adjacent to a given shift tags: - Oncall Shifts /oncall/shifts/{id}/handover: get: operationId: get-oncall-shift-handover parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetOncallShiftHandoverResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get handover for a shift tags: - Oncall Shifts /oncall/user: get: operationId: get-user-oncall-information parameters: - explode: false in: query name: userId required: true schema: type: string - explode: false in: query name: activeShifts schema: default: true type: boolean - explode: false in: query name: upcomingShifts schema: default: 0 format: int64 type: integer - explode: false in: query name: pastShifts schema: default: 0 format: int64 type: integer responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetUserOncallInformationResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get oncall information for a user tags: - Oncall Rosters /oncall/watched_rosters: get: operationId: list-watched-oncall-rosters responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListWatchedOncallRostersResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List watched oncall rosters tags: - Oncall Rosters /oncall/watched_rosters/{id}: delete: operationId: remove-watched-oncall-roster parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/RemoveWatchedOncallRosterResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Remove a watched oncall roster tags: - Oncall Rosters post: operationId: add-watched-oncall-roster parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/AddWatchedOncallRosterResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Add a watched oncall roster tags: - Oncall Rosters /oncall_metrics/burden_weights: get: operationId: get-oncall-shift-burden-metric-weights responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetOncallShiftBurdenMetricWeightsResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get Weights for Calculating Burden tags: - Oncall Metrics /oncall_metrics/rosters: get: operationId: get-oncall-roster-metrics parameters: - explode: false in: query name: rosterId schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetOncallRosterMetricsResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get Metrics for an Oncall Roster tags: - Oncall Metrics /oncall_metrics/shifts: get: operationId: get-oncall-shift-metrics parameters: - explode: false in: query name: shiftId schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetOncallShiftMetricsResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get Metrics for an Oncall Shift tags: - Oncall Metrics /organizations/{id}: get: operationId: get-organization parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetOrganizationResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get Organization tags: - Organizations /organizations/{id}/preferences: patch: operationId: update-organization-preferences parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateOrganizationPreferencesRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/UpdateOrganizationPreferencesResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Update Organization Preferences tags: - Organizations /playbooks: get: operationId: list-playbooks parameters: - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean - explode: false in: query name: teamId schema: type: string - explode: false in: query name: alertId schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListPlaybooksResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Playbooks tags: - Playbooks post: operationId: create-playbook requestBody: content: application/json: schema: $ref: "#/components/schemas/CreatePlaybookRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/CreatePlaybookResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Create a Playbook tags: - Playbooks /playbooks/{id}: delete: operationId: archive-playbook parameters: - in: path name: id required: true schema: type: string responses: "204": description: No Content "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Archive a Playbook tags: - Playbooks get: operationId: get-playbook parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetPlaybookResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get Playbook tags: - Playbooks patch: operationId: update-playbook parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdatePlaybookRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/UpdatePlaybookResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Update a Playbook tags: - Playbooks /retrospective_comments/{id}: get: operationId: get-retrospective-comment parameters: - in: path name: id required: true schema: type: string - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetRetrospectiveCommentResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get a Retrospective Comment tags: - Retrospectives patch: operationId: update-retrospective-comment parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateRetrospectiveCommentRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/UpdateRetrospectiveCommentResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Update a Retrospective Comment tags: - Retrospectives /retrospective_reviews/{id}: delete: operationId: archive-retrospective-review parameters: - in: path name: id required: true schema: type: string responses: "204": description: No Content "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Archive a Retrospective Review tags: - Retrospectives patch: operationId: update-retrospective-review parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateRetrospectiveReviewRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/UpdateRetrospectiveReviewResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Update a Retrospective Review tags: - Retrospectives /retrospectives: get: operationId: list-retrospectives parameters: - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListRetrospectivesResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Retrospectives tags: - Retrospectives /retrospectives/{id}: get: operationId: get-retrospective parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetRetrospectiveResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get a Retrospective tags: - Retrospectives patch: operationId: update-retrospective parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateRetrospectiveRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/UpdateRetrospectiveResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Create an Incident Retrospective tags: - Retrospectives /retrospectives/{id}/comments: get: operationId: list-retrospective-comments parameters: - in: path name: id required: true schema: type: string - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListRetrospectiveCommentsResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Comments For a Retrospective tags: - Retrospectives post: operationId: create-retrospective-comment parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateRetrospectiveCommentRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/CreateRetrospectiveCommentResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Create a Retrospective Comment tags: - Retrospectives /retrospectives/{id}/reviews: get: operationId: list-retrospective-reviews parameters: - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListRetrospectiveReviewsResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Retrospective Reviews tags: - Retrospectives post: operationId: create-retrospective-review parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateRetrospectiveReviewRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/CreateRetrospectiveReviewResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Create a Retrospective Review tags: - Retrospectives /system_analysis/{id}: get: operationId: get-system-analysis parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetSystemAnalysisResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get System Analysis tags: - System Analysis /system_analysis/{id}/edges: get: operationId: list-system-analysis-edges parameters: - in: path name: id required: true schema: type: string - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListSystemAnalysisEdgesResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List edges in a system analysis tags: - System Analysis post: operationId: add-system-analysis-edge parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/AddSystemAnalysisEdgeRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/AddSystemAnalysisEdgeResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Add an edge to a system analysis tags: - System Analysis /system_analysis/{id}/nodes: get: operationId: list-system-analysis-nodes parameters: - in: path name: id required: true schema: type: string - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListSystemAnalysisNodesResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List nodes in a system analysis tags: - System Analysis post: operationId: add-system-analysis-node parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/AddSystemAnalysisNodeRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/AddSystemAnalysisNodeResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Add a node to a system analysis tags: - System Analysis /system_analysis_edges/{id}: delete: operationId: delete-system-analysis-edge parameters: - in: path name: id required: true schema: type: string responses: "204": description: No Content "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Delete an edge from a system analysis tags: - System Analysis get: operationId: get-system-analysis-edge parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetSystemAnalysisEdgeResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get an edge in a system analysis tags: - System Analysis patch: operationId: update-system-analysis-edge parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateSystemAnalysisEdgeRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/UpdateSystemAnalysisEdgeResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Update a system analysis edge tags: - System Analysis /system_analysis_nodes/{id}: delete: operationId: delete-system-analysis-node parameters: - in: path name: id required: true schema: type: string responses: "204": description: No Content "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Delete a node from a system analysis tags: - System Analysis get: operationId: get-system-analysis-node parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetSystemAnalysisNodeResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get a node in a system analysis tags: - System Analysis patch: operationId: update-system-analysis-node parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateSystemAnalysisNodeRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/UpdateSystemAnalysisNodeResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Update a system analysis node tags: - System Analysis /system_topology/entities: get: operationId: list-system-topology-entities parameters: - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean - explode: false in: query name: kind schema: items: type: string type: array - explode: false in: query name: provider schema: type: string - explode: false in: query name: providerSource schema: type: string - explode: false in: query name: subjectKind schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListSystemTopologyEntitiesResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List System Topology Entities tags: - SystemTopology /system_topology/entities/{id}: get: operationId: get-system-topology-entity parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetSystemTopologyEntityResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get System Topology Entity tags: - SystemTopology /system_topology/entities/{id}/neighborhood: get: operationId: get-system-topology-entity-neighborhood parameters: - in: path name: id required: true schema: type: string - explode: false in: query name: depth schema: default: 1 format: int64 maximum: 4 minimum: 1 type: integer - explode: false in: query name: relationshipKind schema: items: type: string type: array responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetSystemTopologyEntityNeighborhoodResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get System Topology Entity Neighborhood tags: - SystemTopology /system_topology/relationships: get: operationId: list-system-topology-relationships parameters: - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean - explode: false in: query name: kind schema: items: type: string type: array - explode: false in: query name: entityId schema: type: string - explode: false in: query name: sourceEntityId schema: type: string - explode: false in: query name: targetEntityId schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListSystemTopologyRelationshipsResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List System Topology Relationships tags: - SystemTopology /system_topology/snapshots: post: operationId: create-system-topology-snapshot requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateSystemTopologySnapshotRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/CreateSystemTopologySnapshotResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Create System Topology Snapshot tags: - SystemTopology /system_topology/snapshots/{id}: get: operationId: get-system-topology-snapshot parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetSystemTopologySnapshotResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get System Topology Snapshot tags: - SystemTopology /tasks: get: operationId: list-tasks parameters: - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean - explode: false in: query name: teamId schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListTasksResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Tasks tags: - Tasks post: operationId: create-task requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateTaskRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/CreateTaskResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Create a Task tags: - Tasks /tasks/{id}: delete: operationId: archive-task parameters: - in: path name: id required: true schema: type: string responses: "204": description: No Content "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Archive a Task tags: - Tasks get: operationId: get-task parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetTaskResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get Task tags: - Tasks patch: operationId: update-task parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateTaskRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/UpdateTaskResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Update a Task tags: - Tasks /team_memberships: get: operationId: list-team-memberships parameters: - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean - explode: false in: query name: teamId schema: type: string - explode: false in: query name: userId schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListTeamMembershipsResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Team Memberships tags: - Team Memberships post: operationId: create-team-membership requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateTeamMembershipRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/CreateTeamMembershipResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Create Team Membership tags: - Team Memberships /team_memberships/{id}: delete: operationId: delete-team-membership parameters: - in: path name: id required: true schema: type: string responses: "204": description: No Content "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Archive Team Membership tags: - Team Memberships patch: operationId: update-team-membership parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateTeamMembershipRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/UpdateTeamMembershipResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Update Team Membership tags: - Team Memberships /teams: get: operationId: list-teams parameters: - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListTeamsResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Teams tags: - Teams post: operationId: create-team requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateTeamRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/CreateTeamResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Create a Team tags: - Teams /teams/{id}: delete: operationId: archive-team parameters: - in: path name: id required: true schema: type: string responses: "204": description: No Content "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Archive a Team tags: - Teams get: operationId: get-team parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetTeamResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get a Team tags: - Teams patch: operationId: update-teams parameters: - in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateTeamRequestBody" required: true responses: "200": content: application/json: schema: $ref: "#/components/schemas/UpdateTeamResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Update a Team tags: - Teams /user_session: get: operationId: get-user-session responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetUserSessionResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get the current User Session tags: - User Session /user_session/notifications/{id}: delete: operationId: delete-user-notification parameters: - in: path name: id required: true schema: type: string responses: "204": description: No Content "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Delete a Notification for the Current User tags: - User Session /users: get: operationId: list-users parameters: - explode: false in: query name: limit schema: default: 10 format: int64 maximum: 50 minimum: 1 type: integer - explode: false in: query name: offset schema: default: 0 format: int64 minimum: 0 type: integer - explode: false in: query name: search schema: type: string - explode: false in: query name: archived schema: default: false type: boolean - explode: false in: query name: teamId schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/ListUsersResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: List Users tags: - Users /users/{id}: get: operationId: get-user parameters: - in: path name: id required: true schema: type: string responses: "200": content: application/json: schema: $ref: "#/components/schemas/GetUserResponseBody" description: OK "400": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Bad Request "401": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unauthorized "403": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Forbidden "404": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Not Found "422": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Unprocessable Entity "500": content: application/problem+json: schema: $ref: "#/components/schemas/ErrorModel" description: Internal Server Error summary: Get a User tags: - Users security: - app-cookie: [] - api-token: [] servers: - url: /v1