OpenAPI

概述

平台提供了丰富的OpenAPI接口提供给开发者使用，在调用OpenAPI接口之前，需了解开发前须知及调用流程，本文提供了OpenAPI接口使用介绍，供开发者参考。

功能介绍

平台提供了通讯录，表单，流程，消息，鉴权，素材等种类API，为用户提供开发能力，可以通过标准API接口将第三方的数据同步到七巧中，也可以在第三方系统中查询七巧中的数据，让用户可以通过自主开发来实现企业不同系统间的数据互通的问题。

提供API日志、回调日志等能力，保留 半年内 的调用记录，实现API记录的快速查询。

API列表

表单

接口名称	协议/方法	URL
根据ID获取表单实例数据	GET	/open/applications/{applicationId}/forms/{formModelId}/{id}
获取子表实例数据	GET	/open/applications/{applicationId}/forms/{parentId}/{parentFieldName}/{subFormModelId}
获取指定表单的分页数据	GET	/open/applications/{applicationId}/forms/{formModelId}
新增表单	POST	/open/applications/{applicationId}/forms/{formModelId}
修改表单	PUT	/open/applications/{applicationId}/forms/{formModelId}
删除表单实例数据	DELETE	/open/applications/{applicationId}/forms/{formModelId}/{id}
删除子表实例数据	DELETE	/open/applications/{applicationId}/forms/{parentId}/{parentFieldName}/{subFormModelId}
获取指定表单的分页数据(筛选条件)	POST	/open/applications/{applicationId}/forms/{formModelId}/query
获取指定主表数据实例下子表的表单实例数据	POST	/open/applications/{applicationId}/forms/parent_documents/{parentDocumentId}/sub_form_foreign_field_names/{subFormForeignFieldName}/sub_form_models/{subFormModelId}
获取表单文件Id	GET	/open/file_download/applications/{applicationId}/form_models/{formModelId}/documents/{documentId}
通过文件Id下载文件	GET	/open/file_download/applications/{applicationId}/files/{id}
上传文件	POST	/open/file_upload/applications/{applicationId}/form_models/{formModelId}
获取表单列表信息	GET	/open/applications/{applicationId}/form_models
获取表单模型下组件信息	GET	/open/applications/{applicationId}/form_models/{formModelId}
批量新增表单数据	POST	/open/applications/{applicationId}/forms/{formModelId}/batch_save
批量修改表单数据	POST	/open/applications/{applicationId}/forms/{formModelId}/batch_update
批量删除表单数据	POST	/open/applications/{applicationId}/forms/{formModelId}/batch_delete
上传文件(通过文件地址)	POST	/open/file_upload/applications/{applicationId}/form_models/{formModelId}/address

流程

接口名称	协议/方法	URL
启动流程实例	POST	/open/applications/{applicationId}/workflow/process_definitions/{modelId}/start
终止流程实例（终止任务）	POST	/open/applications/{applicationId}/workflow/process_instances/{processInstanceId}/task_instances/{taskId}/terminate
删除流程实例	DELETE	/open/applications/{applicationId}/workflow/process_instances/{processInstanceId}
查询指定用户的待办任务实例集合	GET	/open/applications/{applicationId}/workflow/process_instances/task_instances/todos
查询指定用户的已办任务实例集合（分页）	GET	/open/applications/{applicationId}/workflow/process_instances/task_instances/have_dones
查询指定用户的发起实例集合（分页）	GET	/open/applications/{applicationId}/workflow/process_instances/initiates
根据流程实例id获取流程实例	GET	/open/applications/{applicationId}/workflow/process_instances/{processInstanceId}
查询任务实例(获取流程实例的当前任务集合)	GET	/open/applications/{applicationId}/workflow/process_instances/{processInstanceId}/tasks
获取下一步人工任务参与人	GET	/open/applications/{applicationId}/workflow/process_instances/{processInstanceId}/tasks/{taskId}/next_approvers
完成任务	POST	/open/applications/{applicationId}/workflow/process_instances/{processInstanceId}/tasks/{taskId}/complete
回退任务	POST	/open/applications/{applicationId}/workflow/process_instances/{processInstanceId}/tasks/{taskId}/return
获取回退候选节点	GET	/open/applications/{applicationId}/workflow/process_instances/{processInstanceId}/tasks/{taskId}/back_tasks
单步回收任务	POST	/open/applications/{applicationId}/workflow/process_instances/{processInstanceId}/tasks/{taskId}/recover
传阅任务	POST	/open/applications/{applicationId}/workflow/process_instances/{processInstanceId}/tasks/{taskId}/circulate
委托任务	POST	/open/applications/{applicationId}/workflow/process_instances/{processInstanceId}/tasks/{taskId}/entrust
流程历史	GET	/open/applications/{applicationId}/workflow/process_instances/{processInstanceId}/historys
获取流程绑定表单	GET	/open/applications/{applicationId}/workflow/{modelId}/form
获取流程图	GET	/open/applications/{applicationId}/workflow/process_definition/{processModelId}/diagram
获取流程定义信息	GET	/open/applications/{applicationId}/workflow/process_definition/{processModelId}
获取流程版本	GET	/open/applications/{applicationId}/workflow/process_definition/{processModelId}/version
获取下一节点处理人和指定节点	POST	/open/applications/{applicationId}/workflow/process_definitions/{processModelId}/next_approvers/designated-nodes
新增相关人权限	POST	/open/applications/{applicationId}/workflow/process_instances/{processInstanceId}/relevant_user

公共

接口名称	协议/方法	URL
根据部门唯一标识获取指定部门	GET	/open/departments/{departmentId}
获取指定部门的子级部门列表	GET	/open/departments/{departmentId}/children
获取直属上级部门	GET	/open/departments/{departmentId}/parent
获取根部门信息	GET	/open/departments/root
根据部门ID批量获取部门	GET	/open/departments/list
根据账号名获取用户	GET	/open/users/account
根据用户ID获取用户	GET	/open/users/{userId}
根据用户ID批量获取用户	GET	/open/users/list
根据部门ID获取用户集合(分页)	GET	/open/users
根据关键字获取用户集合	GET	/open/users/search
查询指定用户的待办任务实例集合V2	GET	/open/general/portal/process_instances/task_instances/todos
查询指定用户的已办任务实例集合V2	GET	/open/general/portal/process_instances/task_instances/have_dones
查询指定用户的发起实例集合V2	GET	/open/general/portal/process_instances/task_instances/initiates
通过tenantId获取租户下应用集合	GET	/open/applications
查询租户内流程推送数据	GET	/open/third/process/todo/record
根据流程标签查询指定用户可发起流程信息	GET	/open/applications/workflow/process_definition/list/by_process_tag
用户待办数量统计	GET	/open/applications/process-center/bubble-statistics
常用流程列表	GET	/open/applications/process-center/processes/common/list