Status200
Ресурс

User Override

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.

Модель User Override

Свойства

  • Имя
    _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 where this escalation rule belongs.

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

    ID of your On-Call Policy where this escalation rule belongs.

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

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

    Relation to User who is being overridden by this object (if this object was created by a User)

  • Имя
    overrideUserId
    Тип
    Object IDОбязательно
    Описание

    User ID who is being overridden by this object (if this object was created by a User)

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

    Relation to User who is being overridden by this object (if this object was created by a User)

  • Имя
    routeAlertsToUserId
    Тип
    Object IDОбязательно
    Описание

    User ID who is being overridden by this object (if this object was created by a User)

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

    When does this start?

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

    When does this end?

GETorPOST/api/on-call-duty-policy-user-override/get-list

Список

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

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

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

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

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

POST
/api/on-call-duty-policy-user-override/get-list?skip=0&limit=10
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "endsAt": true,
    "overrideUserId": true,
    "projectId": true,
    "routeAlertsToUserId": true,
    "startsAt": true
  },
  "query": {},
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "377f7460-28fe-11f1-b591-3fdcef396aba",
      "endsAt": "2024-01-15T10:30:00.000Z",
      "overrideUserId": "550e8400-e29b-41d4-a716-446655440000",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "routeAlertsToUserId": "550e8400-e29b-41d4-a716-446655440000",
      "startsAt": "2024-01-15T10:30:00.000Z"
    },
    {
      "_id": "377f7461-28fe-11f1-b591-3fdcef396aba",
      "endsAt": "2024-01-15T10:30:00.000Z",
      "overrideUserId": "550e8400-e29b-41d4-a716-446655440000",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "routeAlertsToUserId": "550e8400-e29b-41d4-a716-446655440000",
      "startsAt": "2024-01-15T10:30:00.000Z"
    },
    {
      "_id": "377f7462-28fe-11f1-b591-3fdcef396aba",
      "endsAt": "2024-01-15T10:30:00.000Z",
      "overrideUserId": "550e8400-e29b-41d4-a716-446655440000",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "routeAlertsToUserId": "550e8400-e29b-41d4-a716-446655440000",
      "startsAt": "2024-01-15T10:30:00.000Z"
    }
  ]
}
GETorPOST/api/on-call-duty-policy-user-override/:id/get-item

Получить по ID

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

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

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

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

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

POST
/api/on-call-duty-policy-user-override/:id/get-item
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "endsAt": true,
    "overrideUserId": true,
    "projectId": true,
    "routeAlertsToUserId": true,
    "startsAt": true
  }
}

Ответ

{
  "_id": "377f7460-28fe-11f1-b591-3fdcef396aba",
  "endsAt": "2024-01-15T10:30:00.000Z",
  "overrideUserId": "550e8400-e29b-41d4-a716-446655440000",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "routeAlertsToUserId": "550e8400-e29b-41d4-a716-446655440000",
  "startsAt": "2024-01-15T10:30:00.000Z"
}
POST/api/on-call-duty-policy-user-override/count

Количество

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

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

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

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

Ответ

{
  "count": 107
}
POST/api/on-call-duty-policy-user-override

Создать User Override

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

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

POST
/api/on-call-duty-policy-user-override
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "endsAt": "2024-01-15T10:30:00.000Z",
    "overrideUserId": "550e8400-e29b-41d4-a716-446655440000",
    "projectId": "550e8400-e29b-41d4-a716-446655440000",
    "routeAlertsToUserId": "550e8400-e29b-41d4-a716-446655440000",
    "startsAt": "2024-01-15T10:30:00.000Z"
  }
}

Ответ

{
  "_id": "377f7460-28fe-11f1-b591-3fdcef396aba",
  "endsAt": "2024-01-15T10:30:00.000Z",
  "overrideUserId": "550e8400-e29b-41d4-a716-446655440000",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "routeAlertsToUserId": "550e8400-e29b-41d4-a716-446655440000",
  "startsAt": "2024-01-15T10:30:00.000Z"
}
PUT/api/on-call-duty-policy-user-override/:id

Обновить по ID

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

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

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

POST/api/on-call-duty-policy-user-override/:id/update-item
GET/api/on-call-duty-policy-user-override/:id/update-item

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

PUT
/api/on-call-duty-policy-user-override/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {}
}

Ответ

{}
DELETE/api/on-call-duty-policy-user-override/:id

Удалить по ID

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

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

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

POST/api/on-call-duty-policy-user-override/:id/delete-item
GET/api/on-call-duty-policy-user-override/:id/delete-item

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

DELETE
/api/on-call-duty-policy-user-override/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

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

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

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Read On-Call Duty Policy User Override
  • Read All Project Resources

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Create On-Call Duty Policy User Override

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Edit On-Call Duty Policy User Override

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Delete On-Call Duty Policy User Override