...
Return the content of the workflow. For details to see data model 'WorkflowInfo' for details.
Save Workflow Content with WF ID (to Catalog)
...
These informations will describe the details of the activities which can be deployed to the workflow engine finally. At the same time the activity's detail information will be used to generate the BPMN artifacts.
...
Return the detail information of the extend activities, that is ExtendActivity[]. For details to see data model 'ExtendActivity' for details.
Get Category Information of Extend BPMN Activities (from Catalog)
Get the group category the category information of extend Activities. If the extend activities have category informations, the WF Designer will organize and display extend activities in categories.
...
| Name | Data Type | Required | Description | Comment |
|---|---|---|---|---|
| nodes | Map<String, CategoryInfo> | Yes | Category Informations of the extend activities. key – extend activity id value - Category Informations Information of the extend activity | |
| categoryData | Map<String, CategoryData> | Yes | Category Data of the group. key - Category id value - Category Data |
...
Name | Data Type | Required | Description | Comment |
|---|---|---|---|---|
| class | String | Yes | The implement class of the bpmn service task | |
inputs | Map<String, Input> | No | The input parameter definitions of the task. key - Input parameter name value - Input parameter informationdefinition | These parameters will dispaly on UI for designer to fullfill. |
...
Name | Data Type | Required | Description | Comment |
|---|---|---|---|---|
url | String | No | The URL of the REST API exposed through the API router. | Choose between the 'url' field and ('name', 'version') filed. |
| name | String | No | The microservcie name of the REST API. Only for the condition of access the REST API via MircoServiceBus. | |
| version | String | No | The microservcie version of the REST API. Only for the condition of access the REST API via MircoServiceBus. | In the condition of access the REST API via MircoServiceBus, The workflow engine can query the URL of the REST API exposed through the MircoServiceBus by name and version. |
| path | String | Yes | The path of the REST API relative to the API router exposed path. | |
method | Enum | Yes | The method of the rest api to be called while the activity be executed on the workflow engine. Valid value as follow: get, post, put, delete | |
headers | Map<Strting, String> | Yes | The header paramters of the rest api associated to the rest task. Map key is the header paramter name, such as 'Accept'.Map value is the header paramter name, such as ''application/json. | |
inputs | Map<String, Input> | No | The input parameter definitions of the task. key - Input parameter name value - Input parameter information definition |
Input
Name | Data Type | Required | Description | Comment |
|---|---|---|---|---|
type | Enum | Yes | data type of the input paramter. Valid value as follow: string, integer, float, boolean, enum | |
default | any | No | the default value of the input paramter. | |
required | boolean | Yes | Should the input paramter be necessary? true - necessary false - not necessary | |
constraints | ||||
displayName | String | No | Alias of the Input paramter only for display usingdisplaying use. | If there is no alias, the original name will be displayed |
show | boolean | No | Is it displayed in the UI? | If false, this input parameter will be hided on the UI. |