Ресурс

Incident Role

Manage incident roles for your project (Incident Commander, Responder, etc.). Add, edit, or remove roles.

Модель Incident Role

Свойства

Имя
_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
Имя
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)
Имя
roleIcon
Тип
Text
Описание
Icon for this incident role (e.g., User, Shield, etc.)
Имя
isPrimaryRole
Тип
Boolean
Описание
Is this the primary incident role? Primary roles like Incident Commander have special significance.
Имя
isDeleteable
Тип
Boolean
Описание
Can this role be deleted? Primary roles cannot be deleted.
Имя
canAssignMultipleUsers
Тип
Boolean
Описание
Can multiple users be assigned to this role? If false, only one user can be assigned.

GETorPOST/api/incident-role/get-list

Список

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

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

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

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

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

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

POST

/api/incident-role/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": "Incident Commander"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "3771b8c0-28fe-11f1-b591-3fdcef396aba",
      "name": "Incident Commander",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "description": "Primary decision maker during an incident",
      "color": "#3498db",
      "slug": "Example slug"
    },
    {
      "_id": "3771b8c1-28fe-11f1-b591-3fdcef396aba",
      "name": "Incident Commander",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "description": "Primary decision maker during an incident",
      "color": "#3498db",
      "slug": "Example slug"
    },
    {
      "_id": "3771b8c2-28fe-11f1-b591-3fdcef396aba",
      "name": "Incident Commander",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "description": "Primary decision maker during an incident",
      "color": "#3498db",
      "slug": "Example slug"
    }
  ]
}

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

Получить по ID

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

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

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

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

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

POST

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

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

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

Ответ

{
  "_id": "3771b8c0-28fe-11f1-b591-3fdcef396aba",
  "name": "Incident Commander",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "description": "Primary decision maker during an incident",
  "color": "#3498db",
  "slug": "Example slug"
}

POST/api/incident-role/count

Количество

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

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

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

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

POST

/api/incident-role/count

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "query": {
    "name": "Incident Commander"
  }
}

Ответ

{
  "count": 107
}

POST/api/incident-role

Создать Incident Role

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

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

POST

/api/incident-role

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "name": "Incident Commander",
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "description": "Primary decision maker during an incident",
    "color": "#3498db",
    "canAssignMultipleUsers": true
  }
}

Ответ

{
  "_id": "3771b8c0-28fe-11f1-b591-3fdcef396aba",
  "name": "Incident Commander",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "description": "Primary decision maker during an incident",
  "color": "#3498db",
  "slug": "Example slug"
}

PUT/api/incident-role/:id

Обновить по ID

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

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

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

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

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

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

PUT

/api/incident-role/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "name": "Incident Commander",
    "description": "Primary decision maker during an incident",
    "color": "#3498db"
  }
}

Ответ

{}

DELETE/api/incident-role/:id

Удалить по ID

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

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

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

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

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

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

DELETE

/api/incident-role/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

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

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

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

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

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

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

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

Project Owner
Project Admin
Project Member
Create Incident Role

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

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

Project Owner
Project Admin
Project Member
Edit Incident Role

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

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

Project Owner
Project Admin
Project Member
Delete Incident Role