Incident Episode

Get Incident Episode

Endpoint to retrieve a single Incident Episode by ID

post/incident-episode/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the Incident Episode to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "episodeNumberWithPrefix": true
  }
}

Response

Successful response

Example response

{
  "data": {
    "_id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "updatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "deletedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "version": 42,
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "title": "This is an example of longer text content that might be stored in this field.",
    "description": "# Heading\n\nThis is **markdown** content",
    "episodeNumber": 42,
    "episodeNumberWithPrefix": "Example short text",
    "currentIncidentStateId": "123e4567-e89b-12d3-a456-426614174000",
    "incidentSeverityId": "123e4567-e89b-12d3-a456-426614174000",
    "rootCause": "# Heading\n\nThis is **markdown** content",
    "lastIncidentAddedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "resolvedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "allIncidentsResolvedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "firstPagedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "assignedToUserId": "123e4567-e89b-12d3-a456-426614174000",
    "assignedToTeamId": "123e4567-e89b-12d3-a456-426614174000",
    "onCallDutyPolicies": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "isOnCallPolicyExecuted": true,
    "incidentCount": 42,
    "titleTemplate": "This is an example of longer text content that might be stored in this field.",
    "descriptionTemplate": "This is an example of longer text content that might be stored in this field.",
    "isManuallyCreated": true,
    "labels": [
      {
        "_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
      }
    ],
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
    "isOwnerNotifiedOfEpisodeCreation": true,
    "groupingKey": "This is an example of longer text content that might be stored in this field.",
    "incidentGroupingRuleId": "123e4567-e89b-12d3-a456-426614174000",
    "remediationNotes": "# Heading\n\nThis is **markdown** content",
    "postmortemNote": "# Heading\n\nThis is **markdown** content",
    "postUpdatesToWorkspaceChannels": {
      "key": "value",
      "nested": {
        "data": 123
      }
    },
    "isVisibleOnStatusPage": true,
    "declaredAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "shouldStatusPageSubscribersBeNotifiedOnEpisodeCreated": true,
    "subscriberNotificationStatusOnEpisodeCreated": "Skipped",
    "subscriberNotificationStatusMessage": "This is an example of very long text content that might be stored in this field. It can contain a lot of information, such as detailed descriptions, comments, or any other lengthy text data that needs to be stored in the database.",
    "isPrivate": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.