Status200
Ресурс

Scheduled Maintenance State Timeline

Change state of your scheduled maintenance event.

Модель Scheduled Maintenance State Timeline

Свойства

  • Имя
    _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 Scheduled Maintenance Event this resource belongs to

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

    ID of Scheduled Maintenance this resource belongs to

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

  • Имя
    scheduledMaintenanceState
    Тип
    Scheduled Maintenance State
    Описание

    Which state does this event belongs to?. Relation to Scheduled Maintenance State

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

    Scheduled Maintenance State ID. Which state does this event belongs to?

  • Имя
    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 state change?

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

    When did this status change end?

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

    When did this status change?

GETorPOST/api/scheduled-maintenance-state-timeline/get-list

Список

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

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

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

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

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

POST
/api/scheduled-maintenance-state-timeline/get-list?skip=0&limit=10
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "projectId": true,
    "scheduledMaintenanceId": true,
    "scheduledMaintenanceStateId": true,
    "createdByUser": true,
    "createdByUserId": true
  },
  "query": {
    "subscriberNotificationStatusMessage": "Maintenance notification sent to 152 subscribers. Scheduled maintenance window: 2024-01-16 02:00-04:00 UTC"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "3779cf10-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "scheduledMaintenanceId": "c9d0e1f2-a3b4-5678-90ab-cdef01234567",
      "scheduledMaintenanceStateId": "d0e1f2a3-b4c5-6789-01ab-cdef12345678",
      "createdByUser": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "createdByUserId": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
    },
    {
      "_id": "3779cf11-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "scheduledMaintenanceId": "c9d0e1f2-a3b4-5678-90ab-cdef01234567",
      "scheduledMaintenanceStateId": "d0e1f2a3-b4c5-6789-01ab-cdef12345678",
      "createdByUser": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "createdByUserId": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
    },
    {
      "_id": "3779cf12-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "scheduledMaintenanceId": "c9d0e1f2-a3b4-5678-90ab-cdef01234567",
      "scheduledMaintenanceStateId": "d0e1f2a3-b4c5-6789-01ab-cdef12345678",
      "createdByUser": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "createdByUserId": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
    }
  ]
}
GETorPOST/api/scheduled-maintenance-state-timeline/:id/get-item

Получить по ID

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

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

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

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

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

POST
/api/scheduled-maintenance-state-timeline/:id/get-item
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "projectId": true,
    "scheduledMaintenanceId": true,
    "scheduledMaintenanceStateId": true,
    "createdByUser": true,
    "createdByUserId": true
  }
}

Ответ

{
  "_id": "3779cf10-28fe-11f1-b591-3fdcef396aba",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "scheduledMaintenanceId": "c9d0e1f2-a3b4-5678-90ab-cdef01234567",
  "scheduledMaintenanceStateId": "d0e1f2a3-b4c5-6789-01ab-cdef12345678",
  "createdByUser": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "createdByUserId": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
}
POST/api/scheduled-maintenance-state-timeline/count

Количество

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

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

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

POST
/api/scheduled-maintenance-state-timeline/count
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "query": {
    "subscriberNotificationStatusMessage": "Maintenance notification sent to 152 subscribers. Scheduled maintenance window: 2024-01-16 02:00-04:00 UTC"
  }
}

Ответ

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

Создать Scheduled Maintenance State Timeline

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

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

POST
/api/scheduled-maintenance-state-timeline
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "scheduledMaintenanceId": "c9d0e1f2-a3b4-5678-90ab-cdef01234567",
    "scheduledMaintenanceStateId": "d0e1f2a3-b4c5-6789-01ab-cdef12345678",
    "createdByUser": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "createdByUserId": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
  }
}

Ответ

{
  "_id": "3779cf10-28fe-11f1-b591-3fdcef396aba",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "scheduledMaintenanceId": "c9d0e1f2-a3b4-5678-90ab-cdef01234567",
  "scheduledMaintenanceStateId": "d0e1f2a3-b4c5-6789-01ab-cdef12345678",
  "createdByUser": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "createdByUserId": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
}
PUT/api/scheduled-maintenance-state-timeline/:id

Обновить по ID

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

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

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

POST/api/scheduled-maintenance-state-timeline/:id/update-item
GET/api/scheduled-maintenance-state-timeline/:id/update-item

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

PUT
/api/scheduled-maintenance-state-timeline/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "scheduledMaintenanceStateId": "d0e1f2a3-b4c5-6789-01ab-cdef12345678",
    "scheduledMaintenanceState": "d0e1f2a3-b4c5-6789-01ab-cdef12345678",
    "subscriberNotificationStatusMessage": "Maintenance notification sent to 152 subscribers. Scheduled maintenance window: 2024-01-16 02:00-04:00 UTC"
  }
}

Ответ

{}
DELETE/api/scheduled-maintenance-state-timeline/:id

Удалить по ID

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

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

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

POST/api/scheduled-maintenance-state-timeline/:id/delete-item
GET/api/scheduled-maintenance-state-timeline/:id/delete-item

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

DELETE
/api/scheduled-maintenance-state-timeline/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

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

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

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Read Scheduled Maintenance State Timeline
  • Read All Project Resources

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Create Scheduled Maintenance State Timeline

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Edit Scheduled Maintenance State Timeline

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Delete Scheduled Maintenance State Timeline