Status200
Ресурс

Incident Episode Feed

Log of the entire incident episode activity. This is a log of all the episode state changes, incidents added/removed, notes, etc.

Модель Incident Episode 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

  • Имя
    incidentEpisode
    Тип
    Incident Episode
    Описание

    Relation to Incident Episode in which this resource belongs

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

    Relation to Incident Episode 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 incident episode activity in Markdown

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

    More information in Markdown

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

    Incident Episode Feed Event Type

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

    Display color for the incident episode 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/incident-episode-feed/get-list

Список

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

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

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

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

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

POST
/api/incident-episode-feed/get-list?skip=0&limit=10
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "displayColor": true,
    "feedInfoInMarkdown": true,
    "incidentEpisodeFeedEventType": true,
    "incidentEpisodeId": true,
    "projectId": true
  },
  "query": {
    "incidentEpisodeFeedEventType": "Example incident episode feed event"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "376f6ed0-28fe-11f1-b591-3fdcef396aba",
      "displayColor": "#3498db",
      "feedInfoInMarkdown": "Example log (in markdown) content",
      "incidentEpisodeFeedEventType": "Example incident episode feed event",
      "incidentEpisodeId": "550e8400-e29b-41d4-a716-446655440000",
      "projectId": "550e8400-e29b-41d4-a716-446655440000"
    },
    {
      "_id": "376f6ed1-28fe-11f1-b591-3fdcef396aba",
      "displayColor": "#3498db",
      "feedInfoInMarkdown": "Example log (in markdown) content",
      "incidentEpisodeFeedEventType": "Example incident episode feed event",
      "incidentEpisodeId": "550e8400-e29b-41d4-a716-446655440000",
      "projectId": "550e8400-e29b-41d4-a716-446655440000"
    },
    {
      "_id": "376f6ed2-28fe-11f1-b591-3fdcef396aba",
      "displayColor": "#3498db",
      "feedInfoInMarkdown": "Example log (in markdown) content",
      "incidentEpisodeFeedEventType": "Example incident episode feed event",
      "incidentEpisodeId": "550e8400-e29b-41d4-a716-446655440000",
      "projectId": "550e8400-e29b-41d4-a716-446655440000"
    }
  ]
}
GETorPOST/api/incident-episode-feed/:id/get-item

Получить по ID

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

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

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

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

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

POST
/api/incident-episode-feed/:id/get-item
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "displayColor": true,
    "feedInfoInMarkdown": true,
    "incidentEpisodeFeedEventType": true,
    "incidentEpisodeId": true,
    "projectId": true
  }
}

Ответ

{
  "_id": "376f6ed0-28fe-11f1-b591-3fdcef396aba",
  "displayColor": "#3498db",
  "feedInfoInMarkdown": "Example log (in markdown) content",
  "incidentEpisodeFeedEventType": "Example incident episode feed event",
  "incidentEpisodeId": "550e8400-e29b-41d4-a716-446655440000",
  "projectId": "550e8400-e29b-41d4-a716-446655440000"
}
POST/api/incident-episode-feed/count

Количество

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

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

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

POST
/api/incident-episode-feed/count
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "query": {
    "incidentEpisodeFeedEventType": "Example incident episode feed event"
  }
}

Ответ

{
  "count": 107
}
POST/api/incident-episode-feed

Создать Incident Episode Feed

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

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

POST
/api/incident-episode-feed
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "displayColor": "#3498db",
    "feedInfoInMarkdown": "Example log (in markdown) content",
    "incidentEpisodeFeedEventType": "Example incident episode feed event",
    "incidentEpisodeId": "550e8400-e29b-41d4-a716-446655440000",
    "projectId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Ответ

{
  "_id": "376f6ed0-28fe-11f1-b591-3fdcef396aba",
  "displayColor": "#3498db",
  "feedInfoInMarkdown": "Example log (in markdown) content",
  "incidentEpisodeFeedEventType": "Example incident episode feed event",
  "incidentEpisodeId": "550e8400-e29b-41d4-a716-446655440000",
  "projectId": "550e8400-e29b-41d4-a716-446655440000"
}

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

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

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

Нужны для чтения Incident Episode Feed

  • Project Owner
  • Project Admin
  • Project Member
  • Read Incident Episode Feed
  • Read All Project Resources

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

Нужны для создания Incident Episode Feed

  • Project Owner
  • Project Admin
  • Project Member
  • Create Incident Episode Feed

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

Нужны для обновления Incident Episode Feed

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

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

Нужны для удаления Incident Episode Feed

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