Пункты шаблона ТО

Все операции. Авторизация. Запросы и повторы.

Все пути в этом файле дополняют /api/v1 на домене организации.

Описание и ограничения

Назначение

Состав работ внутри сценария обслуживания.

Поля и назначение

Обязательность и null указаны в схемах каждой операции ниже.

Доступ и выборка

maintenance_scenarios:read/write и права ТО; используемая работа должна быть доступна.

Правила и связи

• Пункт принадлежит scenario_id и используется только в применимых сценариях.
• Обязательность сохраняется в сохранённый снимок конкретной заявки.
• Удаление пункта шаблона не удаляет уже выполненные результаты.

Формат запросов и результат

• Публичная карточка содержит только id, scenario_id, operation_id, description, sort_order, is_required, is_active, version, updated_at.
• operation_id допускает null. Ручной пункт без работы требует непустого description; строка из пробелов не подходит. Наличие каталожной работы проверяется вместе со штатными правами её просмотра, отдельное разрешение подключения operations:read для записи ссылки не требуется.
• sort_order — неотрицательное JSON-целое, is_required/is_active — логические значения JSON. Строковые замены "1"/"true" не принимаются. Неизвестные поля отклоняются.
• Создание возвращает 201, изменение и архивация — 200. /delete принимает {} и устанавливает is_active=false; сохранённые результаты выполнения и ссылки на источник остаются целыми. Повтор архивации с новым ключом и актуальной версией не меняет данные.
• Список поддерживает общую курсорную пагинацию и фильтры filter[operation_id], filter[is_required], filter[is_active]. Логические фильтры используют строки true/false. GET карточки поддерживает ETag и If-None-Match после проверки доступа.
• Запись пункта и обновление updated_at родителя входят в одну транзакцию с результатом операции и событиями. Запрос без изменений не меняет версии и не порождает событий. Изменения шаблона не переписывают снимки уже начатых выполнений.
• Повтор проверяет текущий доступ к исходному и текущему родителю. Для оборудования после смены клиента или площадки прежняя запись об операции закрывается ответом 404. Физически удалённый штатной панелью пункт не создаётся заново при повторе ранее принятого POST; доступный исторический ответ возвращается по записи об операции.

Операции

GET /maintenance-scenarios/{parentId}/checklist-items

Список с фильтрами и пагинацией.

Доступ. Разрешения подключения: maintenance_scenarios:read. Права сотрудника: «ТОиР — Обслуживание → Просмотр». Дополнительно действуют доступ к записям, мастерским, модулям и условия полей из описания ресурса выше.

Параметры

Ответы

Каждый ответ содержит новый X-Request-Id в заголовке. Общие транспортные отказы и правила повтора действуют также при отказе до контроллера; см. ошибки.

Пример запроса

Запускается из каталога комплекта после настройки переменных в быстром старте. Замените демонстрационные идентификаторы 101 и UUID идентификаторами доступных записей. $RESOURCE_VERSION берётся из GET владельца версии, описанного выше. Для нового действия сохраните новый ключ; для повтора используйте прежний.

curl --silent --show-error --globoff \
  "$API/maintenance-scenarios/101/checklist-items" \
  --header "Authorization: Bearer $SERVICEAPP_TOKEN" \
  --header "Accept: application/json"

POST /maintenance-scenarios/{parentId}/checklist-items

Создание.

Доступ. Разрешения подключения: maintenance_scenarios:write. Права сотрудника: «ТОиР — Обслуживание → Изменение». Дополнительно действуют доступ к записям, мастерским, модулям и условия полей из описания ресурса выше.

Параметры

Тело запроса

Content-Type: application/json. Тело обязательно.

Ответы

Каждый ответ содержит новый X-Request-Id в заголовке. Общие транспортные отказы и правила повтора действуют также при отказе до контроллера; см. ошибки.

У принятого POST Location и meta.operation_id указывают на журнал операции; ETag отсутствует. При повторе запроса сохраняются исходные data/meta, добавляется Idempotency-Replayed: true. Версии передавайте по назначению, указанному в описании ресурса.

Пример запроса

Запускается из каталога комплекта после настройки переменных в быстром старте. Замените демонстрационные идентификаторы 101 и UUID идентификаторами доступных записей. $RESOURCE_VERSION берётся из GET владельца версии, описанного выше. Для нового действия сохраните новый ключ; для повтора используйте прежний.

curl --silent --show-error --globoff --request POST \
  "$API/maintenance-scenarios/101/checklist-items" \
  --header "Authorization: Bearer $SERVICEAPP_TOKEN" \
  --header "Accept: application/json" \
  --header "Idempotency-Key: example:v1-scenario-checklist-items-create:001" \
  --header "If-Resource-Version: $RESOURCE_VERSION" \
  --header "Content-Type: application/json" \
  --data-binary '@examples/requests/v1.scenario-checklist-items.create.json'

GET /maintenance-scenarios/{parentId}/checklist-items/{id}

Карточка.

Доступ. Разрешения подключения: maintenance_scenarios:read. Права сотрудника: «ТОиР — Обслуживание → Просмотр». Дополнительно действуют доступ к записям, мастерским, модулям и условия полей из описания ресурса выше.

Параметры

Ответы

Каждый ответ содержит новый X-Request-Id в заголовке. Общие транспортные отказы и правила повтора действуют также при отказе до контроллера; см. ошибки.

Пример запроса

Запускается из каталога комплекта после настройки переменных в быстром старте. Замените демонстрационные идентификаторы 101 и UUID идентификаторами доступных записей. $RESOURCE_VERSION берётся из GET владельца версии, описанного выше. Для нового действия сохраните новый ключ; для повтора используйте прежний.

curl --silent --show-error --globoff \
  "$API/maintenance-scenarios/101/checklist-items/101" \
  --header "Authorization: Bearer $SERVICEAPP_TOKEN" \
  --header "Accept: application/json"

POST /maintenance-scenarios/{parentId}/checklist-items/{id}/update

Изменение разрешённых полей.

Доступ. Разрешения подключения: maintenance_scenarios:write. Права сотрудника: «ТОиР — Обслуживание → Изменение». Дополнительно действуют доступ к записям, мастерским, модулям и условия полей из описания ресурса выше.

Параметры

Тело запроса

Content-Type: application/json. Тело обязательно.

Ответы

Каждый ответ содержит новый X-Request-Id в заголовке. Общие транспортные отказы и правила повтора действуют также при отказе до контроллера; см. ошибки.

У принятого POST Location и meta.operation_id указывают на журнал операции; ETag отсутствует. При повторе запроса сохраняются исходные data/meta, добавляется Idempotency-Replayed: true. Версии передавайте по назначению, указанному в описании ресурса.

Пример запроса

Запускается из каталога комплекта после настройки переменных в быстром старте. Замените демонстрационные идентификаторы 101 и UUID идентификаторами доступных записей. $RESOURCE_VERSION берётся из GET владельца версии, описанного выше. Для нового действия сохраните новый ключ; для повтора используйте прежний.

curl --silent --show-error --globoff --request POST \
  "$API/maintenance-scenarios/101/checklist-items/101/update" \
  --header "Authorization: Bearer $SERVICEAPP_TOKEN" \
  --header "Accept: application/json" \
  --header "Idempotency-Key: example:v1-scenario-checklist-items-update:001" \
  --header "If-Resource-Version: $RESOURCE_VERSION" \
  --header "Content-Type: application/json" \
  --data-binary '@examples/requests/v1.scenario-checklist-items.update.json'

POST /maintenance-scenarios/{parentId}/checklist-items/{id}/delete

Архивация или удаление с проверкой зависимостей.

Доступ. Разрешения подключения: maintenance_scenarios:write. Права сотрудника: «ТОиР — Обслуживание → Изменение». Дополнительно действуют доступ к записям, мастерским, модулям и условия полей из описания ресурса выше.

Параметры

Тело запроса

Content-Type: application/json. Тело обязательно.

Тело — пустой JSON-объект {}. Другие ключи не принимаются.

Ответы

Каждый ответ содержит новый X-Request-Id в заголовке. Общие транспортные отказы и правила повтора действуют также при отказе до контроллера; см. ошибки.

У принятого POST Location и meta.operation_id указывают на журнал операции; ETag отсутствует. При повторе запроса сохраняются исходные data/meta, добавляется Idempotency-Replayed: true. Версии передавайте по назначению, указанному в описании ресурса.

Пример запроса

Запускается из каталога комплекта после настройки переменных в быстром старте. Замените демонстрационные идентификаторы 101 и UUID идентификаторами доступных записей. $RESOURCE_VERSION берётся из GET владельца версии, описанного выше. Для нового действия сохраните новый ключ; для повтора используйте прежний.

curl --silent --show-error --globoff --request POST \
  "$API/maintenance-scenarios/101/checklist-items/101/delete" \
  --header "Authorization: Bearer $SERVICEAPP_TOKEN" \
  --header "Accept: application/json" \
  --header "Idempotency-Key: example:v1-scenario-checklist-items-delete:001" \
  --header "If-Resource-Version: $RESOURCE_VERSION" \
  --header "Content-Type: application/json" \
  --data-binary '@examples/requests/v1.scenario-checklist-items.delete.json'