Status200
Ресурс

Status Page Announcement

Manage announcements on your status page

Модель Status Page Announcement

Свойства

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

  • Имя
    statusPages
    Тип
    Status Page
    Описание

    Status Pages to show show this announcement on.

  • Имя
    monitors
    Тип
    Monitor
    Описание

    List of monitors affected by this announcement. If none are selected, all subscribers will be notified.

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

    Title of this resource

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

    When should this announcement be shown?

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

    When should this announcement hidden?

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

    Text of the announcement. This can be in Markdown format.

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

    Files attached to this announcement

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

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

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

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

    Should subscribers be notified about this announcement?

GETorPOST/api/status-page-announcement/get-list

Список

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

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

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

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

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

POST
/api/status-page-announcement/get-list?skip=0&limit=10
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "description": true,
    "projectId": true,
    "title": true,
    "createdByUserId": true,
    "showAnnouncementAt": true
  },
  "query": {
    "title": "Scheduled Maintenance - Database Upgrade"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "377ba3d0-28fe-11f1-b591-3fdcef396aba",
      "description": "We will be performing scheduled maintenance on our database servers. Expected downtime is 2 hours.",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "title": "Scheduled Maintenance - Database Upgrade",
      "createdByUserId": "c3d4e5f6-a7b8-9012-cdef-234567890abc",
      "showAnnouncementAt": "2024-01-15T10:30:00.000Z"
    },
    {
      "_id": "377ba3d1-28fe-11f1-b591-3fdcef396aba",
      "description": "We will be performing scheduled maintenance on our database servers. Expected downtime is 2 hours.",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "title": "Scheduled Maintenance - Database Upgrade",
      "createdByUserId": "c3d4e5f6-a7b8-9012-cdef-234567890abc",
      "showAnnouncementAt": "2024-01-15T10:30:00.000Z"
    },
    {
      "_id": "377ba3d2-28fe-11f1-b591-3fdcef396aba",
      "description": "We will be performing scheduled maintenance on our database servers. Expected downtime is 2 hours.",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "title": "Scheduled Maintenance - Database Upgrade",
      "createdByUserId": "c3d4e5f6-a7b8-9012-cdef-234567890abc",
      "showAnnouncementAt": "2024-01-15T10:30:00.000Z"
    }
  ]
}
GETorPOST/api/status-page-announcement/:id/get-item

Получить по ID

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

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

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

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

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

POST
/api/status-page-announcement/:id/get-item
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "description": true,
    "projectId": true,
    "title": true,
    "createdByUserId": true,
    "showAnnouncementAt": true
  }
}

Ответ

{
  "_id": "377ba3d0-28fe-11f1-b591-3fdcef396aba",
  "description": "We will be performing scheduled maintenance on our database servers. Expected downtime is 2 hours.",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "title": "Scheduled Maintenance - Database Upgrade",
  "createdByUserId": "c3d4e5f6-a7b8-9012-cdef-234567890abc",
  "showAnnouncementAt": "2024-01-15T10:30:00.000Z"
}
POST/api/status-page-announcement/count

Количество

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

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

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

POST
/api/status-page-announcement/count
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "query": {
    "title": "Scheduled Maintenance - Database Upgrade"
  }
}

Ответ

{
  "count": 107
}
POST/api/status-page-announcement

Создать Status Page Announcement

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

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

POST
/api/status-page-announcement
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "description": "We will be performing scheduled maintenance on our database servers. Expected downtime is 2 hours.",
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "title": "Scheduled Maintenance - Database Upgrade",
    "createdByUserId": "c3d4e5f6-a7b8-9012-cdef-234567890abc",
    "showAnnouncementAt": "2024-01-15T10:30:00.000Z"
  }
}

Ответ

{
  "_id": "377ba3d0-28fe-11f1-b591-3fdcef396aba",
  "description": "We will be performing scheduled maintenance on our database servers. Expected downtime is 2 hours.",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "title": "Scheduled Maintenance - Database Upgrade",
  "createdByUserId": "c3d4e5f6-a7b8-9012-cdef-234567890abc",
  "showAnnouncementAt": "2024-01-15T10:30:00.000Z"
}
PUT/api/status-page-announcement/:id

Обновить по ID

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

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

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

POST/api/status-page-announcement/:id/update-item
GET/api/status-page-announcement/:id/update-item

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

PUT
/api/status-page-announcement/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "description": "We will be performing scheduled maintenance on our database servers. Expected downtime is 2 hours.",
    "title": "Scheduled Maintenance - Database Upgrade",
    "showAnnouncementAt": "2024-01-15T10:30:00.000Z"
  }
}

Ответ

{}
DELETE/api/status-page-announcement/:id

Удалить по ID

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

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

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

POST/api/status-page-announcement/:id/delete-item
GET/api/status-page-announcement/:id/delete-item

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

DELETE
/api/status-page-announcement/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

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

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

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

Нужны для чтения Status Page Announcement

  • Project Owner
  • Project Admin
  • Project Member
  • Read Status Page Announcement
  • Read All Project Resources

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

Нужны для создания Status Page Announcement

  • Project Owner
  • Project Admin
  • Project Member
  • Create Status Page Announcement

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

Нужны для обновления Status Page Announcement

  • Project Owner
  • Project Admin
  • Project Member
  • Edit Status Page Announcement

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

Нужны для удаления Status Page Announcement

  • Project Owner
  • Project Admin
  • Project Member
  • Delete Status Page Announcement