Ресурс

Incident Postmortem Template

Manage postmortem templates for your incidents

Модель Incident Postmortem 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
Имя
postmortemNote
Тип
Markdown
Описание
Markdown template used when documenting an incident postmortem.
Имя
templateName
Тип
TextОбязательно
Описание
Name of the Postmortem Template
Имя
templateDescription
Тип
Long TextОбязательно
Описание
Description of the Postmortem 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/incident-postmortem-template/get-list

Список

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

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

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

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

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

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

POST

/api/incident-postmortem-template/get-list?skip=0&limit=10

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "projectId": true,
    "templateDescription": true,
    "templateName": true,
    "_id": true,
    "createdAt": true
  },
  "query": {
    "templateDescription": "Example template description"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "37716aa0-28fe-11f1-b591-3fdcef396aba",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "templateDescription": "Example template description",
      "templateName": "Example name",
      "createdAt": "2024-01-15T10:30:00.000Z"
    },
    {
      "_id": "37716aa1-28fe-11f1-b591-3fdcef396aba",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "templateDescription": "Example template description",
      "templateName": "Example name",
      "createdAt": "2024-01-15T10:30:00.000Z"
    },
    {
      "_id": "37716aa2-28fe-11f1-b591-3fdcef396aba",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "templateDescription": "Example template description",
      "templateName": "Example name",
      "createdAt": "2024-01-15T10:30:00.000Z"
    }
  ]
}

GETorPOST/api/incident-postmortem-template/:id/get-item

Получить по ID

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

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

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

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

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

POST

/api/incident-postmortem-template/:id/get-item

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "projectId": true,
    "templateDescription": true,
    "templateName": true,
    "_id": true,
    "createdAt": true
  }
}

Ответ

{
  "_id": "550e8400-e29b-41d4-a716-446655440000",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "templateDescription": "Example template description",
  "templateName": "Example name",
  "createdAt": "2024-01-15T10:30:00.000Z"
}

POST/api/incident-postmortem-template/count

Количество

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

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

query
Чтобы фильтровать Incident Postmortem Template, укажите запрос здесь. Подробнее: написание запросов.

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

POST

/api/incident-postmortem-template/count

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "query": {
    "templateDescription": "Example template description"
  }
}

Ответ

{
  "count": 107
}

POST/api/incident-postmortem-template

Создать Incident Postmortem Template

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

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

POST

/api/incident-postmortem-template

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "projectId": "550e8400-e29b-41d4-a716-446655440000",
    "templateDescription": "Example template description",
    "templateName": "Example name",
    "createdByUser": "Example created by user",
    "createdByUserId": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Ответ

{
  "_id": "550e8400-e29b-41d4-a716-446655440000",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "templateDescription": "Example template description",
  "templateName": "Example name",
  "createdAt": "2024-01-15T10:30:00.000Z"
}

PUT/api/incident-postmortem-template/:id

Обновить по ID

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

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

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

POST/api/incident-postmortem-template/:id/update-item

GET/api/incident-postmortem-template/:id/update-item

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

PUT

/api/incident-postmortem-template/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "templateDescription": "Example template description",
    "templateName": "Example name",
    "postmortemNote": "Example postmortem note content"
  }
}

Ответ

{}

DELETE/api/incident-postmortem-template/:id

Удалить по ID

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

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

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

POST/api/incident-postmortem-template/:id/delete-item

GET/api/incident-postmortem-template/:id/delete-item

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

DELETE

/api/incident-postmortem-template/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

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

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

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

Нужны для чтения Incident Postmortem Template

Project Owner
Project Admin
Project Member
Read Incident Note Template
Read All Project Resources

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

Нужны для создания Incident Postmortem Template

Project Owner
Project Admin
Project Member
Create Incident Note Template

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

Нужны для обновления Incident Postmortem Template

Project Owner
Project Admin
Project Member
Edit Incident Note Template

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

Нужны для удаления Incident Postmortem Template

Project Owner
Project Admin
Project Member
Delete Incident Note Template