qbpmdesigner
Version: 1.01.01-SNAPSHOT
/v1/{project}/products
GET
Summary
Получение дерева продуктов по параметрам
Description
Получение дерева продуктов по параметрам
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| project | path | Системное наименование проекта | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | [ TProductTypeForGet ] |
/v1/{project}/products/list
GET
Summary
Получение списка продуктов по параметрам
Description
Получение списка продуктов по параметрам
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| project | path | Системное наименование проекта | Yes | string |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | [ TProductTypeForGetList ] |
/v1/{project}/product
POST
Summary
Создание продукта
Description
Создание продукта
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| project | path | Системное наименование проекта | Yes | string |
| product | body | Продукт | Yes | TProductTypeForPost |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | TProductTypeForGet |
/v1/{project}/product/{id}
PUT
Summary
Изменение продукта
Description
Изменение продукта
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| project | path | Системное наименование проекта | Yes | string |
| id | path | ID продукта | Yes | long |
| product | body | Продукт | Yes | TProductTypeForPut |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | TProductTypeForGet |
DELETE
Summary
Удаление продукта
Description
Удаление продукта
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| project | path | Системное наименование проекта | Yes | string |
| id | path | ID продукта | Yes | long |
Responses
| Code | Description |
|---|---|
| 200 | OK |
GET
Summary
Получение списка продукта по идентификатору
Description
Получение списка продукта по идентификатору
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| project | path | Системное наименование проекта | Yes | string |
| id | path | ID продукта | Yes | long |
Responses
| Code | Description | Schema |
|---|---|---|
| 200 | OK | TProductTypeForGet |
/v1/{project}/product/{id}/deploy
POST
Summary
Деплой продукта
Description
Деплой продукта
Parameters
| Name | Located in | Description | Required | Schema |
|---|---|---|---|---|
| project | path | Системное наименование проекта | Yes | string |
| id | path | ID продукта | Yes | long |
| data | body | Параметры деплоя | Yes | TProductDeployParams |
Responses
| Code | Description |
|---|---|
| 200 | OK |
Models
TProductTypeForGet
Продукт
| Name | Type | Description | Required |
|---|---|---|---|
| id | long | ID продукта | No |
| sysName | string | Cистемное наименование продукта, поиск по частичному наименованию | No |
| name | string | Наименование продукта, поиск по частичному наименованию | No |
| description | string | Описание продукта | No |
| type | integer | Тип продукта | No |
| parentId | long | ID родительского продукта | No |
| accessModeId | integer | ID уровня доступа | No |
| participantAccesses | [ string ] | No | |
| applyParticipants | boolean | Применить права участника | No |
| children | [ TProductTypeForGet ] | No |
TProductTypeForGetList
Продукт
| Name | Type | Description | Required |
|---|---|---|---|
| id | long | ID продукта | No |
| sysName | string | Cистемное наименование продукта, поиск по частичному наименованию | No |
| name | string | Наименование продукта, поиск по частичному наименованию | No |
| description | string | Описание продукта | No |
| type | integer | Тип продукта | No |
| parentId | long | ID родительского продукта | No |
| accessModeId | integer | ID уровня доступа | No |
| participantAccesses | [ string ] | No | |
| applyParticipants | boolean | Применить права участника | No |
TProductTypeForPost
Продукт
| Name | Type | Description | Required |
|---|---|---|---|
| sysName | string | Системное наименование продукта | Yes |
| name | string | Наименование продукта | Yes |
| description | string | Краткое описание продукта | No |
| parentId | long | ID родительского продукта | No |
| type | integer | Тип продукта | No |
| applyParticipants | boolean | Применить права участника | No |
TProductTypeForPut
Продукт
| Name | Type | Description | Required |
|---|---|---|---|
| sysName | string | Системное наименование продукта | Yes |
| name | string | Наименование продукта | Yes |
| description | string | Краткое описание продукта | No |
| applyParticipants | boolean | Применить права участника | No |
TProductDeployParams
| Name | Type | Description | Required |
|---|---|---|---|
| diagramVersionIds | [ long ] | Индетификатооры версий диаграмм | Yes |
| configParams | object | key:value | No |
Product
| Name | Type | Description | Required |
|---|---|---|---|
| Product | object |