Ресурс

On-Call Duty Execution Log Timeline

Timeline events for on-call duty policy execution log.

Модель On-Call Duty Execution 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.
Имя
project
Тип
Project
Описание
Relation to Project Resource in which this object belongs
Имя
projectId
Тип
Object IDОбязательно
Описание
ID of your Status200 Project 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 Status200 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 Status200 Incident in which this object belongs
Имя
triggeredByAlert
Тип
Alert
Описание
Relation to Alert Resource in which this object belongs
Имя
triggeredByAlertId
Тип
Object ID
Описание
ID of your Status200 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 Status200 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 Status200 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 where this timeline event belongs.
Имя
onCallDutyPolicyEscalationRule
Тип
Escalation Rule
Описание
Relation to On-Call Policy Escalation Rule where this timeline event belongs.
Имя
onCallDutyPolicyEscalationRuleId
Тип
Object IDОбязательно
Описание
ID of your On-Call Policy Escalation Rule where this timeline event belongs.
Имя
alertSentToUser
Тип
User
Описание
Relation to User who we sent alert to.
Имя
userNotificationEventType
Тип
TextОбязательно
Описание
Type of event that triggered this on-call duty policy.
Имя
alertSentToUserId
Тип
Object ID
Описание
ID of the user who we sent alert to.
Имя
userBelongsToTeam
Тип
Team
Описание
Which team did the user belong to when the alert was sent?
Имя
userBelongsToTeamId
Тип
Object ID
Описание
Which team ID did the user belong to when the alert was sent?
Имя
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?
Имя
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
Описание
Имя
overridedByUser
Тип
User
Описание
Relation to User who overrode this alert
Имя
overridedByUserId
Тип
Object ID
Описание
User ID who overrode this alert

GETorPOST/api/on-call-duty-policy-execution-log-timeline/get-list

Список

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

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

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

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

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

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

POST

/api/on-call-duty-policy-execution-log-timeline/get-list?skip=0&limit=10

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

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

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "3776c1d0-28fe-11f1-b591-3fdcef396aba",
      "onCallDutyPolicyEscalationRuleId": "550e8400-e29b-41d4-a716-446655440000",
      "onCallDutyPolicyExecutionLogId": "550e8400-e29b-41d4-a716-446655440000",
      "onCallDutyPolicyId": "550e8400-e29b-41d4-a716-446655440000",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "status": "Example status"
    },
    {
      "_id": "3776c1d1-28fe-11f1-b591-3fdcef396aba",
      "onCallDutyPolicyEscalationRuleId": "550e8400-e29b-41d4-a716-446655440000",
      "onCallDutyPolicyExecutionLogId": "550e8400-e29b-41d4-a716-446655440000",
      "onCallDutyPolicyId": "550e8400-e29b-41d4-a716-446655440000",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "status": "Example status"
    },
    {
      "_id": "3776c1d2-28fe-11f1-b591-3fdcef396aba",
      "onCallDutyPolicyEscalationRuleId": "550e8400-e29b-41d4-a716-446655440000",
      "onCallDutyPolicyExecutionLogId": "550e8400-e29b-41d4-a716-446655440000",
      "onCallDutyPolicyId": "550e8400-e29b-41d4-a716-446655440000",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "status": "Example status"
    }
  ]
}

GETorPOST/api/on-call-duty-policy-execution-log-timeline/:id/get-item

Получить по ID

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

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

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

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

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

POST

/api/on-call-duty-policy-execution-log-timeline/:id/get-item

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

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

Ответ

{
  "_id": "3776c1d0-28fe-11f1-b591-3fdcef396aba",
  "onCallDutyPolicyEscalationRuleId": "550e8400-e29b-41d4-a716-446655440000",
  "onCallDutyPolicyExecutionLogId": "550e8400-e29b-41d4-a716-446655440000",
  "onCallDutyPolicyId": "550e8400-e29b-41d4-a716-446655440000",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "Example status"
}

POST/api/on-call-duty-policy-execution-log-timeline/count

Количество

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

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

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

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

POST

/api/on-call-duty-policy-execution-log-timeline/count

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

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

Ответ

{
  "count": 107
}

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

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

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

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

Project Owner
Project Admin
Project Member
Read On-Call Duty Policy Execution Log Timeline
Read All Project Resources

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

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

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

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

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

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

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

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

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