Ресурс

Alert Episode Member

Link between alerts and episodes

Модель Alert Episode 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
Имя
alertEpisode
Тип
Alert Episode
Описание
Relation to Alert Episode that this alert belongs to
Имя
alertEpisodeId
Тип
Object IDОбязательно
Описание
ID of the Alert Episode that this alert belongs to
Имя
alert
Тип
Alert
Описание
Relation to Alert that is a member of this episode
Имя
alertId
Тип
Object IDОбязательно
Описание
ID of the Alert that is a member of this episode
Имя
addedAt
Тип
Date
Описание
When this alert was added to the episode
Имя
addedBy
Тип
TextОбязательно
Описание
How this alert was added to the episode (rule, manual, or api)
Имя
addedByUser
Тип
User
Описание
User who manually added this alert to the episode (if applicable)
Имя
addedByUserId
Тип
Object ID
Описание
User ID who manually added this alert to the episode
Имя
matchedRule
Тип
Alert Grouping Rule
Описание
The grouping rule that matched this alert (if applicable)
Имя
matchedRuleId
Тип
Object ID
Описание
ID of the grouping rule that matched this alert
Имя
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/alert-episode-member/get-list

Список

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

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

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

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

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

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

POST

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

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "addedBy": true,
    "alertEpisodeId": true,
    "alertId": true,
    "projectId": true,
    "_id": true
  },
  "query": {
    "addedBy": "Example added by"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "376b7730-28fe-11f1-b591-3fdcef396aba",
      "addedBy": "Example added by",
      "alertEpisodeId": "550e8400-e29b-41d4-a716-446655440000",
      "alertId": "550e8400-e29b-41d4-a716-446655440000",
      "projectId": "550e8400-e29b-41d4-a716-446655440000"
    },
    {
      "_id": "376b7731-28fe-11f1-b591-3fdcef396aba",
      "addedBy": "Example added by",
      "alertEpisodeId": "550e8400-e29b-41d4-a716-446655440000",
      "alertId": "550e8400-e29b-41d4-a716-446655440000",
      "projectId": "550e8400-e29b-41d4-a716-446655440000"
    },
    {
      "_id": "376b7732-28fe-11f1-b591-3fdcef396aba",
      "addedBy": "Example added by",
      "alertEpisodeId": "550e8400-e29b-41d4-a716-446655440000",
      "alertId": "550e8400-e29b-41d4-a716-446655440000",
      "projectId": "550e8400-e29b-41d4-a716-446655440000"
    }
  ]
}

GETorPOST/api/alert-episode-member/:id/get-item

Получить по ID

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

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

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

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

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

POST

/api/alert-episode-member/:id/get-item

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "addedBy": true,
    "alertEpisodeId": true,
    "alertId": true,
    "projectId": true,
    "_id": true
  }
}

Ответ

{
  "_id": "550e8400-e29b-41d4-a716-446655440000",
  "addedBy": "Example added by",
  "alertEpisodeId": "550e8400-e29b-41d4-a716-446655440000",
  "alertId": "550e8400-e29b-41d4-a716-446655440000",
  "projectId": "550e8400-e29b-41d4-a716-446655440000"
}

POST/api/alert-episode-member/count

Количество

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

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

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

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

POST

/api/alert-episode-member/count

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "query": {
    "addedBy": "Example added by"
  }
}

Ответ

{
  "count": 107
}

POST/api/alert-episode-member

Создать Alert Episode Member

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

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

POST

/api/alert-episode-member

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "addedBy": "Example added by",
    "alertEpisodeId": "550e8400-e29b-41d4-a716-446655440000",
    "alertId": "550e8400-e29b-41d4-a716-446655440000",
    "projectId": "550e8400-e29b-41d4-a716-446655440000",
    "addedAt": "2024-01-15T10:30:00.000Z"
  }
}

Ответ

{
  "_id": "550e8400-e29b-41d4-a716-446655440000",
  "addedBy": "Example added by",
  "alertEpisodeId": "550e8400-e29b-41d4-a716-446655440000",
  "alertId": "550e8400-e29b-41d4-a716-446655440000",
  "projectId": "550e8400-e29b-41d4-a716-446655440000"
}

PUT/api/alert-episode-member/:id

Обновить по ID

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

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

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

POST/api/alert-episode-member/:id/update-item

GET/api/alert-episode-member/:id/update-item

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

PUT

/api/alert-episode-member/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {}
}

Ответ

{}

DELETE/api/alert-episode-member/:id

Удалить по ID

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

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

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

POST/api/alert-episode-member/:id/delete-item

GET/api/alert-episode-member/:id/delete-item

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

DELETE

/api/alert-episode-member/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

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

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

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

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

Project Owner
Project Admin
Project Member
Read Alert Episode Member
Read All Project Resources

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

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

Project Owner
Project Admin
Project Member
Create Alert Episode Member

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

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

Project Owner
Project Admin
Project Member
Edit Alert Episode Member

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

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

Project Owner
Project Admin
Project Member
Delete Alert Episode Member