Ресурс

Incident State

Manage incident states for your project (Created, Acknowledged for example). Add / edit or remove states.

Модель Incident State

Свойства

Имя
_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
Имя
name
Тип
TextОбязательно
Описание
Any friendly name of this object
Имя
slug
Тип
SlugОбязательно
Описание
Friendly globally unique name for your object
Имя
description
Тип
Long Text
Описание
Friendly description that will help you remember
Имя
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)
Имя
color
Тип
ColorОбязательно
Описание
Color of this resource in Hex (#32a852 for example)
Имя
isCreatedState
Тип
Boolean
Описание
Is it the created state of the incident?
Имя
isAcknowledgedState
Тип
Boolean
Описание
Is it the acknowledged state of the incident?
Имя
isResolvedState
Тип
Boolean
Описание
Is it the resolved state of the incident?
Имя
order
Тип
Small Number
Описание
Order / Priority of this resource

GETorPOST/api/incident-state/get-list

Список

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

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

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

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

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

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

POST

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

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "name": true,
    "projectId": true,
    "description": true,
    "color": true,
    "slug": true
  },
  "query": {
    "name": "Acknowledged"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "37722df0-28fe-11f1-b591-3fdcef396aba",
      "name": "Acknowledged",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "description": "The incident has been acknowledged by the on-call engineer and is being investigated",
      "color": "#3498db",
      "slug": "Example slug"
    },
    {
      "_id": "37722df1-28fe-11f1-b591-3fdcef396aba",
      "name": "Acknowledged",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "description": "The incident has been acknowledged by the on-call engineer and is being investigated",
      "color": "#3498db",
      "slug": "Example slug"
    },
    {
      "_id": "37722df2-28fe-11f1-b591-3fdcef396aba",
      "name": "Acknowledged",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "description": "The incident has been acknowledged by the on-call engineer and is being investigated",
      "color": "#3498db",
      "slug": "Example slug"
    }
  ]
}

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

Получить по ID

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

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

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

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

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

POST

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

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "name": true,
    "projectId": true,
    "description": true,
    "color": true,
    "slug": true
  }
}

Ответ

{
  "_id": "37722df0-28fe-11f1-b591-3fdcef396aba",
  "name": "Acknowledged",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "description": "The incident has been acknowledged by the on-call engineer and is being investigated",
  "color": "#3498db",
  "slug": "Example slug"
}

POST/api/incident-state/count

Количество

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

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

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

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

POST

/api/incident-state/count

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "query": {
    "name": "Acknowledged"
  }
}

Ответ

{
  "count": 107
}

POST/api/incident-state

Создать Incident State

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

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

POST

/api/incident-state

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "name": "Acknowledged",
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "description": "The incident has been acknowledged by the on-call engineer and is being investigated",
    "color": "#3498db",
    "createdByUser": "Example created by user"
  }
}

Ответ

{
  "_id": "37722df0-28fe-11f1-b591-3fdcef396aba",
  "name": "Acknowledged",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "description": "The incident has been acknowledged by the on-call engineer and is being investigated",
  "color": "#3498db",
  "slug": "Example slug"
}

PUT/api/incident-state/:id

Обновить по ID

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

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

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

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

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

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

PUT

/api/incident-state/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "name": "Acknowledged",
    "description": "The incident has been acknowledged by the on-call engineer and is being investigated",
    "color": "#3498db"
  }
}

Ответ

{}

DELETE/api/incident-state/:id

Удалить по ID

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

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

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

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

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

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

DELETE

/api/incident-state/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

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

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

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

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

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

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

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

Project Owner
Project Admin
Project Member
Create Incident State

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

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

Project Owner
Project Admin
Project Member
Edit Incident State

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

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

Project Owner
Project Admin
Project Member
Delete Incident State