Ресурс

Alert State Timeline

Change state of the alerts (Created to Acknowledged for example)

Модель Alert 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 Status200 Project in which this object belongs
Имя
alert
Тип
Alert
Описание
Relation to Alert in which this resource belongs
Имя
alertId
Тип
Object IDОбязательно
Описание
Relation to Alert 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)
Имя
alertState
Тип
Alert State
Описание
Alert State Relation. Which alert state does this alert change to?
Имя
alertStateId
Тип
Object IDОбязательно
Описание
Alert State ID Relation. Which alert state does this alert change to?
Имя
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?

GETorPOST/api/alert-state-timeline/get-list

Список

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

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

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

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

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

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

POST

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

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "alertId": true,
    "alertStateId": true,
    "projectId": true,
    "alert": true,
    "alertState": true
  },
  "query": {},
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "376cfdd3-28fe-11f1-b591-3fdcef396aba",
      "alertId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "alertStateId": "d4e5f6a7-b8c9-0123-def0-234567890123",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "alert": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "alertState": "d4e5f6a7-b8c9-0123-def0-234567890123"
    },
    {
      "_id": "376d24e0-28fe-11f1-b591-3fdcef396aba",
      "alertId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "alertStateId": "d4e5f6a7-b8c9-0123-def0-234567890123",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "alert": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "alertState": "d4e5f6a7-b8c9-0123-def0-234567890123"
    },
    {
      "_id": "376d24e1-28fe-11f1-b591-3fdcef396aba",
      "alertId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "alertStateId": "d4e5f6a7-b8c9-0123-def0-234567890123",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "alert": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "alertState": "d4e5f6a7-b8c9-0123-def0-234567890123"
    }
  ]
}

GETorPOST/api/alert-state-timeline/:id/get-item

Получить по ID

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

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

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

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

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

POST

/api/alert-state-timeline/:id/get-item

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "alertId": true,
    "alertStateId": true,
    "projectId": true,
    "alert": true,
    "alertState": true
  }
}

Ответ

{
  "_id": "376cfdd3-28fe-11f1-b591-3fdcef396aba",
  "alertId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "alertStateId": "d4e5f6a7-b8c9-0123-def0-234567890123",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "alert": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "alertState": "d4e5f6a7-b8c9-0123-def0-234567890123"
}

POST/api/alert-state-timeline/count

Количество

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

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

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

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

POST

/api/alert-state-timeline/count

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "query": {}
}

Ответ

{
  "count": 107
}

POST/api/alert-state-timeline

Создать Alert State Timeline

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

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

POST

/api/alert-state-timeline

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "alertId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "alertStateId": "d4e5f6a7-b8c9-0123-def0-234567890123",
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "alert": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "alertState": "d4e5f6a7-b8c9-0123-def0-234567890123"
  }
}

Ответ

{
  "_id": "376cfdd3-28fe-11f1-b591-3fdcef396aba",
  "alertId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "alertStateId": "d4e5f6a7-b8c9-0123-def0-234567890123",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "alert": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "alertState": "d4e5f6a7-b8c9-0123-def0-234567890123"
}

PUT/api/alert-state-timeline/:id

Обновить по ID

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

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

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

POST/api/alert-state-timeline/:id/update-item

GET/api/alert-state-timeline/:id/update-item

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

PUT

/api/alert-state-timeline/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "alertStateId": "d4e5f6a7-b8c9-0123-def0-234567890123",
    "alertState": "d4e5f6a7-b8c9-0123-def0-234567890123"
  }
}

Ответ

{}

DELETE/api/alert-state-timeline/:id

Удалить по ID

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

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

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

POST/api/alert-state-timeline/:id/delete-item

GET/api/alert-state-timeline/:id/delete-item

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

DELETE

/api/alert-state-timeline/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

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

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

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

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

Project Owner
Project Admin
Project Member
Read Alert State Timeline
Read All Project Resources

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

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

Project Owner
Project Admin
Project Member
Create Alert State Timeline

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

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

Project Owner
Project Admin
Project Member
Edit Alert State Timeline

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

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

Project Owner
Project Admin
Project Member
Delete Alert State Timeline