Ресурс

User On-Call Log Timeline

Timeline events for user on-call log.

Модель User On-Call Log Timeline

Свойства

Имя
_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
Имя
project
Тип
Project
Описание
Relation to Project Resource in which this object belongs
Имя
projectId
Тип
Object IDОбязательно
Описание
ID of your Project in which this object belongs
Имя
userOnCallLog
Тип
User Notification Log
Описание
Relation to User Notification Log Resource in which this object belongs
Имя
userNotificationLogId
Тип
Object IDОбязательно
Описание
ID of your User Notification Log in which this object belongs
Имя
userNotificationRule
Тип
Entity
Описание
Relation to User Notification Rule Resource in which this object belongs
Имя
userNotificationRuleId
Тип
Object IDОбязательно
Описание
ID of your User Notification Rule in which this object belongs
Имя
onCallDutyPolicy
Тип
On-Call Policy
Описание
Relation to on-call duty policy Resource in which this object belongs
Имя
onCallDutyPolicyId
Тип
Object IDОбязательно
Описание
ID of your on-call duty policy in which this object belongs
Имя
triggeredByIncident
Тип
Incident
Описание
Relation to Incident Resource in which this object belongs
Имя
triggeredByIncidentId
Тип
Object ID
Описание
ID of your Incident in which this object belongs
Имя
triggeredByAlert
Тип
Alert
Описание
Relation to Alert Resource in which this object belongs
Имя
triggeredByAlertId
Тип
Object ID
Описание
ID of your Alert in which this object belongs
Имя
triggeredByAlertEpisode
Тип
Alert Episode
Описание
Relation to Alert Episode Resource in which this object belongs
Имя
triggeredByAlertEpisodeId
Тип
Object ID
Описание
ID of your Alert Episode in which this object belongs
Имя
triggeredByIncidentEpisode
Тип
Incident Episode
Описание
Relation to Incident Episode Resource in which this object belongs
Имя
triggeredByIncidentEpisodeId
Тип
Object ID
Описание
ID of your Incident Episode in which this object belongs
Имя
onCallDutyPolicyExecutionLog
Тип
On-Call Duty Execution Log
Описание
Relation to On-Call Policy Execution Log where this timeline event belongs.
Имя
onCallDutyPolicyExecutionLogId
Тип
Object IDОбязательно
Описание
ID of your On-Call Policy Execution Log Timeline where this timeline event belongs.
Имя
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.
Имя
onCallDutyPolicyEscalationRule
Тип
Escalation Rule
Описание
Relation to On-Call Policy Escalation Rule where this timeline event belongs.
Имя
userNotificationEventType
Тип
TextОбязательно
Описание
Notification Event Type of this execution
Имя
onCallDutyPolicyEscalationRuleId
Тип
Object IDОбязательно
Описание
ID of your On-Call Policy Escalation Rule where this timeline event belongs.
Имя
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?
Имя
statusMessage
Тип
Long TextОбязательно
Описание
Status message of this execution timeline event
Имя
status
Тип
TextОбязательно
Описание
Status of this execution timeline event
Имя
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)
Имя
isAcknowledged
Тип
Boolean
Описание
Имя
acknowledgedAt
Тип
Date
Описание
Имя
userCall
Тип
Entity
Описание
Relation to User Call Resource in which this object belongs
Имя
userCallId
Тип
Object ID
Описание
ID of User Call in which this object belongs
Имя
userSms
Тип
Entity
Описание
Relation to User SMS Resource in which this object belongs
Имя
userSmsId
Тип
Object ID
Описание
ID of User SMS in which this object belongs
Имя
userWhatsApp
Тип
Entity
Описание
Relation to User WhatsApp Resource in which this object belongs
Имя
userWhatsAppId
Тип
Object ID
Описание
ID of User WhatsApp in which this object belongs
Имя
userEmail
Тип
Entity
Описание
Relation to User Email Resource in which this object belongs
Имя
userEmailId
Тип
Object ID
Описание
ID of User Email in which this object belongs
Имя
userPush
Тип
Entity
Описание
Relation to User Push Resource in which this object belongs
Имя
userPushId
Тип
Object ID
Описание
ID of User Push in which this object belongs

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

Список

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

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

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

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

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

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

POST

/api/user-notification-log-timeline/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": "Example status"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "377f4d50-28fe-11f1-b591-3fdcef396aba",
      "onCallDutyPolicyEscalationRuleId": "550e8400-e29b-41d4-a716-446655440000",
      "onCallDutyPolicyExecutionLogId": "550e8400-e29b-41d4-a716-446655440000",
      "onCallDutyPolicyExecutionLogTimelineId": "550e8400-e29b-41d4-a716-446655440000",
      "onCallDutyPolicyId": "550e8400-e29b-41d4-a716-446655440000",
      "projectId": "550e8400-e29b-41d4-a716-446655440000"
    },
    {
      "_id": "377f4d51-28fe-11f1-b591-3fdcef396aba",
      "onCallDutyPolicyEscalationRuleId": "550e8400-e29b-41d4-a716-446655440000",
      "onCallDutyPolicyExecutionLogId": "550e8400-e29b-41d4-a716-446655440000",
      "onCallDutyPolicyExecutionLogTimelineId": "550e8400-e29b-41d4-a716-446655440000",
      "onCallDutyPolicyId": "550e8400-e29b-41d4-a716-446655440000",
      "projectId": "550e8400-e29b-41d4-a716-446655440000"
    },
    {
      "_id": "377f4d52-28fe-11f1-b591-3fdcef396aba",
      "onCallDutyPolicyEscalationRuleId": "550e8400-e29b-41d4-a716-446655440000",
      "onCallDutyPolicyExecutionLogId": "550e8400-e29b-41d4-a716-446655440000",
      "onCallDutyPolicyExecutionLogTimelineId": "550e8400-e29b-41d4-a716-446655440000",
      "onCallDutyPolicyId": "550e8400-e29b-41d4-a716-446655440000",
      "projectId": "550e8400-e29b-41d4-a716-446655440000"
    }
  ]
}

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

Получить по ID

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

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

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

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

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

POST

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

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

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

Ответ

{
  "_id": "377f4d50-28fe-11f1-b591-3fdcef396aba",
  "onCallDutyPolicyEscalationRuleId": "550e8400-e29b-41d4-a716-446655440000",
  "onCallDutyPolicyExecutionLogId": "550e8400-e29b-41d4-a716-446655440000",
  "onCallDutyPolicyExecutionLogTimelineId": "550e8400-e29b-41d4-a716-446655440000",
  "onCallDutyPolicyId": "550e8400-e29b-41d4-a716-446655440000",
  "projectId": "550e8400-e29b-41d4-a716-446655440000"
}

POST/api/user-notification-log-timeline/count

Количество

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

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

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

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

POST

/api/user-notification-log-timeline/count

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "query": {
    "status": "Example status"
  }
}

Ответ

{
  "count": 107
}

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

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

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

Нужны для чтения User On-Call Log Timeline

Logged in User

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

Нужны для создания User On-Call Log Timeline

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

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

Нужны для обновления User On-Call Log Timeline

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

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

Нужны для удаления User On-Call Log Timeline

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