Ресурс

On Call Time Log

Manage on-call duty user overrides, for example if the user is on leave you can override the on-call duty policy for that user so all the alerts will be routed to the other user.

Модель On Call Time 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
Имя
onCallDutyPolicyId
Тип
Object ID
Описание
ID of your On-Call Policy where this escalation rule belongs.
Имя
onCallDutyPolicyScheduleId
Тип
Object ID
Описание
ID of your On-Call Policy Schedule where this escalation rule belongs.
Имя
onCallDutyPolicyEscalationRuleId
Тип
Object ID
Описание
ID of your On-Call Policy Escalation Rule ID where this escalation rule belongs.
Имя
teamId
Тип
Object ID
Описание
ID of your On-Call Policy Team ID where this escalation rule belongs.
Имя
moreInfo
Тип
Very Long Text
Описание
More information about this log record.
Имя
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)
Имя
user
Тип
User
Описание
Relation to User who is being overridden by this object (if this object was created by a User)
Имя
userId
Тип
Object IDОбязательно
Описание
User ID for which this log belongs
Имя
startsAt
Тип
DateОбязательно
Описание
When does this start?
Имя
endsAt
Тип
Date
Описание
When does this end?

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

Список

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

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

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

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

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

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

POST

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

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "projectId": true,
    "startsAt": true,
    "userId": true,
    "createdByUser": true,
    "createdByUserId": true
  },
  "query": {
    "moreInfo": "User was on-call during incident INC-1234. Successfully handled 3 alerts during this shift."
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "37764ca0-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "startsAt": "2024-01-15T09:00:00.000Z",
      "userId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    {
      "_id": "37764ca1-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "startsAt": "2024-01-15T09:00:00.000Z",
      "userId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    {
      "_id": "37764ca2-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "startsAt": "2024-01-15T09:00:00.000Z",
      "userId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  ]
}

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

Получить по ID

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

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

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

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

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

POST

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

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "projectId": true,
    "startsAt": true,
    "userId": true,
    "createdByUser": true,
    "createdByUserId": true
  }
}

Ответ

{
  "_id": "37764ca0-28fe-11f1-b591-3fdcef396aba",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "startsAt": "2024-01-15T09:00:00.000Z",
  "userId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

POST/api/on-call-duty-policy-time-log/count

Количество

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

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

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

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

POST

/api/on-call-duty-policy-time-log/count

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "query": {
    "moreInfo": "User was on-call during incident INC-1234. Successfully handled 3 alerts during this shift."
  }
}

Ответ

{
  "count": 107
}

POST/api/on-call-duty-policy-time-log

Создать On Call Time Log

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

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

POST

/api/on-call-duty-policy-time-log

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "startsAt": "2024-01-15T09:00:00.000Z",
    "userId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
    "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}

Ответ

{
  "_id": "37764ca0-28fe-11f1-b591-3fdcef396aba",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "startsAt": "2024-01-15T09:00:00.000Z",
  "userId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

PUT/api/on-call-duty-policy-time-log/:id

Обновить по ID

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

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

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

POST/api/on-call-duty-policy-time-log/:id/update-item

GET/api/on-call-duty-policy-time-log/:id/update-item

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

PUT

/api/on-call-duty-policy-time-log/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {}
}

Ответ

{}

DELETE/api/on-call-duty-policy-time-log/:id

Удалить по ID

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

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

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

POST/api/on-call-duty-policy-time-log/:id/delete-item

GET/api/on-call-duty-policy-time-log/:id/delete-item

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

DELETE

/api/on-call-duty-policy-time-log/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

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

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

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

Нужны для чтения On Call Time Log

Project Owner
Project Admin
Project Member
Create On-Call Policy Time Log
Read All Project Resources

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

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

Project Owner
Project Admin
Project Member

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

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

Project Owner
Project Admin
Project Member

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

Нужны для удаления On Call Time Log

Project Owner
Project Admin
Project Member