...
| Name | Data Type | Required | Description | Comment |
|---|---|---|---|---|
| id | String | Yes | Unique UUID of the workflow saved |
Get
...
Extend BPMN
...
Activites (from Catalog)
Get the brief Information of extend Activities detail informtion of the extend BPMN activities such as 'Stop Traffic', 'Stop VNF', 'Create VNF', etc.
These informations will describe the details of the activities which can be deployed to the workflow engine. At the same time the activity's detail information will be used to generate the BPMN artifacts.
URL:
| Code Block | ||
|---|---|---|
| ||
GET http://{sdc-ip}:{port}/api/sdc/v1/workflow-modeler/ext-activity-brief-infosactivities |
Request:
...
Path Parameters:
| Name | Data Type | Required | Description | Comment |
|---|
id |
| String | Yes |
the scene of the workflow designer. Valid value as follow:
resource - open a VNF's workflow
service - open a Service's workflow
Uniqued id of the extend bpmn activity. |
Response:
Return the brief/base Information List of ExtendActivities, for details to see the 'ExtendActivityBriefInfo' data model.
...
detail information of the extend activities. see data model 'ExtendActivity' for details.
Get Category Information of Extend BPMN
...
Activities (from Catalog)
Get the detail informtion of group category of extend Activities. If the extend BPMN activities. Thes information will describe the details of the activities deployed to the workflow engine and will be used to generate the BPMN artifactsactivities have category informations, the WF Designer will organize and display extend activities in categories.
URL:
| Code Block | ||
|---|---|---|
| ||
GET http://{sdc-ip}:{port}/api/sdc/v1/workflow-modeler/ext-activity-activitiescategories |
Request:
Path Parameters:
Query Parameters:
| Name | Data Type | Required | Description | Comment |
|---|---|---|---|---|
| scene | Enum | Yes | the scene of the workflow designer. Valid value as follow: resource - open a VNF's workflow service - open a Service's workflow | different scene may has different activities extend. |
Response:
| Name | Data Type | Required | Description | Comment |
|---|
id| nodes | Map<String, CategoryInfo> | Yes |
Category Informations of the extend activities. key – extend activity id value - Category Informations of the extend |
Response:
...
activity | ||||
| categoryData | Map<String, CategoryData> | Yes | Category Data of the group. key - Category id value - Category Data |
CategoryInfo:
| Name | Data Type | Required | Description | Comment |
|---|---|---|---|---|
| category | String | No | Category id of the extend activity. |
CategoryData:
| Name | Data Type | Required | Description | Comment |
|---|---|---|---|---|
| name | String | Yes | Category name. |
Data Model
WorkflowInfo
| Name | Data Type | Required | Description | Comment |
|---|---|---|---|---|
id | String | Yes | Unique UUID of the workflow | |
| name | String | Yes | Name of the workflow | |
| version | String | No | version of the workflow | |
| description | String | No | description of the workflow | |
| scene | Enum | Yes | the scene of the workflow designer. Valid value as follow: resource - open a VNF's workflow service - open a Service's workflow | different scene may has different activities extend. |
| data | String | Yes | The workflow contnentontent | for new workflow, the data field maybe empty. |
...
Brief informtion of the extend activity.
Name | Data Type | Required | Description | Comment |
|---|---|---|---|---|
id | String | Yes | id of the activity | |
name | String | Yes | name of the activity | |
description | String | No | name of the activity | |
| category | String | No | Categorization to help better experience to the Designer while building the work-flow |
| icon |
| IConData |
| No | the icon to show |
ExtendActivity
Detail informtion of the extend activity.
...