qbpmdesigner

Version: 1.01.01-SNAPSHOT

/v1/{project}/diagram-versions

GET

Summary

Список версий диаграмм

Parameters

Name	Located in	Description	Required	Schema
project	path	Системное наименование проекта	Yes	string
diagramItemValue	query	Введенные значения для поиска элемента(ов) диаграммы/версии.	No	[ string ]
diagramItemType	query	Тип элемента диаграммы (process, diagramItem, variable, null)	No	string

Responses

Code	Description	Schema
200	OK	[ TDiagramVersionTypeForGet ]

/v1/{project}/diagram-versions/items

POST

Summary

Полные данные о диаграммах

Parameters

Name	Located in	Description	Required	Schema
project	path	Системное наименование проекта	Yes	string
request	body	Параметры запроса	No	DiagramVersionsInfoRequest

Responses

Code	Description	Schema
200	OK	DiagramVersionsInfo

/v1/{project}/diagram-version

POST

Summary

Создание новой версии диаграммы

Parameters

Name	Located in	Description	Required	Schema
project	path	Системное наименование проекта	Yes	string
diagramVersion	body	Версия диаграммы	Yes	TDiagramVersionTypeForPOST

Responses

Code	Description	Schema
200	OK	TDiagramVersionTypeForPOSTResp

/v1/{project}/diagram-version/{id}

PUT

Summary

Изменение версии диаграммы

Parameters

Name	Located in	Description	Required	Schema
project	path	Системное наименование проекта	Yes	string
id	path	ID версии	Yes	long
diagramVersion	body	Версия диаграммы	Yes	TDiagramVersionTypeForPUT

Responses

Code	Description	Schema
200	OK	TDiagramVersionTypeForPUTResponse

GET

Summary

Версия диаграммы по идентификатору

Parameters

Name	Located in	Description	Required	Schema
project	path	Системное наименование проекта	Yes	string
id	path	ID версии диаграммы	Yes	long

Responses

Code	Description	Schema
200	OK	TDiagramVersionTypeForGetId

DELETE

Summary

Удаление версия диаграммы по идентификатору

Parameters

Name	Located in	Description	Required	Schema
project	path	Системное наименование проекта	Yes	string
id	path	ID версии диаграммы	Yes	long

Responses

Code	Description
200	OK

/v1/{project}/diagram-version/{id}/archive

PUT

Summary

Архивирование версии диаграммы по идентификатору

Parameters

Name	Located in	Description	Required	Schema
project	path	Системное наименование проекта	Yes	string
id	path	ID версии диаграммы	Yes	long

Responses

Code	Description
200	OK

/v1/{project}/diagram-versions/archive

PUT

Summary

Массовое архивирование версий диаграмм

Parameters

Name	Located in	Description	Required	Schema
project	path	Системное наименование проекта	Yes	string
diagramsArchive	body	Массовое архивирование версий диаграмм	Yes	TDiagramsArchive

Responses

Code	Description	Schema
200	OK	[ TDiagramsArchiveResponse ]

/v1/{project}/diagram-version/{id}/public

PUT

Summary

Публикация версии диаграммы

Parameters

Name	Located in	Description	Required	Schema
project	path	Системное наименование проекта	Yes	string
id	path	ID версии	Yes	long

Responses

Code	Description
200	OK

/v1/{project}/diagram-version/{id}/verification

POST

Summary

Согласование версии диаграммы

Parameters

Name	Located in	Description	Required	Schema
project	path	Системное наименование проекта	Yes	string
id	path	ID версии	Yes	long
diagramVerification	body	Согласование версии диаграммы	Yes	TDiagramVerificationForPOST

Responses

Code	Description	Schema
200	OK	TDiagramVerificationForGET

/v1/{project}/diagram-version/{id}/process/{processId}/interactions-map

GET

Summary

Карта внешних взаимодействий процесса

Parameters

Name	Located in	Description	Required	Schema
project	path	Системное наименование проекта	Yes	string
id	path	ID версии диаграммы	Yes	long
processId	path	ID процесса	Yes	string

Responses

Code	Description	Schema
200	OK	[ TExternalInteractionsNode ]

Models

TDiagramVersionTypeForPOST

Версия диаграммы

Name	Type	Description	Required
diagramId	long	ID диаграммы	Yes
content	string	Контент диаграммы	Yes
svg	string	SVG диаграммы	No
comment	string	Комментарий для краткой информации об изменениях в данной версии	No
sourceDiagramVersionId	long	ID диаграммы источника	No
milestones	[ TMilestoneTypeForDiagramVersionPOST ]	Cписок версий milestones, входящих в версию бизнес процесса	No

TDiagramVersionTypeForPUTResponse

Версия диаграммы

Name	Type	Description	Required
id	long		Yes
diagramId	long	ID диаграммы	Yes
content	string	Контент диаграммы	Yes
svg	string	SVG диаграммы	No
comment	string	Комментарий для краткой информации об изменениях в данной версии	No
milestones	[ TMilestoneTypeForDiagramVersionPOST ]	Cписок версий milestones, входящих в версию бизнес процесса	No

TDiagramVersionTypeForPUT

Версия диаграммы

Name	Type	Description	Required
content	string	Контент диаграммы	Yes
svg	string	SVG диаграммы	No
comment	string	Комментарий для краткой информации об изменениях в данной версии	No
milestones	[ TMilestoneTypeForDiagramVersionPUT ]		No
autoSave	boolean	Признак автоматического сохранения версии	No

TDiagramVersionTypeForPOSTResp

Name	Type	Description	Required
id	long	ID созданой версии диаграммы	No
version	integer		No
milestones	[ TMilestoneTypeForDiagramVersionResp ]		No

TDiagramVersionTypeForGet

Name	Type	Description	Required
id	long	ID версии	No
diagramId	long	ID диаграммы	No
version	integer	Номер версии	No
content	string	Контент диаграммы	No
svg	string	SVG диаграммы	No
state	string	Состояние	No
comment	string	Комментарий для краткой информации об изменениях в данной версии	No
createdBy	string	Пользователь, создавший версию	No
createdDate	dateTime	Дата - время создания	No
creator	string	Пользователь, создавший версию	No
lastModifiedBy	string	Логин пользователя, выполнивший изменений	No
lastModifiedDate	dateTime	Дата- время последнего изменения	No
modifier	string	Полное имя пользователя, выполнивший изменений	No
publishDate	dateTime	Дата - время публикации	No
publishBy	string	Пользователь, выполнивший публикацию	No
publishDetails	string	Детальная информация о статусе публикации	No
tenantId	string	Владелец диграммы	No
isVerify	boolean	Флаг верификации	No
participantAccesses	[ string ]		No

TDiagramVersionTypeForGetId

Name	Type	Description	Required
id	long	ID версии	No
diagramId	long	ID диаграммы	No
version	integer	Номер версии	No
content	string	Контент диаграммы	No
svg	string	SVG диаграммы	No
state	string	Состояние	No
comment	string	Комментарий для краткой информации об изменениях в данной версии	No
createdBy	string	Логин пользователя, создавший версию	No
createdDate	dateTime	Дата - время создания	No
creator	string	Пользователь, создавший версию	No
lastModifiedBy	string	Логин пользователя, выполнивший изменений	No
lastModifiedDate	dateTime	Дата- время последнего изменения	No
modifier	string	Полное имя пользователя, выполнивший изменений	No
publishDate	dateTime	Дата - время публикации	No
publishBy	string	Пользователь, выполнивший публикацию	No
publishDetails	string	Детальная информация о статусе публикации	No
participantAccesses	[ string ]		No
milestones	[ TMilestoneTypeForDiagramVersionGet ]		No
tenantId	string	Владелец диграммы	No
isVerify	boolean	Флаг верификации	No

TMilestoneTypeForDiagramVersionGet

Name	Type	Description	Required
id	long	ID milestone	No
linkId	string	ID связи = ID bpmn элемента, соответствующего milestone на общей диаграмме	No
versionId	long	ID версии milestone	No
name	string	Полное наименование milestone	No
sysName	string	Системное наименование milestone	No
description	string	Описание milestone	No
version	integer	Номер версии модели	No
definitionId	string	ID process definition, присвоенный milestone при публикации в микросервисе	No
objectModelId	string	Ссылка на связанный Business Object (обязательно при публикации)	No
objectModelSysName	string	Наименование связанного Business Object	No
objectModelVersionId	string	Версия связанного Business Object	No
service	string	Наименование микросервиса, предназначенного для исполнения milestone	No
state	string	Состояние версии	No
publishDate	dateTime	Дата- время публикации модели	No
publishDetails	string	Детальная информация о статусе публикации (записывается текст ошибки)	No

TMilestoneTypeForDiagramVersionPOST

Name	Type	Description	Required
linkId	string	ID связи = ID bpmn элемента, соответствующего milestone на общей диаграмме	Yes
id	long	ID milestone	No
name	string	Полное наименование milestone	No
sysName	string	Системное наименование milestone	No
description	string	Описание milestone	No
objectModelId	string	Ссылка на связанный Business Object (обязательно при публикации)	No
objectModelSysName	string	Наименование связанного Business Object	No
objectModelVersionId	string	Версия связанного Business Object	No
service	string	Наименование микросервиса, предназначенного для исполнения milestone	No

TMilestoneTypeForDiagramVersionPUT

Name	Type	Description	Required
linkId	string	ID связи = ID bpmn элемента, соответствующего milestone на общей диаграмме	Yes
id	long	ID milestone	No
versionId	long	ID версии milestone	No
name	string	Полное наименование milestone	No
sysName	string	Системное наименование milestone	No
description	string	Описание milestone	No
objectModelId	string	Ссылка на связанный Business Object (обязательно при публикации)	No
objectModelSysName	string	Наименование связанного Business Object	No
objectModelVersionId	string	Версия связанного Business Object	No
service	string	Наименование микросервиса, предназначенного для исполнения milestone	No

TMilestoneTypeForDiagramVersionResp

Name	Type	Description	Required
linkId	string	ID связи	No
id	long	ID milestone	No
versionId	long	ID версии milestone	No
version	integer	Номер версии milestone	No

DiagramVersionsInfoRequest

Name	Type	Description	Required
diagramVersionIds	[ long ]		No
diagramIds	[ long ]		No

DiagramVersionsInfo

Name	Type	Description	Required
diagramVersionInfo	[ DiagramVersionsInfoItem ]		No

DiagramVersionsInfoItem

Name	Type	Description	Required
diagramType	string	Тип даграммы	No
diagramId	long	Иденнтификатор диаграммы	No
id	long	ID версии диаграммы	No
sysName	string	Системное наименование диаграммы	No
deploymentId	string	ID развертывания	No
mainPath	string	Сылка на основной узел	No
resultPath	string	Ссылка на узлел, задающий результат	No
errorPath	string	Ссылка на узел, задающий узел завершения с ошибкой	No
diagramParams	[ DiagramParam ]		No
nodes	[ DiagramNode ]		No

DiagramParam

Name	Type	Description	Required
id	string	ID параметра	No
sysName	string	Системное имя	No
name	string	Имя	No
valueType	string	Тип значения	No
inputFlag	boolean	Признак входящего параметра	No
decisionResultFlag	boolean	Признак необходимости получения результата по параметру в формате правила	No
imported	boolean	Признак автоматической загрузки параметра из правила/процесса	No

DiagramNode

Name	Type	Description	Required
diagramPath	string	:Ссылка на узел правила/процесса	No
nodeType	string	Тип узла	No
logic	object	json-описание логики	No

TDiagramVerificationForPOST

Name	Type	Description	Required
isVerify	boolean	Флаг верификации	Yes

TDiagramVerificationForGET

Name	Type	Description	Required
id	long	ID записи верификации	No
userLogin	string	Логин пользователя	No
diagramVersionId	long	ID версии диаграммы	No
isVerify	boolean	Флаг верификации	No
verifyDate	dateTime	Дата верификации	No

TExternalInteractionsNode

Name	Type	Description	Required
data	object	Данные узла	No

TDiagramsArchive

Name	Type	Description	Required
diagramVersionIds	[ long ]		No

TDiagramsArchiveResponse

Name	Type	Required
diagramVersionId	long	No
status	string	No
message	string	No

DiagramVersion

Name	Type	Description	Required
DiagramVersion	object

Шаблоны диаграмм Диаграммы