Ресурс

Incident Episode Role Member

Assign users with specific roles to incident episodes. These assignments propagate to all incidents in the episode.

Модель Incident Episode Role 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 Project in which this object belongs
Имя
user
Тип
User
Описание
User assigned to the episode with a specific role.
Имя
userId
Тип
Object IDОбязательно
Описание
ID of your User assigned to this episode
Имя
incidentEpisode
Тип
Incident Episode
Описание
Relation to Incident Episode Resource in which this object belongs
Имя
incidentEpisodeId
Тип
Object IDОбязательно
Описание
ID of your Incident Episode in which this object belongs
Имя
incidentRole
Тип
Incident Role
Описание
The role assigned to the user for this episode
Имя
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-episode-role-member/get-list

Список

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

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

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

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

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

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

POST

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

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "incidentEpisodeId": true,
    "incidentRoleId": true,
    "projectId": true,
    "userId": true,
    "_id": true
  },
  "query": {
    "notes": "Example notes"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "37700b10-28fe-11f1-b591-3fdcef396aba",
      "incidentEpisodeId": "550e8400-e29b-41d4-a716-446655440000",
      "incidentRoleId": "550e8400-e29b-41d4-a716-446655440000",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "userId": "550e8400-e29b-41d4-a716-446655440000"
    },
    {
      "_id": "37700b11-28fe-11f1-b591-3fdcef396aba",
      "incidentEpisodeId": "550e8400-e29b-41d4-a716-446655440000",
      "incidentRoleId": "550e8400-e29b-41d4-a716-446655440000",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "userId": "550e8400-e29b-41d4-a716-446655440000"
    },
    {
      "_id": "37700b12-28fe-11f1-b591-3fdcef396aba",
      "incidentEpisodeId": "550e8400-e29b-41d4-a716-446655440000",
      "incidentRoleId": "550e8400-e29b-41d4-a716-446655440000",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "userId": "550e8400-e29b-41d4-a716-446655440000"
    }
  ]
}

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

Получить по ID

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

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

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

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

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

POST

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

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "incidentEpisodeId": true,
    "incidentRoleId": true,
    "projectId": true,
    "userId": true,
    "_id": true
  }
}

Ответ

{
  "_id": "550e8400-e29b-41d4-a716-446655440000",
  "incidentEpisodeId": "550e8400-e29b-41d4-a716-446655440000",
  "incidentRoleId": "550e8400-e29b-41d4-a716-446655440000",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "userId": "550e8400-e29b-41d4-a716-446655440000"
}

POST/api/incident-episode-role-member/count

Количество

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

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

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

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

POST

/api/incident-episode-role-member/count

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "query": {
    "notes": "Example notes"
  }
}

Ответ

{
  "count": 107
}

POST/api/incident-episode-role-member

Создать Incident Episode Role Member

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

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

POST

/api/incident-episode-role-member

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

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

Ответ

{
  "_id": "550e8400-e29b-41d4-a716-446655440000",
  "incidentEpisodeId": "550e8400-e29b-41d4-a716-446655440000",
  "incidentRoleId": "550e8400-e29b-41d4-a716-446655440000",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "userId": "550e8400-e29b-41d4-a716-446655440000"
}

PUT/api/incident-episode-role-member/:id

Обновить по ID

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

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

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

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

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

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

PUT

/api/incident-episode-role-member/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "incidentRoleId": "550e8400-e29b-41d4-a716-446655440000",
    "incidentRole": "Example incident role",
    "notes": "Example notes"
  }
}

Ответ

{}

DELETE/api/incident-episode-role-member/:id

Удалить по ID

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

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

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

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

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

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

DELETE

/api/incident-episode-role-member/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

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

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

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

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

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

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

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

Project Owner
Project Admin
Project Member
Create Incident Episode Role Member

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

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

Project Owner
Project Admin
Project Member
Edit Incident Episode Role Member

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

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

Project Owner
Project Admin
Project Member
Delete Incident Episode Role Member