Status200
Ресурс

On Call Duty Policy Feed

Log of the entire onCallDutyPolicy state change. This is a log of all the on call duty policy changes.

Модель On Call Duty Policy Feed

Свойства

  • Имя
    _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 OnCallDutyPolicy in which this resource belongs

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

    Relation to OnCallDutyPolicy ID in which this resource 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)

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

    Log of the entire onCallDutyPolicy state change in Markdown

  • Имя
    moreInformationInMarkdown
    Тип
    Markdown
    Описание

    More information in Markdown

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

    On Call Duty Policy Feed Event

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

    Display color for the onCallDutyPolicy log

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

    Relation to User who this feed belongs to (if this feed belongs to a User)

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

    User who this feed belongs to (if this feed belongs to a User)

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

    Date and time when the feed was posted

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

Список

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

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

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

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

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

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

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "37762590-28fe-11f1-b591-3fdcef396aba",
      "displayColor": "#2ecc71",
      "feedInfoInMarkdown": "## User Added to On-Call Duty Policy\n\nJohn Doe has been added to the on-call rotation for the weekend shift.",
      "onCallDutyPolicyFeedEventType": "UserAdded",
      "onCallDutyPolicyId": "8b9c0d1e-2f3a-4b5c-6d7e-8f9a0b1c2d3e",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e"
    },
    {
      "_id": "37762591-28fe-11f1-b591-3fdcef396aba",
      "displayColor": "#2ecc71",
      "feedInfoInMarkdown": "## User Added to On-Call Duty Policy\n\nJohn Doe has been added to the on-call rotation for the weekend shift.",
      "onCallDutyPolicyFeedEventType": "UserAdded",
      "onCallDutyPolicyId": "8b9c0d1e-2f3a-4b5c-6d7e-8f9a0b1c2d3e",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e"
    },
    {
      "_id": "37762592-28fe-11f1-b591-3fdcef396aba",
      "displayColor": "#2ecc71",
      "feedInfoInMarkdown": "## User Added to On-Call Duty Policy\n\nJohn Doe has been added to the on-call rotation for the weekend shift.",
      "onCallDutyPolicyFeedEventType": "UserAdded",
      "onCallDutyPolicyId": "8b9c0d1e-2f3a-4b5c-6d7e-8f9a0b1c2d3e",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e"
    }
  ]
}
GETorPOST/api/on-call-duty-policy-feed/:id/get-item

Получить по ID

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

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

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

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

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

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

Ответ

{
  "_id": "37762590-28fe-11f1-b591-3fdcef396aba",
  "displayColor": "#2ecc71",
  "feedInfoInMarkdown": "## User Added to On-Call Duty Policy\n\nJohn Doe has been added to the on-call rotation for the weekend shift.",
  "onCallDutyPolicyFeedEventType": "UserAdded",
  "onCallDutyPolicyId": "8b9c0d1e-2f3a-4b5c-6d7e-8f9a0b1c2d3e",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e"
}
POST/api/on-call-duty-policy-feed/count

Количество

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

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

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

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

Ответ

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

Создать On Call Duty Policy Feed

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

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

POST
/api/on-call-duty-policy-feed
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "displayColor": "#2ecc71",
    "feedInfoInMarkdown": "## User Added to On-Call Duty Policy\n\nJohn Doe has been added to the on-call rotation for the weekend shift.",
    "onCallDutyPolicyFeedEventType": "UserAdded",
    "onCallDutyPolicyId": "8b9c0d1e-2f3a-4b5c-6d7e-8f9a0b1c2d3e",
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e"
  }
}

Ответ

{
  "_id": "37762590-28fe-11f1-b591-3fdcef396aba",
  "displayColor": "#2ecc71",
  "feedInfoInMarkdown": "## User Added to On-Call Duty Policy\n\nJohn Doe has been added to the on-call rotation for the weekend shift.",
  "onCallDutyPolicyFeedEventType": "UserAdded",
  "onCallDutyPolicyId": "8b9c0d1e-2f3a-4b5c-6d7e-8f9a0b1c2d3e",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e"
}

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

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

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

Нужны для чтения On Call Duty Policy Feed

  • Project Owner
  • Project Admin
  • Project Member
  • Read On Call Duty Policy Feed
  • Read All Project Resources

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Create On Call Duty Policy Feed

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

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

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

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

Нужны для удаления On Call Duty Policy Feed

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