Status200
Ресурс

Alert Note Template

Manage alert note templates for your project

Модель Alert 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 Status200 Project in which this object belongs

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

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

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

    Name of the Alert Template

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

    Description of the Alert 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/alert-note-template/get-list

Список

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

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

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

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

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

POST
/api/alert-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 for documenting the initial investigation phase of an alert. It includes sections for analyzing the issue, documenting findings, and outlining next steps for resolution."
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "376cafb0-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "templateDescription": "This template is used for documenting the initial investigation phase of an alert. It includes sections for analyzing the issue, documenting findings, and outlining next steps for resolution.",
      "templateName": "Initial Investigation Template",
      "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    {
      "_id": "376cafb1-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "templateDescription": "This template is used for documenting the initial investigation phase of an alert. It includes sections for analyzing the issue, documenting findings, and outlining next steps for resolution.",
      "templateName": "Initial Investigation Template",
      "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    {
      "_id": "376cafb2-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "templateDescription": "This template is used for documenting the initial investigation phase of an alert. It includes sections for analyzing the issue, documenting findings, and outlining next steps for resolution.",
      "templateName": "Initial Investigation Template",
      "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  ]
}
GETorPOST/api/alert-note-template/:id/get-item

Получить по ID

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

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

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

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

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

POST
/api/alert-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": "376cafb0-28fe-11f1-b591-3fdcef396aba",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "templateDescription": "This template is used for documenting the initial investigation phase of an alert. It includes sections for analyzing the issue, documenting findings, and outlining next steps for resolution.",
  "templateName": "Initial Investigation Template",
  "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
POST/api/alert-note-template/count

Количество

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

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

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

POST
/api/alert-note-template/count
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "query": {
    "templateDescription": "This template is used for documenting the initial investigation phase of an alert. It includes sections for analyzing the issue, documenting findings, and outlining next steps for resolution."
  }
}

Ответ

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

Создать Alert Note Template

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

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

POST
/api/alert-note-template
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "templateDescription": "This template is used for documenting the initial investigation phase of an alert. It includes sections for analyzing the issue, documenting findings, and outlining next steps for resolution.",
    "templateName": "Initial Investigation Template",
    "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}

Ответ

{
  "_id": "376cafb0-28fe-11f1-b591-3fdcef396aba",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "templateDescription": "This template is used for documenting the initial investigation phase of an alert. It includes sections for analyzing the issue, documenting findings, and outlining next steps for resolution.",
  "templateName": "Initial Investigation Template",
  "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
PUT/api/alert-note-template/:id

Обновить по ID

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

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

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

POST/api/alert-note-template/:id/update-item
GET/api/alert-note-template/:id/update-item

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

PUT
/api/alert-note-template/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {
    "templateDescription": "This template is used for documenting the initial investigation phase of an alert. It includes sections for analyzing the issue, documenting findings, and outlining next steps for resolution.",
    "templateName": "Initial Investigation Template",
    "note": "## Alert Investigation\n\n**Issue**: {{alert.title}}\n\n**Time**: {{alert.createdAt}}\n\n**Analysis**: Initial investigation shows that the alert was triggered due to high CPU usage on the production server. The team is currently investigating the root cause.\n\n**Next Steps**:\n- Monitor system metrics\n- Review application logs\n- Check for memory leaks"
  }
}

Ответ

{}
DELETE/api/alert-note-template/:id

Удалить по ID

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

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

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

POST/api/alert-note-template/:id/delete-item
GET/api/alert-note-template/:id/delete-item

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

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

Ответ

{}

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

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

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Read Alert Note Template
  • Read All Project Resources

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Create Alert Note Template

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Edit Alert Note Template

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Delete Alert Note Template