Ресурс

Incident Member

Assign users with specific roles to incidents.

Модель Incident Member

Свойства

Имя
_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
Имя
user
Тип
User
Описание
User assigned to the incident with a specific role.
Имя
userId
Тип
Object IDОбязательно
Описание
ID of your Status200 User in which this object belongs
Имя
incident
Тип
Incident
Описание
Relation to Incident Resource in which this object belongs
Имя
incidentId
Тип
Object IDОбязательно
Описание
ID of your Status200 Incident in which this object belongs
Имя
incidentRole
Тип
Incident Role
Описание
The role assigned to the user for this incident
Имя
incidentRoleId
Тип
Object IDОбязательно
Описание
ID of the Incident Role assigned to this user
Имя
notes
Тип
Long Text
Описание
Assignment context or notes
Имя
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)

GETorPOST/api/incident-member/get-list

Список

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

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

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

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

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

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

POST

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

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "incidentId": true,
    "incidentRoleId": true,
    "projectId": true,
    "userId": true,
    "createdByUser": true
  },
  "query": {
    "notes": "Primary responder for this incident"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "37711c80-28fe-11f1-b591-3fdcef396aba",
      "incidentId": "f6a7b8c9-d0e1-2345-fabc-456789012345",
      "incidentRoleId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "userId": "e5f6a7b8-c9d0-1234-efab-345678901234",
      "createdByUser": "c3d4e5f6-a7b8-9012-cdef-123456789012"
    },
    {
      "_id": "37711c81-28fe-11f1-b591-3fdcef396aba",
      "incidentId": "f6a7b8c9-d0e1-2345-fabc-456789012345",
      "incidentRoleId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "userId": "e5f6a7b8-c9d0-1234-efab-345678901234",
      "createdByUser": "c3d4e5f6-a7b8-9012-cdef-123456789012"
    },
    {
      "_id": "37711c82-28fe-11f1-b591-3fdcef396aba",
      "incidentId": "f6a7b8c9-d0e1-2345-fabc-456789012345",
      "incidentRoleId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "userId": "e5f6a7b8-c9d0-1234-efab-345678901234",
      "createdByUser": "c3d4e5f6-a7b8-9012-cdef-123456789012"
    }
  ]
}

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

Получить по ID

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

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

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

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

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

POST

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

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "incidentId": true,
    "incidentRoleId": true,
    "projectId": true,
    "userId": true,
    "createdByUser": true
  }
}

Ответ

{
  "_id": "37711c80-28fe-11f1-b591-3fdcef396aba",
  "incidentId": "f6a7b8c9-d0e1-2345-fabc-456789012345",
  "incidentRoleId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "userId": "e5f6a7b8-c9d0-1234-efab-345678901234",
  "createdByUser": "c3d4e5f6-a7b8-9012-cdef-123456789012"
}

POST/api/incident-member/count

Количество

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

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

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

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

POST

/api/incident-member/count

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "query": {
    "notes": "Primary responder for this incident"
  }
}

Ответ

{
  "count": 107
}

POST/api/incident-member

Создать Incident Member

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

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

POST

/api/incident-member

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "incidentId": "f6a7b8c9-d0e1-2345-fabc-456789012345",
    "incidentRoleId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "userId": "e5f6a7b8-c9d0-1234-efab-345678901234",
    "createdByUser": "c3d4e5f6-a7b8-9012-cdef-123456789012"
  }
}

Ответ

{
  "_id": "37711c80-28fe-11f1-b591-3fdcef396aba",
  "incidentId": "f6a7b8c9-d0e1-2345-fabc-456789012345",
  "incidentRoleId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "userId": "e5f6a7b8-c9d0-1234-efab-345678901234",
  "createdByUser": "c3d4e5f6-a7b8-9012-cdef-123456789012"
}

PUT/api/incident-member/:id

Обновить по ID

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

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

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

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

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

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

PUT

/api/incident-member/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "incidentRoleId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "incidentRole": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "notes": "Primary responder for this incident"
  }
}

Ответ

{}

DELETE/api/incident-member/:id

Удалить по ID

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

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

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

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

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

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

DELETE

/api/incident-member/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

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

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

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

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

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

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

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

Project Owner
Project Admin
Project Member
Create Incident Member

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

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

Project Owner
Project Admin
Project Member
Edit Incident Member

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

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

Project Owner
Project Admin
Project Member
Delete Incident Member