VF-C: Workflow interface definition
- Zhaoxing Meng
- Jiang Li
1 Interface Definition
1.1 Execute process instance
1.1.1 URL
POST /api/workflow/v1/process/instance
1.1.2 RequestPathParam
None
1.1.3 RequestBodyParam
Parameter | Mandatory | Instance Count | Data Type | Description |
processDefinitionKey | M | 1 | String | Execute Process Instance Id |
params | M | 1 | Map<String,String> | Execute Process Instance Input Parameters |
1.1.4 Response
Success-201
Parameter | Mandatory | Instance Count | Data Type | Description |
status | M | 1 | String | Execute Process Instance Status |
message | M | 1 | String | Execute Process Instance Instruction |
1.2 Deploy BPMN file
1.2.1 URL
POST/api/workflow/v1/package
1.2.2 RequestFormDataParam
Parameter | Mandatory | Instance Count | Data Type | Description |
file | M | 1 | Stream | Deploy File Stream |
filename | M | 1 | String | File Name |
1.2.3 RequestBodyParam
None
1.2.4 Response
?Success?201
Parameter | Mandatory | Instance Count | Data Type | Description |
status | M | 1 | String | Deploy Status |
message | M | 1 | String | Deploy Instruction |
deployedId | M | 1 | String | Deploy Id |
processId | M | 1 | String | Execute Process Instance Id |
1.3 UnDeploy BPMN?file
1.3.1 URL
DELETE/api/workflow/v1/package/{deployId}
1.3.2 RequestPathParam
Parameter | Mandatory | Instance Count | Data Type | Description |
deployId | M | 1 | String | Deploy Id |
1.3.3 RequestBodyParam
?
1.3.4 Response
?Success?201
Parameter | Mandatory | Instance Count | Data Type | Description |
status | M | 1 | String | Delete File Status |
message | M | 1 | String | Delete Instruction |