Status200
Ресурс

Scheduled Maintenance Note Template

Manage scheduled maintenance note templates for your project

Модель Scheduled Maintenance Note Template

Свойства

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

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

    Note template for public or private notes. This is in markdown.

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

    Name of the Incident Template

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

    Description of the Incident Template

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

GETorPOST/api/scheduled-maintenance-note-template/get-list

Список

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

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

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

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

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

POST
/api/scheduled-maintenance-note-template/get-list?skip=0&limit=10
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "projectId": true,
    "templateDescription": true,
    "templateName": true,
    "createdByUser": true,
    "createdByUserId": true
  },
  "query": {
    "templateDescription": "This template is used to document the completion of scheduled maintenance activities. It provides a structured format for summarizing the work performed, verifying system health, and communicating the maintenance outcome to stakeholders."
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "377980f0-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "templateDescription": "This template is used to document the completion of scheduled maintenance activities. It provides a structured format for summarizing the work performed, verifying system health, and communicating the maintenance outcome to stakeholders.",
      "templateName": "Maintenance Completion Summary",
      "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    {
      "_id": "377980f1-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "templateDescription": "This template is used to document the completion of scheduled maintenance activities. It provides a structured format for summarizing the work performed, verifying system health, and communicating the maintenance outcome to stakeholders.",
      "templateName": "Maintenance Completion Summary",
      "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    {
      "_id": "377980f2-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "templateDescription": "This template is used to document the completion of scheduled maintenance activities. It provides a structured format for summarizing the work performed, verifying system health, and communicating the maintenance outcome to stakeholders.",
      "templateName": "Maintenance Completion Summary",
      "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  ]
}
GETorPOST/api/scheduled-maintenance-note-template/:id/get-item

Получить по ID

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

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

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

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

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

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

Ответ

{
  "_id": "377980f0-28fe-11f1-b591-3fdcef396aba",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "templateDescription": "This template is used to document the completion of scheduled maintenance activities. It provides a structured format for summarizing the work performed, verifying system health, and communicating the maintenance outcome to stakeholders.",
  "templateName": "Maintenance Completion Summary",
  "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
POST/api/scheduled-maintenance-note-template/count

Количество

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

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

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

POST
/api/scheduled-maintenance-note-template/count
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "query": {
    "templateDescription": "This template is used to document the completion of scheduled maintenance activities. It provides a structured format for summarizing the work performed, verifying system health, and communicating the maintenance outcome to stakeholders."
  }
}

Ответ

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

Создать Scheduled Maintenance Note Template

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

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

POST
/api/scheduled-maintenance-note-template
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "templateDescription": "This template is used to document the completion of scheduled maintenance activities. It provides a structured format for summarizing the work performed, verifying system health, and communicating the maintenance outcome to stakeholders.",
    "templateName": "Maintenance Completion Summary",
    "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}

Ответ

{
  "_id": "377980f0-28fe-11f1-b591-3fdcef396aba",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "templateDescription": "This template is used to document the completion of scheduled maintenance activities. It provides a structured format for summarizing the work performed, verifying system health, and communicating the maintenance outcome to stakeholders.",
  "templateName": "Maintenance Completion Summary",
  "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
PUT/api/scheduled-maintenance-note-template/:id

Обновить по ID

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

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

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

POST/api/scheduled-maintenance-note-template/:id/update-item
GET/api/scheduled-maintenance-note-template/:id/update-item

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

PUT
/api/scheduled-maintenance-note-template/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "templateDescription": "This template is used to document the completion of scheduled maintenance activities. It provides a structured format for summarizing the work performed, verifying system health, and communicating the maintenance outcome to stakeholders.",
    "templateName": "Maintenance Completion Summary",
    "note": "## Scheduled Maintenance Update\n\n**Maintenance Window**: {{maintenance.scheduledAt}} - {{maintenance.endTime}}\n\n**Affected Services**: {{maintenance.services}}\n\n**Status**: The scheduled maintenance has been completed successfully. All systems are now operational.\n\n**Summary of Work Performed**:\n- Database schema upgrades applied\n- Security patches installed\n- Performance optimizations implemented\n\n**Verification**: All post-maintenance tests have passed. Services are running normally.\n\n**Next Scheduled Maintenance**: TBD"
  }
}

Ответ

{}
DELETE/api/scheduled-maintenance-note-template/:id

Удалить по ID

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

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

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

POST/api/scheduled-maintenance-note-template/:id/delete-item
GET/api/scheduled-maintenance-note-template/:id/delete-item

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

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

Ответ

{}

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

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

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Read Scheduled Maintenance Note Template
  • Read All Project Resources

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Create Scheduled Maintenance Note Template

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Edit Scheduled Maintenance Note Template

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Delete Scheduled Maintenance Note Template