Status200
Ресурс

On-Call Duty Execution Log

Logs for on-call duty policy execution.

Модель On-Call Duty Execution 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.

  • Имя
    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.

  • Имя
    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 incident which triggered this on-call escalation policy.

  • Имя
    triggeredByAlertEpisode
    Тип
    Alert Episode
    Описание

    Relation to the alert episode which triggered this on-call escalation policy.

  • Имя
    triggeredByAlertEpisodeId
    Тип
    Object ID
    Описание

    ID of the alert episode which triggered this on-call escalation policy.

  • Имя
    triggeredByIncidentEpisode
    Тип
    Incident Episode
    Описание

    Relation to the incident episode which triggered this on-call escalation policy.

  • Имя
    triggeredByIncidentEpisodeId
    Тип
    Object ID
    Описание

    ID of the incident episode which triggered this on-call escalation policy.

  • Имя
    status
    Тип
    TextОбязательно
    Описание

    Status of this execution

  • Имя
    statusMessage
    Тип
    Long TextОбязательно
    Описание

    Status message of this execution

  • Имя
    userNotificationEventType
    Тип
    TextОбязательно
    Описание

    Type of event that triggered this on-call duty policy.

  • Имя
    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)

  • Имя
    acknowledgedByUser
    Тип
    User
    Описание

    Relation to User who acknowledged this policy execution (if this policy was acknowledged by a User)

  • Имя
    acknowledgedByUserId
    Тип
    Object ID
    Описание

    User ID who acknowledged this object (if this object was acknowledged by a User)

  • Имя
    acknowledgedAt
    Тип
    Date
    Описание

    When was this policy execution acknowledged?

  • Имя
    acknowledgedByTeam
    Тип
    Entity
    Описание

    Relation to Team who acknowledged this policy execution (if this policy was acknowledged by a Team)

  • Имя
    acknowledgedByTeamId
    Тип
    Object ID
    Описание

    Team ID who acknowledged this object (if this object was acknowledged by a Team)

  • Имя
    lastExecutedEscalationRuleOrder
    Тип
    Number
    Описание

    Which escalation rule was executed?

  • Имя
    lastEscalationRuleExecutedAt
    Тип
    Date
    Описание

    When was the escalation rule executed?

  • Имя
    lastExecutedEscalationRule
    Тип
    Escalation Rule
    Описание

    Relation to On-Call Policy Last Executed Escalation Rule.

  • Имя
    lastExecutedEscalationRuleId
    Тип
    Object ID
    Описание

    ID of your On-Call Policy Last Executed Escalation Rule.

  • Имя
    executeNextEscalationRuleInMinutes
    Тип
    Number
    Описание

    How many minutes should we wait before executing the next escalation rule?

  • Имя
    onCallPolicyExecutionRepeatCount
    Тип
    NumberОбязательно
    Описание

    How many times did we execute this on-call policy?

  • Имя
    triggeredByUser
    Тип
    User
    Описание

    Relation to User who triggered on-clal policy

  • Имя
    triggeredByUserId
    Тип
    Object ID
    Описание

    User ID who triggered this on-call policy

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

Список

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

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

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

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

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

POST
/api/on-call-duty-policy-execution-log/get-list?skip=0&limit=10
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "onCallDutyPolicyId": true,
    "projectId": true,
    "status": true,
    "statusMessage": true,
    "userNotificationEventType": true
  },
  "query": {
    "status": "Executing"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "37769ac0-28fe-11f1-b591-3fdcef396aba",
      "onCallDutyPolicyId": "e5f6a7b8-c9d0-1234-ef01-345678901234",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "status": "Executing",
      "statusMessage": "On-call policy execution started. Notifying primary on-call team members.",
      "userNotificationEventType": "IncidentCreated"
    },
    {
      "_id": "37769ac1-28fe-11f1-b591-3fdcef396aba",
      "onCallDutyPolicyId": "e5f6a7b8-c9d0-1234-ef01-345678901234",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "status": "Executing",
      "statusMessage": "On-call policy execution started. Notifying primary on-call team members.",
      "userNotificationEventType": "IncidentCreated"
    },
    {
      "_id": "37769ac2-28fe-11f1-b591-3fdcef396aba",
      "onCallDutyPolicyId": "e5f6a7b8-c9d0-1234-ef01-345678901234",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "status": "Executing",
      "statusMessage": "On-call policy execution started. Notifying primary on-call team members.",
      "userNotificationEventType": "IncidentCreated"
    }
  ]
}
GETorPOST/api/on-call-duty-policy-execution-log/:id/get-item

Получить по ID

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

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

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

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

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

POST
/api/on-call-duty-policy-execution-log/:id/get-item
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "onCallDutyPolicyId": true,
    "projectId": true,
    "status": true,
    "statusMessage": true,
    "userNotificationEventType": true
  }
}

Ответ

{
  "_id": "37769ac0-28fe-11f1-b591-3fdcef396aba",
  "onCallDutyPolicyId": "e5f6a7b8-c9d0-1234-ef01-345678901234",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "status": "Executing",
  "statusMessage": "On-call policy execution started. Notifying primary on-call team members.",
  "userNotificationEventType": "IncidentCreated"
}
POST/api/on-call-duty-policy-execution-log/count

Количество

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

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

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

POST
/api/on-call-duty-policy-execution-log/count
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "query": {
    "status": "Executing"
  }
}

Ответ

{
  "count": 107
}
POST/api/on-call-duty-policy-execution-log

Создать On-Call Duty Execution Log

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

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

POST
/api/on-call-duty-policy-execution-log
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "onCallDutyPolicyId": "e5f6a7b8-c9d0-1234-ef01-345678901234",
    "onCallPolicyExecutionRepeatCount": 3,
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "status": "Executing",
    "statusMessage": "On-call policy execution started. Notifying primary on-call team members."
  }
}

Ответ

{
  "_id": "37769ac0-28fe-11f1-b591-3fdcef396aba",
  "onCallDutyPolicyId": "e5f6a7b8-c9d0-1234-ef01-345678901234",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "status": "Executing",
  "statusMessage": "On-call policy execution started. Notifying primary on-call team members.",
  "userNotificationEventType": "IncidentCreated"
}

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

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

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

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

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

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Create On-Call Duty Policy Execution Log

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

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

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

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

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

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