Ресурс

On-Call Policy Schedule

Manage schedules and rotations for your on-call duty policy.

Модель On-Call Policy Schedule

Свойства

Имя
_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
Имя
name
Тип
TextОбязательно
Описание
Any friendly name of this object
Имя
labels
Тип
Label
Описание
Relation to Labels Array where this object is categorized in.
Имя
description
Тип
Long Text
Описание
Friendly description that will help you remember
Имя
slug
Тип
SlugОбязательно
Описание
Friendly globally unique name for your object
Имя
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)
Имя
currentUserOnRoster
Тип
User
Описание
Relation to User who is currently on roster
Имя
currentUserIdOnRoster
Тип
Object ID
Описание
User ID who is currently on roster
Имя
nextUserOnRoster
Тип
User
Описание
Relation to User who is next on roster
Имя
nextUserIdOnRoster
Тип
Object ID
Описание
Next ID who is currently on roster
Имя
rosterHandoffAt
Тип
Date
Описание
When does the roster handoff occur for this schedule for the current user?
Имя
rosterNextHandoffAt
Тип
Date
Описание
When does the next roster handoff occur for this schedule for the next user?
Имя
rosterNextStartAt
Тип
Date
Описание
When does the next event start for this schedule for the next user?
Имя
rosterStartAt
Тип
Date
Описание
When does the current event start for this schedule for the current user?

GETorPOST/api/on-call-duty-policy-schedule/get-list

Список

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

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

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

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

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

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

POST

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

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "name": true,
    "projectId": true,
    "slug": true,
    "createdByUser": true,
    "createdByUserId": true
  },
  "query": {
    "name": "Weekend On-Call Rotation"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "37770ff0-28fe-11f1-b591-3fdcef396aba",
      "name": "Weekend On-Call Rotation",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "slug": "weekend-on-call-rotation",
      "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    {
      "_id": "37770ff1-28fe-11f1-b591-3fdcef396aba",
      "name": "Weekend On-Call Rotation",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "slug": "weekend-on-call-rotation",
      "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    {
      "_id": "37770ff2-28fe-11f1-b591-3fdcef396aba",
      "name": "Weekend On-Call Rotation",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "slug": "weekend-on-call-rotation",
      "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  ]
}

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

Получить по ID

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

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

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

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

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

POST

/api/on-call-duty-policy-schedule/:id/get-item

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "name": true,
    "projectId": true,
    "slug": true,
    "createdByUser": true,
    "createdByUserId": true
  }
}

Ответ

{
  "_id": "37770ff0-28fe-11f1-b591-3fdcef396aba",
  "name": "Weekend On-Call Rotation",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "slug": "weekend-on-call-rotation",
  "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

POST/api/on-call-duty-policy-schedule/count

Количество

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

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

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

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

POST

/api/on-call-duty-policy-schedule/count

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "query": {
    "name": "Weekend On-Call Rotation"
  }
}

Ответ

{
  "count": 107
}

POST/api/on-call-duty-policy-schedule

Создать On-Call Policy Schedule

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

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

POST

/api/on-call-duty-policy-schedule

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "name": "Weekend On-Call Rotation",
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "currentUserOnRoster": "c3d4e5f6-a7b8-9012-cdef-123456789012"
  }
}

Ответ

{
  "_id": "37770ff0-28fe-11f1-b591-3fdcef396aba",
  "name": "Weekend On-Call Rotation",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "slug": "weekend-on-call-rotation",
  "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

PUT/api/on-call-duty-policy-schedule/:id

Обновить по ID

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

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

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

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

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

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

PUT

/api/on-call-duty-policy-schedule/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "name": "Weekend On-Call Rotation",
    "description": "This schedule handles on-call duties during weekend hours for production incidents",
    "labels": [
      {
        "name": "production"
      },
      {
        "name": "critical"
      }
    ]
  }
}

Ответ

{}

DELETE/api/on-call-duty-policy-schedule/:id

Удалить по ID

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

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

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

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

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

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

DELETE

/api/on-call-duty-policy-schedule/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

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

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

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

Нужны для чтения On-Call Policy Schedule

Project Owner
Project Admin
Project Member
Read On-Call Duty Policy Schedule
Read All Project Resources

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

Нужны для создания On-Call Policy Schedule

Project Owner
Project Admin
Project Member
Create On-Call Duty Policy Schedule

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

Нужны для обновления On-Call Policy Schedule

Project Owner
Project Admin
Project Member
Edit On-Call Duty Policy Schedule

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

Нужны для удаления On-Call Policy Schedule

Project Owner
Project Admin
Project Member
Delete On-Call Duty Policy Schedule