VF-C: Activiti interface definition
- Zhaoxing Meng
1 Interface Definition
1.1 Execute process instance
1.1.1 URL
POST /activiti-rest/service/runtime/process-instances
1.1.2 RequestPathParam
None
1.1.3 RequestBodyParam
Parameter | Mandatory | Instance Count | Data Type | Description |
processDefinitionKey | M | 1 | String | Execute Process Instance Id |
variables |
| 1 | ActivitiStartProcessRequestParam[] | 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 |
id |
| 1 | String | Process Instance ID |
url |
|
| String | Details of Process Instance |
suspended |
|
| String | Status of process instance |
processDefinitionUrl |
|
| String | Details of deploy |
1.2 Deploy BPMN file
1.2.1 URL
POST /activiti-rest/service/repository/deployments
1.2.2 RequestFormDataParam
Parameter | Mandatory | Instance Count | Data Type | Description |
file | M | 1 | Stream | Deploy File Stream |
1.2.3 RequestBodyParam
None
1.2.4 Response
?Success?201
Parameter | Mandatory | Instance Count | Data Type | Description |
id | M | 1 | String | Deploy Status |
name |
|
| String | Deploy file name |
deploymentTime |
|
| String | Deploy time |
url |
|
| String | Details of deploy |
tenantId |
|
|
|
|
1.3 UnDeploy BPMN?file
1.3.1 URL
DELETE /activiti-rest/service/repository/deployments/{deployId}
1.3.2 RequestPathParam
Parameter | Mandatory | Instance Count | Data Type | Description |
deployId | M | 1 | String | Deploy Id |
1.3.3 RequestBodyParam
None
1.3.4 Response
?Success?204
Parameter | Mandatory | Instance Count | Data Type | Description |
status | M | 1 | String | Indicates the deployment was found and has been deleted |