Метод «Изменить атрибуты шага»

Endpoint: PATCH {hostname}/ldm-flex-approval-service/api/v1/routes/{routeId}/blocks/{blockId}/stages/{stageId}/steps/{stepId}

Метод позволяет изменить атрибуты шага по идентификаторам маршрута, блока маршрута, этапа и шага.

Более подробное описание метода находится в yaml файле «flex-approval -service», который расположен в папке с документацией.

Маппинг параметров запроса

Входящие параметры Способ передачи параметров Требования к заполнению
routeId Path Идентификатор маршрута (id), полученный методом GET {hostname}/ldm-flex-approval-service/api/v1/routes
blockId Path Идентификатор блока маршрута (id), полученный методом GET {hostname}/ldm-flex-approval-service/api/v1/routes/{routeId}/blocks
stageId Path Идентификатор этапа (id), полученный методом GET {hostname}/ldm-flex-approval-service/api/v1/routes/{routeId}/blocks/{blockId}/stages
stepId Path Идентификатор шага (id), полученный методом GET {hostname}/ldm-flex-approval-service/api/v1/routes/{routeId}/blocks/{blockId}/stages/{stageId}/steps
callbacksBefore Body Массив URI на пре-обратные вызовы (FlexRouteCallback ldm-system-objects-service)
callbacksAfter Body Массив URI на пост-обратные вызовы (FlexRouteCallback ldm-system-objects-service)
code Body Ссылочный код шага
name Body Пользовательское наименование шага
taskTemplateCode Body Код шаблона поручения, на основе которого будет создана задача
taskTemplateId Body Идентификатор шаблона поручения, на основе которого будет создана задача
enabledReportClassCode Body Ожидаемый класс отчета (вид блокировки)
inputVariablesMap:
· additionalProp1
· additionalProp2
· additionalProp3
Body Маппинг переменных окружения
outputVariablesMap:
· additionalProp1
· additionalProp2
· additionalProp3
Body Маппинг переменных отчета окружения
initVariables:
· additionalProp1
· additionalProp2
· additionalProp3
Body Массив переменных, который инициализируется каждый раз при старте или перезапуске шага
assignee Body Поручитель
candidateUsers Body Пользователи, которые могут быть назначенными на выполнение задачи/поручение
candidateGroups Body Группы, участники (пользователи) которых могут быть назначены на выполнение задачи/поручение
assigneeMark Body Обратный вызов определения получателей задачи
reportReceiver Body Бизнес-сущность получателя отчета по задаче/поручения
reportReceiverMark Body Обратный вызов получателя отчета по задаче/поручения
taskName Body Наименование создаваемой задачи
dueToDuration Body Продолжительность выполнения задачи
resultPropertyCode Body Маппинг на поле «Результат» в переменных поручения
taskCompletionType Body Тип завершения задачи/поручения:
· NO_CHECK (используется по умолчанию) – проверка отчета не выполняется;
· TEXT – отчет должен содержать текстовую информацию и может содержать файл;
· TEXT_ONLY – отчет должен содержать только текст;
· FILE – отчет должен содержать файл и может содержать текст;
· FILE_AND_TEXT – отчет должен содержать и файл и текст
taskReportCheck Body Тип проверки отчета по созданному поручению:
· SIMPLE (используется по умолчанию) – задача не требует отчета при завершении;
· WITH_REPORT – для завершения задачи требуется отчет, но сам отчет не требует подтверждения;
· CONTROLED – для завершения задачи требуется отчет и приемка отчета
insertAfterId Body Идентификатор элемента, после которого необходимо вставить новый
insertAfterCode Body Ссылочный код элемента, после которого надо вставить новый

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

curl –location PATCH 'https://docshouse-test.k8s.lan.lanit.ru/dh-gateway-api-service/ldm-flex-approval-service/api/v1/routes/6dfb1d73-56e7-4979-af2d-439aee1266ff/blocks/5e9de2c0-441b-4253-b8d8-d59ff3673b6b/stages/6b9c260b-b85b-41ac-bb1c-009be62c065e/steps/da2173a7-9a92-4442-9217-c80a2fae288b' \

 -header 'accept: application/json' \

 -header 'Content-Type: application/json' \

 -data '{

 "callbacksBefore": [

  "string"

 ],

 "callbacksAfter": [

  "string"

 ],

 "code": "string",

 "name": "string",

 "taskTemplateCode": "string",

 "taskTemplateId": "string",

 "enabledReportClassCode": "string",

 "inputVariablesMap": {

  "additionalProp1": "string",

  "additionalProp2": "string",

  "additionalProp3": "string"

 },

 "outputVariablesMap": {

  "additionalProp1": "string",

  "additionalProp2": "string",

  "additionalProp3": "string"

 },

 "initVariables": {

  "additionalProp1": "string",

  "additionalProp2": "string",

  "additionalProp3": "string"

 },

 "assignee": "string",

 "candidateUsers": [

  "string"

 ],

 "candidateGroups": [

  "string"

 ],

 "assigneeMark": "string",

 "reportReceiver": "string",

 "reportReceiverMark": "string",

 "taskName": "string",

 "dueToDuration": "string",

 "resultPropertyCode": "string",

 "taskCompletionType": "NO_CHECK",

 "taskReportCheck": "SIMPLE",

 "insertAfterId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

 "insertAfterCode": "string"

}'