Ресурс

Incident Episode State Timeline

Change state of the incident episodes (Created to Acknowledged for example)

Модель Incident Episode State Timeline

Свойства

Имя
_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
Имя
incidentEpisode
Тип
Incident Episode
Описание
Relation to Incident Episode in which this resource belongs
Имя
incidentEpisodeId
Тип
Object IDОбязательно
Описание
Relation to Incident Episode ID in which this resource belongs
Имя
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)
Имя
incidentState
Тип
Incident State
Описание
Incident State Relation. Which incident state does this episode change to?
Имя
incidentStateId
Тип
Object IDОбязательно
Описание
Incident State ID Relation. Which incident state does this episode change to?
Имя
isOwnerNotified
Тип
BooleanОбязательно
Описание
Are owners notified of state change?
Имя
stateChangeLog
Тип
JSON
Описание
Имя
rootCause
Тип
Markdown
Описание
What is the root cause of this status change?
Имя
endsAt
Тип
Date
Описание
When did this status change end?
Имя
startsAt
Тип
Date
Описание
When did this status change?
Имя
shouldStatusPageSubscribersBeNotified
Тип
Boolean
Описание
Should status page subscribers be notified about this state change?
Имя
subscriberNotificationStatusMessage
Тип
Very Long Text
Описание
Status message for subscriber notifications - includes success messages, failure reasons, or skip reasons

GETorPOST/api/incident-episode-state-timeline/get-list

Список

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

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

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

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

query
Чтобы фильтровать Incident Episode State Timeline, укажите запрос здесь. Подробнее: написание запросов.
select
По умолчанию возвращается только ID; для других полей используйте select. Подробнее: как выбирать поля.
sort
По умолчанию сортировка по дате создания. Порядок можно изменить — см. раздел «Сортировка» в типах данных.

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

POST

/api/incident-episode-state-timeline/get-list?skip=0&limit=10

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "incidentEpisodeId": true,
    "incidentStateId": true,
    "isOwnerNotified": true,
    "projectId": true,
    "_id": true
  },
  "query": {
    "subscriberNotificationStatusMessage": "Example subscriber notification status message"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "37703220-28fe-11f1-b591-3fdcef396aba",
      "incidentEpisodeId": "550e8400-e29b-41d4-a716-446655440000",
      "incidentStateId": "550e8400-e29b-41d4-a716-446655440000",
      "isOwnerNotified": true,
      "projectId": "550e8400-e29b-41d4-a716-446655440000"
    },
    {
      "_id": "37703221-28fe-11f1-b591-3fdcef396aba",
      "incidentEpisodeId": "550e8400-e29b-41d4-a716-446655440000",
      "incidentStateId": "550e8400-e29b-41d4-a716-446655440000",
      "isOwnerNotified": true,
      "projectId": "550e8400-e29b-41d4-a716-446655440000"
    },
    {
      "_id": "37703222-28fe-11f1-b591-3fdcef396aba",
      "incidentEpisodeId": "550e8400-e29b-41d4-a716-446655440000",
      "incidentStateId": "550e8400-e29b-41d4-a716-446655440000",
      "isOwnerNotified": true,
      "projectId": "550e8400-e29b-41d4-a716-446655440000"
    }
  ]
}

GETorPOST/api/incident-episode-state-timeline/:id/get-item

Получить по ID

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

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

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

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

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

POST

/api/incident-episode-state-timeline/:id/get-item

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "incidentEpisodeId": true,
    "incidentStateId": true,
    "isOwnerNotified": true,
    "projectId": true,
    "_id": true
  }
}

Ответ

{
  "_id": "550e8400-e29b-41d4-a716-446655440000",
  "incidentEpisodeId": "550e8400-e29b-41d4-a716-446655440000",
  "incidentStateId": "550e8400-e29b-41d4-a716-446655440000",
  "isOwnerNotified": true,
  "projectId": "550e8400-e29b-41d4-a716-446655440000"
}

POST/api/incident-episode-state-timeline/count

Количество

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

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

query
Чтобы фильтровать Incident Episode State Timeline, укажите запрос здесь. Подробнее: написание запросов.

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

POST

/api/incident-episode-state-timeline/count

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "query": {
    "subscriberNotificationStatusMessage": "Example subscriber notification status message"
  }
}

Ответ

{
  "count": 107
}

POST/api/incident-episode-state-timeline

Создать Incident Episode State Timeline

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

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

POST

/api/incident-episode-state-timeline

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "incidentEpisodeId": "550e8400-e29b-41d4-a716-446655440000",
    "incidentStateId": "550e8400-e29b-41d4-a716-446655440000",
    "projectId": "550e8400-e29b-41d4-a716-446655440000",
    "createdByUser": "Example created by user",
    "createdByUserId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Ответ

{
  "_id": "550e8400-e29b-41d4-a716-446655440000",
  "incidentEpisodeId": "550e8400-e29b-41d4-a716-446655440000",
  "incidentStateId": "550e8400-e29b-41d4-a716-446655440000",
  "isOwnerNotified": true,
  "projectId": "550e8400-e29b-41d4-a716-446655440000"
}

PUT/api/incident-episode-state-timeline/:id

Обновить по ID

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

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

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

POST/api/incident-episode-state-timeline/:id/update-item

GET/api/incident-episode-state-timeline/:id/update-item

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

PUT

/api/incident-episode-state-timeline/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "incidentStateId": "550e8400-e29b-41d4-a716-446655440000",
    "incidentState": "Example incident state"
  }
}

Ответ

{}

DELETE/api/incident-episode-state-timeline/:id

Удалить по ID

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

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

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

POST/api/incident-episode-state-timeline/:id/delete-item

GET/api/incident-episode-state-timeline/:id/delete-item

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

DELETE

/api/incident-episode-state-timeline/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

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

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

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

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

Project Owner
Project Admin
Project Member
Read Incident Episode State Timeline
Read All Project Resources

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

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

Project Owner
Project Admin
Project Member
Create Incident Episode State Timeline

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

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

Project Owner
Project Admin
Project Member
Edit Incident Episode State Timeline

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

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

Project Owner
Project Admin
Project Member
Delete Incident Episode State Timeline