qbpmdesigner
Version: 1.01.01-SNAPSHOT
/v1/{project}/diagrams
GET
Summary
Получение списка диаграмм по параметрам
Description
Получение списка диаграмм по параметрам
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
project | path | Системное наименование проекта | Yes | string |
name | query | Наименование диаграммы | No | string |
sysName | query | Системное наименование диаграммы | No | [ string ] |
lastModifiedStartDate | query | Начальная дата изменения диаграммы | No | dateTime |
lastModifiedEndDate | query | Конечная дата изменения диаграммы | No | dateTime |
diagramType | query | Тип диаграммы | No | string |
lastVersionState | query | Состояние диаграммы | No | [ string ] |
productId | query | ID продукта | No | long |
diagramItemValue | query | Введенные значения для поиска элемента(ов) диаграммы/версии. | No | [ string ] |
diagramItemType | query | Тип элемента диаграммы (process, diagramItem, variable, null) | No | string |
lastVersionCreator | query | Полное имя пользователя создателя последней версии диаграммы | No | string |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | [ TDiagramTypeForGet ] |
/v1/{project}/diagram
POST
Summary
Создание новой диаграммы
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
project | path | Системное наименование проекта | Yes | string |
diagram | body | BPMN-диаграмма | Yes | TDiagramTypeForPost |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | TDiagramTypeForGet |
/v1/{project}/diagram/copy
POST
Summary
Копирование диаграммы
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
project | path | Системное наименование проекта | Yes | string |
regenerateItemId | query | Сгенерировать новые ID для элементов диаграммы | No | boolean |
diagramToCopy | body | диаграмма | Yes | TDiagramTypeForCopy |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | [ TDiagramTypeForGet ] |
/v2/{project}/diagram/copy
POST
Summary
Копирование диаграммы v2
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
project | path | Системное наименование проекта | Yes | string |
regenerateItemId | query | Сгенерировать новые ID для элементов диаграммы | No | boolean |
diagramsToCopyV2 | body | диаграммы | Yes | [ TDiagramTypeForCopyV2 ] |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | [ TDiagramTypeForGet ] |
/v1/{project}/diagram/{diagramId}
GET
Summary
Получение параметров диаграмм по ИД
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
project | path | Системное наименование проекта | Yes | string |
diagramId | path | ID диаграммы | Yes | long |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | TDiagramTypeForGet |
PUT
Summary
Изменение диаграммы
Parameters
Name | Located in | Description | Required | Schema |
---|---|---|---|---|
project | path | Системное наименование проекта | Yes | string |
diagramId | path | ID диаграммы | Yes | long |
diagram | body | ID диаграммы | Yes | TDiagramTypeForPut |
Responses
Code | Description | Schema |
---|---|---|
200 | OK | TDiagramTypeForGet |
Models
TDiagramTypeForGet
Диаграмма
Name | Type | Description | Required |
---|---|---|---|
id | long | ID диаграммы | No |
sysName | string | Cистемное наименование | No |
name | string | Наименование | No |
productId | long | ID продукта | No |
productName | string | Наименование продукта | No |
service | string | Наименование сервиса | No |
diagramType | string | Тип диаграммы | No |
description | string | Описание бизнес объекта | No |
labels | [ string ] | Массив меток | No |
lastVersionId | long | No | |
lastVersionNumber | string | No | |
lastVersionState | string | No | |
createdBy | string | Логин пользователя, создавший версию | No |
createdDate | dateTime | Дата - время создания | No |
lastVersionCreator | string | Полное имя пользователя, создавший версию | No |
lastModifiedBy | string | Логин пользователя, выполнивший изменений | No |
lastModifiedDate | dateTime | Дата- время последнего изменения | No |
lastVersionModifier | string | Полное имя пользователя, выполнивший изменений | No |
lastTenantId | string | Владелец диаграммы | No |
applyParticipants | boolean | Применить права участника | No |
participantAccesses | [ string ] | No |
TDiagramTypeForPost
Name | Type | Description | Required |
---|---|---|---|
name | string | Наименование | Yes |
sysName | string | Системное наименование | Yes |
productId | long | ID продукта | Yes |
service | string | Наименование сервиса | No |
diagramType | string | Тип диаграммы | No |
description | string | Описание диаграммы | No |
applyParticipants | boolean | Применить права участника | No |
labels | [ string ] | No |
TDiagramTypeForPut
Name | Type | Description | Required |
---|---|---|---|
name | string | Наименование | No |
sysName | string | Системное наименование | No |
diagramType | string | Тип диаграммы | No |
description | string | Описание | No |
productId | long | ID продукта | No |
service | string | Имя сервиса | No |
applyParticipants | boolean | Применить права участника | No |
labels | [ string ] | No |
TDiagramTypeForCopy
Name | Type | Description | Required |
---|---|---|---|
diagramVersionId | long | ID версии диаграммы | No |
productIdFrom | long | ID продукта откуда копируют | No |
productIdTo | long | ID выбранного продукта из выпадающего списка модального окна | Yes |
TDiagramTypeForCopyV2
Name | Type | Description | Required |
---|---|---|---|
name | string | Наименование | Yes |
sysName | string | Системное наименование | Yes |
service | string | Если параметр не передан во входящих параметрах, то используется сервис копируемой диаграммы | No |
diagramVersionId | long | Копируется указанная версия диаграммы | No |
diagramId | long | Копируется последняя версия указанной диаграммы | No |
productId | long | ID продукта куда копируют | Yes |
Diagram
Name | Type | Description | Required |
---|---|---|---|
Diagram | object |
DiagramWithLastVersion
Name | Type | Description | Required |
---|---|---|---|
DiagramWithLastVersion | object |