本文共 8711 字，大约阅读时间需要 29 分钟。

activiti服务API文档

以下是基于activiti服务的API文档，涵盖了从流程图绘制到任务操作等多个功能模块。

1. 绘制流程图的UI界面

GET http://[activiti_rest_url]/activiti-explorer/

通过此接口可以绘制流程图的UI界面，需使用支持bpmn格式的工具进行操作。

2. 上传bpmn文件至activiti-rest

POST http://[activiti_rest_url]/activiti-rest/service/repository/deployments

• 请求头：

  • Authorization: Basic a2VybWl0Omtlcm1pdA==
  • Content-Type: multipart/form-data

• 请求体：

  • file：上传文件名（如test2.bpmn20.xml）

响应示例：

{  "id": "40",  "name": "test2.bpmn20.xml",  "deploymentTime": "2019-06-19T05:49:23.481Z",  "category": null,  "url": "http://[activiti_rest_url]/activiti-rest/service/repository/deployments/40",  "tenantId": ""}

3. 获取上传模型信息表

GET http://[activiti_rest_url]/activiti-rest/service/repository/deployments

• 请求头：

  • Authorization: Basic a2VybWl0Omtlcm1pdA==

• 响应示例：

{  "data": [    {      "id": "20",      "name": "Demo processes",      "deploymentTime": "2019-06-19T03:20:05.845Z",      "category": null,      "url": "http://[activiti_rest_url]/activiti-rest/service/repository/deployments/20",      "tenantId": ""    },    {      "id": "40",      "name": "test2.bpmn20.xml",      "deploymentTime": "2019-06-19T05:49:23.481Z",      "category": null,      "url": "http://[activiti_rest_url]/activiti-rest/service/repository/deployments/40",      "tenantId": ""    }  ],  "total": 2,  "start": 0,  "sort": "id",  "order": "asc",  "size": 2}

4. 创建用户

POST http://[activiti_rest_url]/activiti-rest/service/identity/users

• 请求头：

  • Authorization: Basic a2VybWl0Omtlcm1pdA==

• 请求体：

  {  "id": "test",  "firstName": "test",  "lastName": "test",  "email": "",  "password": "test"}

响应示例：

{  "id": "test",  "firstName": "test",  "lastName": "test",  "url": "http://[activiti_rest_url]/activiti-rest/service/identity/users/test",  "email": "",  "pictureUrl": null,  "password": "test"}

5. 获取用户列表

GET http://[activiti_rest_url]/activiti-rest/service/identity/users

• 请求头：
  • Authorization: Basic a2VybWl0Omtlcm1pdA==

响应示例：

{  "data": [    {      "id": "fozzie",      "firstName": "Fozzie",      "lastName": "Bear",      "url": "http://[activiti_rest_url]/activiti-rest/service/identity/users/fozzie",      "email": "fozzie@activiti.org",      "pictureUrl": null    },    {      "id": "gonzo",      "firstName": "Gonzo",      "lastName": "The Great",      "url": "http://[activiti_rest_url]/activiti-rest/service/identity/users/gonzo",      "email": "gonzo@activiti.org",      "pictureUrl": null    },    {      "id": "kermit",      "firstName": "Kermit",      "lastName": "The Frog",      "url": "http://[activiti_rest_url]/activiti-rest/service/identity/users/kermit",      "email": "kermit@activiti.org",      "pictureUrl": null    },    {      "id": "test",      "firstName": "test",      "lastName": "test",      "url": "http://[activiti_rest_url]/activiti-rest/service/identity/users/test",      "email": "",      "pictureUrl": null    }  ],  "total": 4,  "start": 0,  "sort": "id",  "order": "asc",  "size": 4}

6. 获取群组

GET http://[activiti_rest_url]/activiti-rest/service/identity/groups

• 请求头：
  • Authorization: Basic a2VybWl0Omtlcm1pdA==

响应示例：

{  "data": [    {      "id": "admin",      "url": "http://[activiti_rest_url]/activiti-rest/service/identity/groups/admin",      "name": "Admin",      "type": "security-role"    },    {      "id": "engineering",      "url": "http://[activiti_rest_url]/activiti-rest/service/identity/groups/engineering",      "name": "Engineering",      "type": "assignment"    },    {      "id": "management",      "url": "http://[activiti_rest_url]/activiti-rest/service/identity/groups/management",      "name": "Management",      "type": "assignment"    },    {      "id": "marketing",      "url": "http://[activiti_rest_url]/activiti-rest/service/identity/groups/marketing",      "name": "Marketing",      "type": "assignment"    },    {      "id": "sales",      "url": "http://[activiti_rest_url]/activiti-rest/service/identity/groups/sales",      "name": "Sales",      "type": "assignment"    },    {      "id": "user",      "url": "http://[activiti_rest_url]/activiti-rest/service/identity/groups/user",      "name": "User",      "type": "security-role"    }  ],  "total": 6,  "start": 0,  "sort": "id",  "order": "asc",  "size": 6}

7. 创建群组

POST http://[activiti_rest_url]/activiti-rest/service/identity/groups

• 请求头：

  • Authorization: Basic a2VybWl0Omtlcm1pdA==

• 请求体：

  {  "id": "testgroup",  "name": "Test group",  "type": "Test type"}

响应示例：

{  "id": "testgroup",  "url": "http://[activiti_rest_url]/activiti-rest/service/identity/groups/testgroup",  "name": "Test group",  "type": "Test type"}

8. 为群组添加成员

POST http://[activiti_rest_url]/activiti-rest/service/identity/groups/{groupId}/members

• 请求头：

  • Authorization: Basic a2VybWl0Omtlcm1pdA==

• 请求体：

  {  "userId": "test"}

响应示例：

{  "userId": "test",  "url": "http://[activiti_rest_url]/activiti-rest/service/identity/groups/testgroup/members/test",  "groupId": "testgroup"}

9. 获取流程定义

GET http://[activiti_rest_url]/activiti-rest/service/repository/process-definitions/{processDefinitionId}

• 请求头：
  • Authorization: Basic a2VybWl0Omtlcm1pdA==

响应示例：

{  "data": [    {      "id": "test2:1:43",      "url": "http://[activiti_rest_url]/activiti-rest/service/repository/process-definitions/test2:1:43",      "key": "test2",      "version": 1,      "name": null,      "description": null,      "tenantId": "",      "deploymentId": "40",      "deploymentUrl": "http://[activiti_rest_url]/activiti-rest/service/repository/deployments/40",      "resource": "http://[activiti_rest_url]/activiti-rest/service/repository/deployments/40/resources/test2.bpmn20.xml",      "diagramResource": "http://[activiti_rest_url]/activiti-rest/service/repository/deployments/40/resources/test2.test2.png",      "category": "http://www.activiti.org/processdef",      "graphicalNotationDefined": true,      "suspended": false,      "startFormDefined": false    }  ],  "total": 7,  "start": 0,  "sort": "name",  "order": "asc",  "size": 7}

10. 启动流程

POST http://[activiti_rest_url]/activiti-rest/service/runtime/process-instances

• 请求头：

  • Authorization: Basic a2VybWl0Omtlcm1pdA==

• 请求体：

  {  "processDefinitionId": "test2:1:43",  "businessKey": "myBusinessKey",  "variables": []}

响应示例：

{  "id": "45",  "url": "http://[activiti_rest_url]/activiti-rest/service/runtime/process-instances/45",  "businessKey": "myBusinessKey",  "suspended": false,  "ended": true,  "processDefinitionId": "test2:1:43",  "processDefinitionUrl": "http://[activiti_rest_url]/activiti-rest/service/repository/process-definitions/test2:1:43",  "activityId": "endevent",  "variables": [],  "tenantId": "",  "completed": true}

11. 显示流程实例列表

GET http://[activiti_rest_url]/activiti-rest/service/runtime/process-instances

• 请求头：
  • Authorization: Basic a2VybWl0Omtlcm1pdA==

响应示例：

{  "data": [],  "total": 0,  "start": 0,  "sort": "id",  "order": "asc",  "size": 0}

12. 获取任务列表

GET http://[activiti_rest_url]/activiti-rest/service/runtime/tasks

• 请求头：
  • Authorization: Basic a2VybWl0Omtlcm1pdA==

响应示例：

{  "data": [    {      "id": "58",      "url": "http://[activiti_rest_url]/activiti-rest/service/runtime/tasks/58",      "owner": null,      "assignee": null,      "delegationState": null,      "name": "Handle vacation request",      "description": "${employeeName} would like to take ${numberOfDays} day(s) of vacation (Motivation: ${vacationMotivation}).",      "createTime": "2019-06-19T08:27:26.884Z",      "dueDate": null,      "priority": 50,      "suspended": false,      "taskDefinitionKey": "handleRequest",      "tenantId": "",      "category": null,      "formKey": null,      "parentTaskId": null,      "parentTaskUrl": null,      "executionId": "52",      "executionUrl": "http://[activiti_rest_url]/activiti-rest/service/runtime/executions/52",      "processInstanceId": "52",      "processInstanceUrl": "http://[activiti_rest_url]/activiti-rest/service/runtime/process-instances/52",      "processDefinitionId": "vacationRequest:1:33",      "processDefinitionUrl": "http://[activiti_rest_url]/activiti-rest/service/repository/process-definitions/vacationRequest:1:33",      "variables": []    }  ],  "total": 1,  "start": 0,  "sort": "id",  "order": "asc",  "size": 1}

13. 操作任务

POST http://[activiti_rest_url]/activiti-rest/service/runtime/tasks/{taskId}

• 请求头：

  • Authorization: Basic a2VybWl0Omtlcm1pdA==

• 请求体：

  {  "action": "complete",  "variables": [    {      "name": "vacationApproved",      "value": true    }  ]}

响应示例：无响应体（204 No Content）。

14. 提交任务表单数据

POST http://[activiti_rest_url]/activiti-rest/service/form/form-data

• 请求头：

  • Authorization: Basic a2VybWl0Omtlcm1pdA==

• 请求体：可能包含以下内容：

  {  "taskId": "5",  "properties": [    {      "id": "room",      "value": "normal"    }  ]}

  或者

  {  "processDefinitionId": "5",  "businessKey": "myKey",  "properties": [    {      "id": "room",      "value": "normal"    }  ]}

以上为activiti服务API的主要操作说明，具体参数和响应格式请以实际服务文档为准。