Status200
Ресурс

Incident Episode

Manage incident episodes (groups of related incidents) for your project

Модель Incident Episode

Свойства

  • Имя
    _id
    Тип
    Object ID
    Описание

    ID of this object

  • Имя
    createdAt
    Тип
    Date
    Описание

    Date and Time when the object was created.

  • Имя
    updatedAt
    Тип
    Date
    Описание

    Date and Time when the object was updated.

  • Имя
    project
    Тип
    Project
    Описание

    Relation to Project Resource in which this object belongs

  • Имя
    projectId
    Тип
    Object IDОбязательно
    Описание

    ID of your Project in which this object belongs

  • Имя
    title
    Тип
    Long TextОбязательно
    Описание

    Title of this incident episode

  • Имя
    description
    Тип
    Markdown
    Описание

    Description of this incident episode. This is in markdown format.

  • Имя
    episodeNumber
    Тип
    Number
    Описание

    Auto-incrementing episode number per project

  • Имя
    episodeNumberWithPrefix
    Тип
    Text
    Описание

    Episode number with prefix (e.g., 'IE-42' or '#42')

  • Имя
    currentIncidentState
    Тип
    Incident State
    Описание

    Current state of this episode. Is the episode acknowledged? or resolved?

  • Имя
    currentIncidentStateId
    Тип
    Object IDОбязательно
    Описание

    Current Incident State ID

  • Имя
    incidentSeverity
    Тип
    Incident Severity
    Описание

    High-water mark severity of this episode. Represents the highest severity among all member incidents.

  • Имя
    incidentSeverityId
    Тип
    Object ID
    Описание

    Incident Severity ID

  • Имя
    rootCause
    Тип
    Markdown
    Описание

    User-documented root cause of this episode

  • Имя
    lastIncidentAddedAt
    Тип
    Date
    Описание

    When the last incident was added to this episode

  • Имя
    resolvedAt
    Тип
    Date
    Описание

    When this episode was resolved

  • Имя
    allIncidentsResolvedAt
    Тип
    Date
    Описание

    When all incidents in this episode were first detected as resolved. Used for resolve delay calculation.

  • Имя
    assignedToUser
    Тип
    User
    Описание

    User who is assigned to this episode

  • Имя
    assignedToUserId
    Тип
    Object ID
    Описание

    User ID who is assigned to this episode

  • Имя
    assignedToTeam
    Тип
    Team
    Описание

    Team that is assigned to this episode

  • Имя
    assignedToTeamId
    Тип
    Object ID
    Описание

    Team ID that is assigned to this episode

  • Имя
    onCallDutyPolicies
    Тип
    On-Call Policy
    Описание

    List of on-call duty policies to execute for this episode.

  • Имя
    isOnCallPolicyExecuted
    Тип
    BooleanОбязательно
    Описание

    Whether the on-call policy has been executed for this episode

  • Имя
    incidentCount
    Тип
    NumberОбязательно
    Описание

    Denormalized count of incidents in this episode

  • Имя
    titleTemplate
    Тип
    Long Text
    Описание

    Template used to generate the episode title. Stored for dynamic variable updates.

  • Имя
    descriptionTemplate
    Тип
    Long Text
    Описание

    Template used to generate the episode description. Stored for dynamic variable updates.

  • Имя
    isManuallyCreated
    Тип
    BooleanОбязательно
    Описание

    Whether this episode was manually created vs auto-created by a rule

  • Имя
    labels
    Тип
    Label
    Описание

    Relation to Labels Array where this object is categorized in.

  • Имя
    createdByUser
    Тип
    User
    Описание

    Relation to User who created this object (if this object was created by a User)

  • Имя
    createdByUserId
    Тип
    Object ID
    Описание

    User ID who created this object (if this object was created by a User)

  • Имя
    isOwnerNotifiedOfEpisodeCreation
    Тип
    BooleanОбязательно
    Описание

    Are owners notified when this episode is created?

  • Имя
    groupingKey
    Тип
    Long Text
    Описание

    Key used for grouping incidents into this episode. Generated from groupByFields of the matching rule.

  • Имя
    incidentGroupingRule
    Тип
    Incident Grouping Rule
    Описание

    Relation to the Incident Grouping Rule that created this episode (if applicable)

  • Имя
    incidentGroupingRuleId
    Тип
    Object ID
    Описание

    ID of the Incident Grouping Rule that created this episode (if applicable)

  • Имя
    remediationNotes
    Тип
    Markdown
    Описание

    User-documented remediation steps and notes for this episode

  • Имя
    postmortemNote
    Тип
    Markdown
    Описание

    User-documented postmortem summary for this episode

  • Имя
    postUpdatesToWorkspaceChannels
    Тип
    JSON
    Описание

    Workspace channels to post episode updates to (e.g., Slack, Microsoft Teams)

  • Имя
    isVisibleOnStatusPage
    Тип
    BooleanОбязательно
    Описание

    Should this episode be visible on the status page?

  • Имя
    declaredAt
    Тип
    Date
    Описание

    When this episode was declared

  • Имя
    shouldStatusPageSubscribersBeNotifiedOnEpisodeCreated
    Тип
    Boolean
    Описание

    Should status page subscribers be notified when this episode is created?

  • Имя
    subscriberNotificationStatusMessage
    Тип
    Very Long Text
    Описание

    Status message for subscriber notifications - includes success messages, failure reasons, or skip reasons

GETorPOST/api/incident-episode/get-list

Список

Этот метод возвращает постраничный список ваших объектов «Incident Episode». По умолчанию на странице до десяти записей.

Необязательные query-параметры

  • limit
    число
    Сколько объектов вернуть. По умолчанию 10, максимум 100
  • skip
    число
    Сколько объектов пропустить (для пагинации)

Необязательное тело запроса

Запрос списка

POST
/api/incident-episode/get-list?skip=0&limit=10
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "currentIncidentStateId": true,
    "incidentCount": true,
    "isManuallyCreated": true,
    "isOnCallPolicyExecuted": true,
    "isOwnerNotifiedOfEpisodeCreation": true
  },
  "query": {
    "title": "Example title"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "376f20b0-28fe-11f1-b591-3fdcef396aba",
      "currentIncidentStateId": "550e8400-e29b-41d4-a716-446655440000",
      "incidentCount": 100,
      "isManuallyCreated": true,
      "isOnCallPolicyExecuted": true,
      "isOwnerNotifiedOfEpisodeCreation": true
    },
    {
      "_id": "376f20b1-28fe-11f1-b591-3fdcef396aba",
      "currentIncidentStateId": "550e8400-e29b-41d4-a716-446655440000",
      "incidentCount": 100,
      "isManuallyCreated": true,
      "isOnCallPolicyExecuted": true,
      "isOwnerNotifiedOfEpisodeCreation": true
    },
    {
      "_id": "376f20b2-28fe-11f1-b591-3fdcef396aba",
      "currentIncidentStateId": "550e8400-e29b-41d4-a716-446655440000",
      "incidentCount": 100,
      "isManuallyCreated": true,
      "isOnCallPolicyExecuted": true,
      "isOwnerNotifiedOfEpisodeCreation": true
    }
  ]
}
GETorPOST/api/incident-episode/:id/get-item

Получить по ID

Возвращает объект «Incident Episode» по идентификатору.

  • id
    строка
    ID объекта

Необязательное тело запроса

  • select
    По умолчанию возвращается только ID; для других полей используйте select. Подробнее: как выбирать поля.

Запрос одного объекта

POST
/api/incident-episode/:id/get-item
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "currentIncidentStateId": true,
    "incidentCount": true,
    "isManuallyCreated": true,
    "isOnCallPolicyExecuted": true,
    "isOwnerNotifiedOfEpisodeCreation": true
  }
}

Ответ

{
  "_id": "376f20b0-28fe-11f1-b591-3fdcef396aba",
  "currentIncidentStateId": "550e8400-e29b-41d4-a716-446655440000",
  "incidentCount": 100,
  "isManuallyCreated": true,
  "isOnCallPolicyExecuted": true,
  "isOwnerNotifiedOfEpisodeCreation": true
}
POST/api/incident-episode/count

Количество

Возвращает количество ваших объектов «Incident Episode».

Необязательное тело запроса

Запрос количества

POST
/api/incident-episode/count
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "query": {
    "title": "Example title"
  }
}

Ответ

{
  "count": 107
}
POST/api/incident-episode

Создать Incident Episode

Создаёт новый объект.

Запрос создания

POST
/api/incident-episode
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "currentIncidentStateId": "550e8400-e29b-41d4-a716-446655440000",
    "isManuallyCreated": true,
    "isVisibleOnStatusPage": true,
    "projectId": "550e8400-e29b-41d4-a716-446655440000",
    "title": "Example title"
  }
}

Ответ

{
  "_id": "376f20b0-28fe-11f1-b591-3fdcef396aba",
  "currentIncidentStateId": "550e8400-e29b-41d4-a716-446655440000",
  "incidentCount": 100,
  "isManuallyCreated": true,
  "isOnCallPolicyExecuted": true,
  "isOwnerNotifiedOfEpisodeCreation": true
}
PUT/api/incident-episode/:id

Обновить по ID

Обновляет объект по ID.

Альтернативные методы

Если клиент не поддерживает PUT, используйте POST или GET с теми же заголовками и телом:

POST/api/incident-episode/:id/update-item
GET/api/incident-episode/:id/update-item

Запрос обновления

PUT
/api/incident-episode/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "currentIncidentStateId": "550e8400-e29b-41d4-a716-446655440000",
    "isVisibleOnStatusPage": true,
    "title": "Example title"
  }
}

Ответ

{}
DELETE/api/incident-episode/:id

Удалить по ID

Удаляет объект по ID.

Альтернативные методы

Если клиент не поддерживает DELETE, используйте POST или GET с теми же заголовками и телом:

POST/api/incident-episode/:id/delete-item
GET/api/incident-episode/:id/delete-item

Запрос удаления

DELETE
/api/incident-episode/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

Права доступа

Для операций с ресурсом у ключа API должны быть права. При их отсутствии вернётся ответ 4xx.

Права на чтение

Нужны для чтения Incident Episode

  • Project Owner
  • Project Admin
  • Project Member
  • Read Incident Episode
  • Read All Project Resources

Права на создание

Нужны для создания Incident Episode

  • Project Owner
  • Project Admin
  • Project Member
  • Create Incident Episode

Права на обновление

Нужны для обновления Incident Episode

  • Project Owner
  • Project Admin
  • Project Member
  • Edit Incident Episode

Права на удаление

Нужны для удаления Incident Episode

  • Project Owner
  • Project Admin
  • Project Member
  • Delete Incident Episode