Ресурс

User Notification Log

Log events for user notifications

Модель User Notification Log

Свойства

Имя
_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.
Имя
user
Тип
User
Описание
Relation to User who this log belongs to
Имя
userId
Тип
Object ID
Описание
User ID who this log belongs to
Имя
userBelongsToTeam
Тип
Team
Описание
Which team did the user belong to when the alert was sent?
Имя
userBelongsToTeamId
Тип
Object ID
Описание
Which team did the user belong to when the alert was sent?
Имя
project
Тип
Project
Описание
Relation to Project Resource in which this object belongs
Имя
projectId
Тип
Object IDОбязательно
Описание
ID of your Project in which this object belongs
Имя
onCallDutyPolicy
Тип
On-Call Policy
Описание
Relation to On-Call Policy which belongs to this execution log event.
Имя
onCallDutyPolicyId
Тип
Object IDОбязательно
Описание
ID of your On-Call Policy which belongs to this execution log event.
Имя
onCallDutyPolicyExecutionLog
Тип
On-Call Duty Execution Log
Описание
Relation to On-Call Policy Execution Log which belongs to this execution log event.
Имя
onCallDutyPolicyExecutionLogId
Тип
Object IDОбязательно
Описание
ID of your On-Call Policy execution log which belongs to this log event.
Имя
onCallDutyPolicyEscalationRule
Тип
Escalation Rule
Описание
Relation to On-Call Policy Escalation Rule which belongs to this execution log event.
Имя
onCallDutyPolicyEscalationRuleId
Тип
Object IDОбязательно
Описание
ID of your On-Call Policy Escalation Rule which belongs to this log event.
Имя
triggeredByIncident
Тип
Incident
Описание
Relation to Incident which triggered this on-call duty policy.
Имя
triggeredByIncidentId
Тип
Object ID
Описание
ID of the incident which triggered this on-call escalation policy.
Имя
triggeredByAlert
Тип
Alert
Описание
Relation to Alert which triggered this on-call duty policy.
Имя
triggeredByAlertId
Тип
Object ID
Описание
ID of the Alert which triggered this on-call escalation policy.
Имя
triggeredByAlertEpisode
Тип
Alert Episode
Описание
Relation to Alert Episode which triggered this on-call duty policy.
Имя
triggeredByAlertEpisodeId
Тип
Object ID
Описание
ID of the Alert Episode which triggered this on-call escalation policy.
Имя
triggeredByIncidentEpisode
Тип
Incident Episode
Описание
Relation to Incident Episode which triggered this on-call duty policy.
Имя
triggeredByIncidentEpisodeId
Тип
Object ID
Описание
ID of the Incident Episode which triggered this on-call escalation policy.
Имя
status
Тип
TextОбязательно
Описание
Status of this execution
Имя
userNotificationEventType
Тип
TextОбязательно
Описание
Notification Event Type of this execution
Имя
onCallDutyPolicyExecutionLogTimeline
Тип
On-Call Duty Execution Log Timeline
Описание
Relation to On-Call Policy Execution Log Timeline where this timeline event belongs.
Имя
onCallDutyPolicyExecutionLogTimelineId
Тип
Object IDОбязательно
Описание
ID of your On-Call Policy Execution Log where this timeline event belongs.
Имя
statusMessage
Тип
Long TextОбязательно
Описание
Status message of this execution
Имя
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)
Имя
acknowledgedByUserId
Тип
Object ID
Описание
User ID who acknowledged this object (if this object was acknowledged by a User)
Имя
acknowledgedAt
Тип
Date
Описание
Имя
onCallDutySchedule
Тип
On-Call Policy Schedule
Описание
Which schedule did the user belong to when the alert was sent?
Имя
onCallDutyScheduleId
Тип
Object ID
Описание
Which schedule ID did the user belong to when the alert was sent?
Имя
overridedByUser
Тип
User
Описание
Relation to User who overrode this alert
Имя
overridedByUserId
Тип
Object ID
Описание
User ID who overrode this alert

GETorPOST/api/user-notification-log/get-list

Список

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

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

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

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

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

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

POST

/api/user-notification-log/get-list?skip=0&limit=10

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "onCallDutyPolicyEscalationRuleId": true,
    "onCallDutyPolicyExecutionLogId": true,
    "onCallDutyPolicyExecutionLogTimelineId": true,
    "onCallDutyPolicyId": true,
    "projectId": true
  },
  "query": {
    "status": "Success"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "377f2640-28fe-11f1-b591-3fdcef396aba",
      "onCallDutyPolicyEscalationRuleId": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "onCallDutyPolicyExecutionLogId": "0f1a2b3c-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
      "onCallDutyPolicyExecutionLogTimelineId": "4d5e6f7a-8b9c-0d1e-2f3a-4b5c6d7e8f9a",
      "onCallDutyPolicyId": "9e1f2a3b-4c5d-6e7f-8a9b-0c1d2e3f4a5b",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e"
    },
    {
      "_id": "377f2641-28fe-11f1-b591-3fdcef396aba",
      "onCallDutyPolicyEscalationRuleId": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "onCallDutyPolicyExecutionLogId": "0f1a2b3c-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
      "onCallDutyPolicyExecutionLogTimelineId": "4d5e6f7a-8b9c-0d1e-2f3a-4b5c6d7e8f9a",
      "onCallDutyPolicyId": "9e1f2a3b-4c5d-6e7f-8a9b-0c1d2e3f4a5b",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e"
    },
    {
      "_id": "377f2642-28fe-11f1-b591-3fdcef396aba",
      "onCallDutyPolicyEscalationRuleId": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "onCallDutyPolicyExecutionLogId": "0f1a2b3c-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
      "onCallDutyPolicyExecutionLogTimelineId": "4d5e6f7a-8b9c-0d1e-2f3a-4b5c6d7e8f9a",
      "onCallDutyPolicyId": "9e1f2a3b-4c5d-6e7f-8a9b-0c1d2e3f4a5b",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e"
    }
  ]
}

GETorPOST/api/user-notification-log/:id/get-item

Получить по ID

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

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

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

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

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

POST

/api/user-notification-log/:id/get-item

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "onCallDutyPolicyEscalationRuleId": true,
    "onCallDutyPolicyExecutionLogId": true,
    "onCallDutyPolicyExecutionLogTimelineId": true,
    "onCallDutyPolicyId": true,
    "projectId": true
  }
}

Ответ

{
  "_id": "377f2640-28fe-11f1-b591-3fdcef396aba",
  "onCallDutyPolicyEscalationRuleId": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
  "onCallDutyPolicyExecutionLogId": "0f1a2b3c-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
  "onCallDutyPolicyExecutionLogTimelineId": "4d5e6f7a-8b9c-0d1e-2f3a-4b5c6d7e8f9a",
  "onCallDutyPolicyId": "9e1f2a3b-4c5d-6e7f-8a9b-0c1d2e3f4a5b",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e"
}

POST/api/user-notification-log/count

Количество

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

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

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

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

POST

/api/user-notification-log/count

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "query": {
    "status": "Success"
  }
}

Ответ

{
  "count": 107
}

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

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

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

Нужны для чтения User Notification Log

Logged in User

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

Нужны для создания User Notification Log

Ресурс нельзя создать через API

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

Нужны для обновления User Notification Log

Ресурс нельзя обновить через API

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

Нужны для удаления User Notification Log

Ресурс нельзя удалить через API