Status200
Ресурс

Incident Episode Public Note

Manage public notes for your incident episode

Модель Incident Episode Public Note

Свойства

  • Имя
    _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)

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

    Notes in markdown

  • Имя
    attachments
    Тип
    File
    Описание

    Files attached to this note

  • Имя
    subscriberNotificationStatusMessage
    Тип
    Very Long Text
    Описание

    Status message for subscriber notifications - includes success messages, failure reasons, or skip reasons

  • Имя
    shouldStatusPageSubscribersBeNotifiedOnNoteCreated
    Тип
    Boolean
    Описание

    Should subscribers be notified about this note?

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

    Date and time when the note was posted

  • Имя
    postedFromSlackMessageId
    Тип
    Long Text
    Описание

    Unique identifier for the Slack message this note was created from (channel_id:message_ts). Used to prevent duplicate notes when multiple users react to the same message.

GETorPOST/api/incident-episode-public-note/get-list

Список

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

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

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

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

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

POST
/api/incident-episode-public-note/get-list?skip=0&limit=10
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "incidentEpisodeId": true,
    "projectId": true,
    "createdByUserId": true,
    "note": true,
    "postedFromSlackMessageId": true
  },
  "query": {
    "postedFromSlackMessageId": "C1234567890:1234567890.123456"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "376fe400-28fe-11f1-b591-3fdcef396aba",
      "incidentEpisodeId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "createdByUserId": "7c8d9e0f-a1b2-3c4d-9e5f-8a9b0c1d2e3f",
      "note": "## Update - Episode Resolved\n\nWe have identified and resolved the issue. All services are now operating normally.",
      "postedFromSlackMessageId": "C1234567890:1234567890.123456"
    },
    {
      "_id": "376fe401-28fe-11f1-b591-3fdcef396aba",
      "incidentEpisodeId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "createdByUserId": "7c8d9e0f-a1b2-3c4d-9e5f-8a9b0c1d2e3f",
      "note": "## Update - Episode Resolved\n\nWe have identified and resolved the issue. All services are now operating normally.",
      "postedFromSlackMessageId": "C1234567890:1234567890.123456"
    },
    {
      "_id": "376fe402-28fe-11f1-b591-3fdcef396aba",
      "incidentEpisodeId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "createdByUserId": "7c8d9e0f-a1b2-3c4d-9e5f-8a9b0c1d2e3f",
      "note": "## Update - Episode Resolved\n\nWe have identified and resolved the issue. All services are now operating normally.",
      "postedFromSlackMessageId": "C1234567890:1234567890.123456"
    }
  ]
}
GETorPOST/api/incident-episode-public-note/:id/get-item

Получить по ID

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

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

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

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

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

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

Ответ

{
  "_id": "376fe400-28fe-11f1-b591-3fdcef396aba",
  "incidentEpisodeId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "createdByUserId": "7c8d9e0f-a1b2-3c4d-9e5f-8a9b0c1d2e3f",
  "note": "## Update - Episode Resolved\n\nWe have identified and resolved the issue. All services are now operating normally.",
  "postedFromSlackMessageId": "C1234567890:1234567890.123456"
}
POST/api/incident-episode-public-note/count

Количество

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

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

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

POST
/api/incident-episode-public-note/count
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "query": {
    "postedFromSlackMessageId": "C1234567890:1234567890.123456"
  }
}

Ответ

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

Создать Incident Episode Public Note

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

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

POST
/api/incident-episode-public-note
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "incidentEpisodeId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "createdByUserId": "7c8d9e0f-a1b2-3c4d-9e5f-8a9b0c1d2e3f",
    "note": "## Update - Episode Resolved\n\nWe have identified and resolved the issue. All services are now operating normally.",
    "postedFromSlackMessageId": "C1234567890:1234567890.123456"
  }
}

Ответ

{
  "_id": "376fe400-28fe-11f1-b591-3fdcef396aba",
  "incidentEpisodeId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "createdByUserId": "7c8d9e0f-a1b2-3c4d-9e5f-8a9b0c1d2e3f",
  "note": "## Update - Episode Resolved\n\nWe have identified and resolved the issue. All services are now operating normally.",
  "postedFromSlackMessageId": "C1234567890:1234567890.123456"
}
PUT/api/incident-episode-public-note/:id

Обновить по ID

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

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

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

POST/api/incident-episode-public-note/:id/update-item
GET/api/incident-episode-public-note/:id/update-item

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

PUT
/api/incident-episode-public-note/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "note": "## Update - Episode Resolved\n\nWe have identified and resolved the issue. All services are now operating normally.",
    "subscriberNotificationStatusMessage": "Successfully notified 1,234 subscribers via email and SMS",
    "attachments": []
  }
}

Ответ

{}
DELETE/api/incident-episode-public-note/:id

Удалить по ID

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

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

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

POST/api/incident-episode-public-note/:id/delete-item
GET/api/incident-episode-public-note/:id/delete-item

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

DELETE
/api/incident-episode-public-note/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

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

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

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Read Incident Episode Public Note
  • Read All Project Resources

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Create Incident Episode Public Note

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Edit Incident Episode Public Note

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Delete Incident Episode Public Note