Incident Note Template
Manage incident note templates for your project
Модель Incident 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)
/api/incident-note-template/get-listСписок
Этот метод возвращает постраничный список ваших объектов «Incident Note Template». По умолчанию на странице до десяти записей.
Необязательные query-параметры
limit- число
- Сколько объектов вернуть. По умолчанию 10, максимум 100
skip- число
- Сколько объектов пропустить (для пагинации)
Необязательное тело запроса
query- Чтобы фильтровать Incident Note Template, укажите запрос здесь. Подробнее: написание запросов.
select- По умолчанию возвращается только ID; для других полей используйте select. Подробнее: как выбирать поля.
sort- По умолчанию сортировка по дате создания. Порядок можно изменить — см. раздел «Сортировка» в типах данных.
Запрос списка
POST/api/incident-note-template/get-list?skip=0&limit=10Content-Type: application/json ApiKey: YOUR_API_KEY
{
"select": {
"projectId": true,
"templateDescription": true,
"templateName": true,
"createdByUser": true,
"createdByUserId": true
},
"query": {
"templateDescription": "This template is designed for documenting the root cause analysis of an incident. It helps teams identify the underlying cause, assess impact, document resolution steps, and establish preventive measures to avoid future occurrences."
},
"sort": {
"createdAt": -1
}
}Ответ
{
"count": 10,
"limit": 10,
"skip": 0,
"data": [
{
"_id": "37714390-28fe-11f1-b591-3fdcef396aba",
"projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
"templateDescription": "This template is designed for documenting the root cause analysis of an incident. It helps teams identify the underlying cause, assess impact, document resolution steps, and establish preventive measures to avoid future occurrences.",
"templateName": "Root Cause Analysis Template",
"createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
},
{
"_id": "37714391-28fe-11f1-b591-3fdcef396aba",
"projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
"templateDescription": "This template is designed for documenting the root cause analysis of an incident. It helps teams identify the underlying cause, assess impact, document resolution steps, and establish preventive measures to avoid future occurrences.",
"templateName": "Root Cause Analysis Template",
"createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
},
{
"_id": "37714392-28fe-11f1-b591-3fdcef396aba",
"projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
"templateDescription": "This template is designed for documenting the root cause analysis of an incident. It helps teams identify the underlying cause, assess impact, document resolution steps, and establish preventive measures to avoid future occurrences.",
"templateName": "Root Cause Analysis Template",
"createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
]
}/api/incident-note-template/:id/get-itemПолучить по ID
Возвращает объект «Incident Note Template» по идентификатору.
id- строка
- ID объекта
Необязательное тело запроса
select- По умолчанию возвращается только ID; для других полей используйте select. Подробнее: как выбирать поля.
Запрос одного объекта
POST/api/incident-note-template/:id/get-itemContent-Type: application/json ApiKey: YOUR_API_KEY
{
"select": {
"projectId": true,
"templateDescription": true,
"templateName": true,
"createdByUser": true,
"createdByUserId": true
}
}Ответ
{
"_id": "37714390-28fe-11f1-b591-3fdcef396aba",
"projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
"templateDescription": "This template is designed for documenting the root cause analysis of an incident. It helps teams identify the underlying cause, assess impact, document resolution steps, and establish preventive measures to avoid future occurrences.",
"templateName": "Root Cause Analysis Template",
"createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}/api/incident-note-template/countКоличество
Возвращает количество ваших объектов «Incident Note Template».
Необязательное тело запроса
query- Чтобы фильтровать Incident Note Template, укажите запрос здесь. Подробнее: написание запросов.
Запрос количества
POST/api/incident-note-template/countContent-Type: application/json ApiKey: YOUR_API_KEY
{
"query": {
"templateDescription": "This template is designed for documenting the root cause analysis of an incident. It helps teams identify the underlying cause, assess impact, document resolution steps, and establish preventive measures to avoid future occurrences."
}
}Ответ
{
"count": 107
}/api/incident-note-templateСоздать Incident Note Template
Создаёт новый объект.
Запрос создания
POST/api/incident-note-templateContent-Type: application/json ApiKey: YOUR_API_KEY
{
"data": {
"projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
"templateDescription": "This template is designed for documenting the root cause analysis of an incident. It helps teams identify the underlying cause, assess impact, document resolution steps, and establish preventive measures to avoid future occurrences.",
"templateName": "Root Cause Analysis Template",
"createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
}Ответ
{
"_id": "37714390-28fe-11f1-b591-3fdcef396aba",
"projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
"templateDescription": "This template is designed for documenting the root cause analysis of an incident. It helps teams identify the underlying cause, assess impact, document resolution steps, and establish preventive measures to avoid future occurrences.",
"templateName": "Root Cause Analysis Template",
"createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}/api/incident-note-template/:idОбновить по ID
Обновляет объект по ID.
Альтернативные методы
Если клиент не поддерживает PUT, используйте POST или GET с теми же заголовками и телом:
Запрос обновления
PUT/api/incident-note-template/:idContent-Type: application/json ApiKey: YOUR_API_KEY
{
"data": {
"templateDescription": "This template is designed for documenting the root cause analysis of an incident. It helps teams identify the underlying cause, assess impact, document resolution steps, and establish preventive measures to avoid future occurrences.",
"templateName": "Root Cause Analysis Template",
"note": "## Root Cause Analysis\n\n**Incident**: {{incident.title}}\n\n**Start Time**: {{incident.startedAt}}\n\n**Root Cause**: The incident was caused by a memory leak in the payment processing service that resulted in service degradation over time.\n\n**Impact**: Approximately 15% of payment transactions were affected during the incident window.\n\n**Resolution**: Restarted the affected service and deployed a hotfix to address the memory leak.\n\n**Preventive Measures**:\n- Added memory monitoring alerts\n- Implemented automated service restarts\n- Scheduled code review for memory management"
}
}Ответ
{}/api/incident-note-template/:idУдалить по ID
Удаляет объект по ID.
Альтернативные методы
Если клиент не поддерживает DELETE, используйте POST или GET с теми же заголовками и телом:
Запрос удаления
DELETE/api/incident-note-template/:idContent-Type: application/json ApiKey: YOUR_API_KEY
Ответ
{}Права доступа
Для операций с ресурсом у ключа API должны быть права. При их отсутствии вернётся ответ 4xx.
Права на чтение
Нужны для чтения Incident Note Template
Project OwnerProject AdminProject MemberRead Incident Note TemplateRead All Project Resources
Права на создание
Нужны для создания Incident Note Template
Project OwnerProject AdminProject MemberCreate Incident Note Template
Права на обновление
Нужны для обновления Incident Note Template
Project OwnerProject AdminProject MemberEdit Incident Note Template
Права на удаление
Нужны для удаления Incident Note Template
Project OwnerProject AdminProject MemberDelete Incident Note Template