Ресурс

Scheduled Event Public Note

Manage public notes for your scheduled event

Модель Scheduled Event 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
Имя
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)
Имя
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/scheduled-maintenance-public-note/get-list

Список

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

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

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

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

query
Чтобы фильтровать Scheduled Event Public Note, укажите запрос здесь. Подробнее: написание запросов.
select
По умолчанию возвращается только ID; для других полей используйте select. Подробнее: как выбирать поля.
sort
По умолчанию сортировка по дате создания. Порядок можно изменить — см. раздел «Сортировка» в типах данных.

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

POST

/api/scheduled-maintenance-public-note/get-list?skip=0&limit=10

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "projectId": true,
    "scheduledMaintenanceId": true,
    "createdByUserId": true,
    "note": true,
    "postedAt": true
  },
  "query": {
    "postedFromSlackMessageId": "C1234567890:1234567890.123456"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "3778e4b0-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "scheduledMaintenanceId": "f6a7b8c9-d0e1-2345-f6a7-b8c9d0e12345",
      "createdByUserId": "b2c3d4e5-f6a7-8901-b2c3-d4e5f6a78901",
      "note": "## Maintenance Update\n\nThe scheduled maintenance is proceeding as planned. We expect to complete the database migration within the next hour.\n\n- Database migration: **In Progress**\n- Estimated completion: 2:00 PM UTC",
      "postedAt": "2024-01-15T14:30:00.000Z"
    },
    {
      "_id": "3778e4b1-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "scheduledMaintenanceId": "f6a7b8c9-d0e1-2345-f6a7-b8c9d0e12345",
      "createdByUserId": "b2c3d4e5-f6a7-8901-b2c3-d4e5f6a78901",
      "note": "## Maintenance Update\n\nThe scheduled maintenance is proceeding as planned. We expect to complete the database migration within the next hour.\n\n- Database migration: **In Progress**\n- Estimated completion: 2:00 PM UTC",
      "postedAt": "2024-01-15T14:30:00.000Z"
    },
    {
      "_id": "3778e4b2-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "scheduledMaintenanceId": "f6a7b8c9-d0e1-2345-f6a7-b8c9d0e12345",
      "createdByUserId": "b2c3d4e5-f6a7-8901-b2c3-d4e5f6a78901",
      "note": "## Maintenance Update\n\nThe scheduled maintenance is proceeding as planned. We expect to complete the database migration within the next hour.\n\n- Database migration: **In Progress**\n- Estimated completion: 2:00 PM UTC",
      "postedAt": "2024-01-15T14:30:00.000Z"
    }
  ]
}

GETorPOST/api/scheduled-maintenance-public-note/:id/get-item

Получить по ID

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

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

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

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

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

POST

/api/scheduled-maintenance-public-note/:id/get-item

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "projectId": true,
    "scheduledMaintenanceId": true,
    "createdByUserId": true,
    "note": true,
    "postedAt": true
  }
}

Ответ

{
  "_id": "3778e4b0-28fe-11f1-b591-3fdcef396aba",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "scheduledMaintenanceId": "f6a7b8c9-d0e1-2345-f6a7-b8c9d0e12345",
  "createdByUserId": "b2c3d4e5-f6a7-8901-b2c3-d4e5f6a78901",
  "note": "## Maintenance Update\n\nThe scheduled maintenance is proceeding as planned. We expect to complete the database migration within the next hour.\n\n- Database migration: **In Progress**\n- Estimated completion: 2:00 PM UTC",
  "postedAt": "2024-01-15T14:30:00.000Z"
}

POST/api/scheduled-maintenance-public-note/count

Количество

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

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

query
Чтобы фильтровать Scheduled Event Public Note, укажите запрос здесь. Подробнее: написание запросов.

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

POST

/api/scheduled-maintenance-public-note/count

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "query": {
    "postedFromSlackMessageId": "C1234567890:1234567890.123456"
  }
}

Ответ

{
  "count": 107
}

POST/api/scheduled-maintenance-public-note

Создать Scheduled Event Public Note

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

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

POST

/api/scheduled-maintenance-public-note

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "scheduledMaintenanceId": "f6a7b8c9-d0e1-2345-f6a7-b8c9d0e12345",
    "createdByUserId": "b2c3d4e5-f6a7-8901-b2c3-d4e5f6a78901",
    "note": "## Maintenance Update\n\nThe scheduled maintenance is proceeding as planned. We expect to complete the database migration within the next hour.\n\n- Database migration: **In Progress**\n- Estimated completion: 2:00 PM UTC",
    "postedAt": "2024-01-15T14:30:00.000Z"
  }
}

Ответ

{
  "_id": "3778e4b0-28fe-11f1-b591-3fdcef396aba",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "scheduledMaintenanceId": "f6a7b8c9-d0e1-2345-f6a7-b8c9d0e12345",
  "createdByUserId": "b2c3d4e5-f6a7-8901-b2c3-d4e5f6a78901",
  "note": "## Maintenance Update\n\nThe scheduled maintenance is proceeding as planned. We expect to complete the database migration within the next hour.\n\n- Database migration: **In Progress**\n- Estimated completion: 2:00 PM UTC",
  "postedAt": "2024-01-15T14:30:00.000Z"
}

PUT/api/scheduled-maintenance-public-note/:id

Обновить по ID

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

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

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

POST/api/scheduled-maintenance-public-note/:id/update-item

GET/api/scheduled-maintenance-public-note/:id/update-item

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

PUT

/api/scheduled-maintenance-public-note/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "note": "## Maintenance Update\n\nThe scheduled maintenance is proceeding as planned. We expect to complete the database migration within the next hour.\n\n- Database migration: **In Progress**\n- Estimated completion: 2:00 PM UTC",
    "postedAt": "2024-01-15T14:30:00.000Z",
    "subscriberNotificationStatusMessage": "Successfully sent notification to 150 subscribers"
  }
}

Ответ

{}

DELETE/api/scheduled-maintenance-public-note/:id

Удалить по ID

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

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

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

POST/api/scheduled-maintenance-public-note/:id/delete-item

GET/api/scheduled-maintenance-public-note/:id/delete-item

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

DELETE

/api/scheduled-maintenance-public-note/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

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

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

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

Нужны для чтения Scheduled Event Public Note

Project Owner
Project Admin
Project Member
Read Scheduled Maintenance Status Page Note
Read All Project Resources

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

Нужны для создания Scheduled Event Public Note

Project Owner
Project Admin
Project Member
Create Scheduled Maintenance Status Page Note

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

Нужны для обновления Scheduled Event Public Note

Project Owner
Project Admin
Project Member
Edit Scheduled Maintenance Status Page Note

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

Нужны для удаления Scheduled Event Public Note

Project Owner
Project Admin
Project Member
Delete Scheduled Maintenance Status Page Note