Status200
Ресурс

Scheduled Maintenance Feed

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

Модель Scheduled Maintenance 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

  • Имя
    scheduledMaintenance
    Тип
    Scheduled Maintenance Event
    Описание

    Relation to ScheduledMaintenance in which this resource belongs

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

    Relation to ScheduledMaintenance 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 scheduled maintenance state change in Markdown

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

    More information in Markdown

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

    ScheduledMaintenance Log Event

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

    Display color for this 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/scheduled-maintenance-feed/get-list

Список

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

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

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

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

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

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

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "377959e0-28fe-11f1-b591-3fdcef396aba",
      "displayColor": "#3498db",
      "feedInfoInMarkdown": "## Scheduled Maintenance Created\n\nA new scheduled maintenance window has been created for database upgrade. Expected downtime: 2 hours.",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "scheduledMaintenanceFeedEventType": "ScheduledMaintenanceCreated",
      "scheduledMaintenanceId": "7a2b8c9d-f3e4-5c6d-9e7f-8a9b0c1d2e3f"
    },
    {
      "_id": "377959e1-28fe-11f1-b591-3fdcef396aba",
      "displayColor": "#3498db",
      "feedInfoInMarkdown": "## Scheduled Maintenance Created\n\nA new scheduled maintenance window has been created for database upgrade. Expected downtime: 2 hours.",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "scheduledMaintenanceFeedEventType": "ScheduledMaintenanceCreated",
      "scheduledMaintenanceId": "7a2b8c9d-f3e4-5c6d-9e7f-8a9b0c1d2e3f"
    },
    {
      "_id": "377959e2-28fe-11f1-b591-3fdcef396aba",
      "displayColor": "#3498db",
      "feedInfoInMarkdown": "## Scheduled Maintenance Created\n\nA new scheduled maintenance window has been created for database upgrade. Expected downtime: 2 hours.",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "scheduledMaintenanceFeedEventType": "ScheduledMaintenanceCreated",
      "scheduledMaintenanceId": "7a2b8c9d-f3e4-5c6d-9e7f-8a9b0c1d2e3f"
    }
  ]
}
GETorPOST/api/scheduled-maintenance-feed/:id/get-item

Получить по ID

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

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

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

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

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

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

Ответ

{
  "_id": "377959e0-28fe-11f1-b591-3fdcef396aba",
  "displayColor": "#3498db",
  "feedInfoInMarkdown": "## Scheduled Maintenance Created\n\nA new scheduled maintenance window has been created for database upgrade. Expected downtime: 2 hours.",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "scheduledMaintenanceFeedEventType": "ScheduledMaintenanceCreated",
  "scheduledMaintenanceId": "7a2b8c9d-f3e4-5c6d-9e7f-8a9b0c1d2e3f"
}
POST/api/scheduled-maintenance-feed/count

Количество

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

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

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

POST
/api/scheduled-maintenance-feed/count
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "query": {
    "scheduledMaintenanceFeedEventType": "ScheduledMaintenanceCreated"
  }
}

Ответ

{
  "count": 107
}
POST/api/scheduled-maintenance-feed

Создать Scheduled Maintenance Feed

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

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

POST
/api/scheduled-maintenance-feed
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "displayColor": "#3498db",
    "feedInfoInMarkdown": "## Scheduled Maintenance Created\n\nA new scheduled maintenance window has been created for database upgrade. Expected downtime: 2 hours.",
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "scheduledMaintenanceFeedEventType": "ScheduledMaintenanceCreated",
    "scheduledMaintenanceId": "7a2b8c9d-f3e4-5c6d-9e7f-8a9b0c1d2e3f"
  }
}

Ответ

{
  "_id": "377959e0-28fe-11f1-b591-3fdcef396aba",
  "displayColor": "#3498db",
  "feedInfoInMarkdown": "## Scheduled Maintenance Created\n\nA new scheduled maintenance window has been created for database upgrade. Expected downtime: 2 hours.",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "scheduledMaintenanceFeedEventType": "ScheduledMaintenanceCreated",
  "scheduledMaintenanceId": "7a2b8c9d-f3e4-5c6d-9e7f-8a9b0c1d2e3f"
}

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

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

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Read Scheduled Maintenance Log
  • Read All Project Resources

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Create Scheduled Maintenance Log

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

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

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

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

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

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