Status200
Ресурс

Alert Feed

Log of the entire alert state change. This is a log of all the alert state changes, public notes, more etc.

Модель Alert 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 Status200 Project in which this object belongs

  • Имя
    alert
    Тип
    Alert
    Описание

    Relation to Alert in which this resource belongs

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

    Relation to Alert 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 alert state change in Markdown

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

    More information in Markdown

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

    Alert Feed Event

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

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

Список

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

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

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

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

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

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

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "376c1370-28fe-11f1-b591-3fdcef396aba",
      "alertFeedEventType": "AlertStateChanged",
      "alertId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "displayColor": "#e74c3c",
      "feedInfoInMarkdown": "**Alert State Changed**\n\nAlert state changed from *Created* to *Acknowledged* by John Smith.",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e"
    },
    {
      "_id": "376c1371-28fe-11f1-b591-3fdcef396aba",
      "alertFeedEventType": "AlertStateChanged",
      "alertId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "displayColor": "#e74c3c",
      "feedInfoInMarkdown": "**Alert State Changed**\n\nAlert state changed from *Created* to *Acknowledged* by John Smith.",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e"
    },
    {
      "_id": "376c1372-28fe-11f1-b591-3fdcef396aba",
      "alertFeedEventType": "AlertStateChanged",
      "alertId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "displayColor": "#e74c3c",
      "feedInfoInMarkdown": "**Alert State Changed**\n\nAlert state changed from *Created* to *Acknowledged* by John Smith.",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e"
    }
  ]
}
GETorPOST/api/alert-feed/:id/get-item

Получить по ID

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

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

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

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

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

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

Ответ

{
  "_id": "376c1370-28fe-11f1-b591-3fdcef396aba",
  "alertFeedEventType": "AlertStateChanged",
  "alertId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "displayColor": "#e74c3c",
  "feedInfoInMarkdown": "**Alert State Changed**\n\nAlert state changed from *Created* to *Acknowledged* by John Smith.",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e"
}
POST/api/alert-feed/count

Количество

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

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

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

POST
/api/alert-feed/count
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "query": {
    "alertFeedEventType": "AlertStateChanged"
  }
}

Ответ

{
  "count": 107
}
POST/api/alert-feed

Создать Alert Feed

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

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

POST
/api/alert-feed
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "alertFeedEventType": "AlertStateChanged",
    "alertId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "displayColor": "#e74c3c",
    "feedInfoInMarkdown": "**Alert State Changed**\n\nAlert state changed from *Created* to *Acknowledged* by John Smith.",
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e"
  }
}

Ответ

{
  "_id": "376c1370-28fe-11f1-b591-3fdcef396aba",
  "alertFeedEventType": "AlertStateChanged",
  "alertId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "displayColor": "#e74c3c",
  "feedInfoInMarkdown": "**Alert State Changed**\n\nAlert state changed from *Created* to *Acknowledged* by John Smith.",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e"
}

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

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

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Read Alert Feed
  • Read All Project Resources

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Create Alert Feed

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

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

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

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

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

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