Операции API

Спецификация операции API фиксирует назначение, входные данные, ответы и ошибки. Связи с требованиями показывают, какое поведение обеспечивает этот контракт.
PR-80 · 1 / 7
Explore the FieldDesk REST API
1 из 7

Explore the FieldDesk REST API

Use the folder tree to narrow the API catalog to a product area. Start with Scheduling & Dispatch.

КАТАЛОГ API

Каталог операций API

Операции группируются по поверхностям API и папкам. Типы и метки помогают различать контракты по назначению.

Операцию можно найти по ключу, названию или техническому имени. В каталоге доступны фильтры, настройка столбцов и групповые действия.

Столбец Units показывает связанную реализацию и статусы соответствия, а Findings — замечания по операции.

Операции планирования FieldDesk в каталоге REST API со связями с кодом и замечаниями.
Операции планирования FieldDesk в каталоге REST API со связями с кодом и замечаниями.
КОНТЕКСТ ПРОДУКТА

Требования к поведению операции

На вкладке Requirements у операции назначения специалиста видны правила доступа и ограничения планирования.

Из требования можно перейти к полям данных и экранам, которые используют этот контракт.

При изменении правила проверьте, нужно ли обновить описание входных данных, ответа или ошибок.

Требования, связанные с операцией назначения специалиста.
Требования, связанные с операцией назначения специалиста.
Другие скриншоты
REQ-1: цель назначения, предусловия и критерии приёмки.

REQ-1: цель назначения, предусловия и критерии приёмки.

Связи REQ-1 с экранами, сущностями данных и операцией API.

Связи REQ-1 с экранами, сущностями данных и операцией API.

ПРОСЛЕЖИВАЕМОСТЬ РЕАЛИЗАЦИИ

Связь операции с исходным кодом

В Code видны юниты, которые реализуют контракт. Из карточки юнита можно открыть его исходные файлы.

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

Агент разработки может прочитать этот контекст через MCP в выбранной ветке и подсистеме.

Юниты серверной части и офисного приложения, связанные с назначением специалиста.
Юниты серверной части и офисного приложения, связанные с назначением специалиста.
Другие скриншоты
Исходный файл app/Actions/Scheduling/AssignTechnicianAction.php в карточке юнита.

Исходный файл app/Actions/Scheduling/AssignTechnicianAction.php в карточке юнита.

ИСТОРИЯ ИЗМЕНЕНИЙ

Редакции контракта

При сравнении редакций видны изменения технического имени, описания и других поддерживаемых полей.

Значок запроса на изменение ведёт к списку связанных работ. Журнал показывает, кто и когда менял операцию.

Зафиксируйте согласованный контракт, а последующие правки готовьте в новой редакции или отдельной ветке.

Историческая редакция операции по гарантийному обслуживанию, связанная с CR-1.
Историческая редакция операции по гарантийному обслуживанию, связанная с CR-1.

Связаться с нами

Поля, отмеченные *, обязательны для заполнения.

0 / 5 000

Можно также написать на info@reqode.com