Ресурс

On-Call Schedule Layer

On-Call Schedule Layers

Модель On-Call Schedule Layer

Свойства

Имя
_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
Имя
onCallDutyPolicySchedule
Тип
On-Call Policy Schedule
Описание
Relation to On-Call Policy Schedule where this escalation rule belongs.
Имя
onCallDutyPolicyScheduleId
Тип
Object IDОбязательно
Описание
ID of your On-Call Policy Schedule where this escalation rule belongs.
Имя
name
Тип
TextОбязательно
Описание
Friendly name for this layer
Имя
description
Тип
Long Text
Описание
Description for this layer. This is optional and can be left blank.
Имя
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)
Имя
order
Тип
Number
Описание
Order / Priority of this layer. Lower the number, higher the priority.
Имя
startsAt
Тип
DateОбязательно
Описание
Start date and time of this layer.
Имя
rotation
Тип
JSONОбязательно
Описание
How often would you like to hand off the duty to the next user in this layer?
Имя
handOffTime
Тип
DateОбязательно
Описание
Hand off time. When would you like to hand off the duty to the next user in this layer?
Имя
restrictionTimes
Тип
JSONОбязательно
Описание
Restrict this layer to these times

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

Список

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

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

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

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

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

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

POST

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

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "handOffTime": true,
    "name": true,
    "onCallDutyPolicyScheduleId": true,
    "projectId": true,
    "restrictionTimes": true
  },
  "query": {
    "name": "Example name"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "37773700-28fe-11f1-b591-3fdcef396aba",
      "handOffTime": "2024-01-15T10:30:00.000Z",
      "name": "Example name",
      "onCallDutyPolicyScheduleId": "550e8400-e29b-41d4-a716-446655440000",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "restrictionTimes": {
        "key": "value"
      }
    },
    {
      "_id": "37773701-28fe-11f1-b591-3fdcef396aba",
      "handOffTime": "2024-01-15T10:30:00.000Z",
      "name": "Example name",
      "onCallDutyPolicyScheduleId": "550e8400-e29b-41d4-a716-446655440000",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "restrictionTimes": {
        "key": "value"
      }
    },
    {
      "_id": "37773702-28fe-11f1-b591-3fdcef396aba",
      "handOffTime": "2024-01-15T10:30:00.000Z",
      "name": "Example name",
      "onCallDutyPolicyScheduleId": "550e8400-e29b-41d4-a716-446655440000",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "restrictionTimes": {
        "key": "value"
      }
    }
  ]
}

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

Получить по ID

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

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

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

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

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

POST

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

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "handOffTime": true,
    "name": true,
    "onCallDutyPolicyScheduleId": true,
    "projectId": true,
    "restrictionTimes": true
  }
}

Ответ

{
  "_id": "37773700-28fe-11f1-b591-3fdcef396aba",
  "handOffTime": "2024-01-15T10:30:00.000Z",
  "name": "Example name",
  "onCallDutyPolicyScheduleId": "550e8400-e29b-41d4-a716-446655440000",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "restrictionTimes": {
    "key": "value"
  }
}

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

Количество

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

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

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

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

POST

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

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "query": {
    "name": "Example name"
  }
}

Ответ

{
  "count": 107
}

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

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

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

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

POST

/api/on-call-duty-schedule-layer

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "handOffTime": "2024-01-15T10:30:00.000Z",
    "name": "Example name",
    "onCallDutyPolicyScheduleId": "550e8400-e29b-41d4-a716-446655440000",
    "projectId": "550e8400-e29b-41d4-a716-446655440000",
    "restrictionTimes": {
      "key": "value"
    }
  }
}

Ответ

{
  "_id": "37773700-28fe-11f1-b591-3fdcef396aba",
  "handOffTime": "2024-01-15T10:30:00.000Z",
  "name": "Example name",
  "onCallDutyPolicyScheduleId": "550e8400-e29b-41d4-a716-446655440000",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "restrictionTimes": {
    "key": "value"
  }
}

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

Обновить по ID

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

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

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

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

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

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

PUT

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

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "handOffTime": "2024-01-15T10:30:00.000Z",
    "name": "Example name",
    "restrictionTimes": {
      "key": "value"
    }
  }
}

Ответ

{}

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

Удалить по ID

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

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

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

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

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

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

DELETE

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

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

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

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

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

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

Project Owner
Project Admin
Project Member
Read On-Call Schedule Layer
Read All Project Resources

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

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

Project Owner
Project Admin
Project Member
Create On-Call Schedule Layer

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

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

Project Owner
Project Admin
Edit On-Call Schedule Layer

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

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

Project Owner
Project Admin
Delete On-Call Schedule Layer