易企办开发者 / REST API

易企办接口参考

按资源浏览中国版 OpenAPI 的请求方法、路径和参数,并打开所选接口的完整定义。

显示 76 个接口

数据与文件

读取列表结构和记录,向列表或文档库添加文件。

数据列表 · 13 个接口

方法路径用途
GET/lists/{appID}/{listID}查询列表信息
GET/lists/{appID}/{listID}/fields查询列表字段
POST/lists/{appID}/{listID}/items添加列表记录
POST/lists/{appID}/{listID}/items/batch添加多个列表记录
PATCH/lists/{appID}/{listID}/items/batch更新多个列表记录
POST/lists/{appID}/{listID}/items:batchDelete删除列表多个记录
PATCH/lists/{appID}/{listID}/items/{id}更新一个列表记录
DELETE/lists/{appID}/{listID}/items/{id}删除记录
GET/lists/{appID}/{listID}/items/{id}根据ID查询记录
POST/lists/{appID}/{listID}/items/query查询列表记录
POST/lists/{appID}/{listID}/items/{id}/files列表记录添加文件
POST/lists/{appID}/{listID}/library添加文件到文档库
GET/lists/{appID}/{listID}/library/{id}/content从文档库获取文件内容

文件 · 2 个接口

方法路径用途
POST/files上传文件
GET/files/{id}/content通过文件ID获取文件内容

组织与服务门户

查询用户并维护部门、地点、用户组、岗位和服务门户成员。

用户 · 8 个接口

方法路径用途
POST/users添加用户
GET/users根据账号ID查询用户
POST/users/search搜索用户
GET/users/{id}根据用户ID查询
PUT/users/{id}根据用户ID更新
DELETE/users/{id}删除一个用户
PUT/users/{id}/enable激活一个用户
PUT/users/{id}/disable禁用一个用户

部门 · 4 个接口

方法路径用途
GET/departments获取组织数据
POST/departments添加一个组织
PUT/departments/{id}修改组织信息
DELETE/departments/{id}通过ID删除组织

地点 · 5 个接口

方法路径用途
GET/locations获取所有地点
POST/locations添加一个地点
GET/locations/{id}根据ID获取地点
PUT/locations/{id}更新地点信息
DELETE/locations/{id}删除一个地点

用户组 · 7 个接口

方法路径用途
GET/groups查询组
POST/groups添加一个组
PUT/groups/{id}更新一个组
DELETE/groups/{id}删除一个组
POST/groups/{id}/users添加用户到组
GET/groups/{id}/users获取组的用户列表
POST/groups/{id}/users/remove从组中移除用户

岗位 · 7 个接口

方法路径用途
POST/positions添加一个岗位
GET/positions获取岗位列表
PUT/positions/{id}更新岗位信息
DELETE/positions/{id}删除一个岗位
POST/positions/{id}/users分配用户到一个岗位
GET/positions/{id}/users获取岗位分配明细
POST/positions/{id}/users/remove从岗位移除用户

服务门户 · 11 个接口

方法路径用途
POST/ServicePortal/{portalid}/users创建用户
GET/ServicePortal/{portalid}/users/search查询用户
DELETE/ServicePortal/{portalid}/users/{id}删除用户
POST/ServicePortal/{portalid}/users/{userid}/resetpwd设置用户密码
GET/ServicePortal/{portalid}/groups获取组列表
POST/ServicePortal/{portalid}/groups创建组
PUT/ServicePortal/{portalid}/groups/{id}更新组
DELETE/ServicePortal/{portalid}/groups/{id}删除组
GET/ServicePortal/{portalid}/groups/{id}/users/count获取组用户数量
POST/ServicePortal/{portalid}/groups/{id}/users添加用户到组
POST/ServicePortal/{portalid}/groups/{id}/users/remove从组移除用户

流程自动化

启动工作流、查询与办理待办、访问表单变量和管理任务委派。

工作流 · 13 个接口

方法路径用途
POST/workflow/forms/start启动流程
GET/workflow/tasks/todo获取代办任务
GET/workflow/tasks/{id}/variables获取任务的变量和值
PUT/workflow/tasks/{id}/handle处理任务
GET/workflow/delegates查询代理记录
POST/workflow/delegates添加一个代理
GET/workflow/delegates/{id}根据ID获取代理
PUT/workflow/delegates/{id}修改一个代理
DELETE/workflow/delegates/{id}删除一个代理
PUT/workflow/delegates/{id}/enable启用一个代理
PUT/workflow/delegates/{id}/disable禁用一个代理
GET/workflow/forms/{id}/variables获取表单变量
PUT/workflow/forms/{id}/variables更新表单变量

AI 与自动化

查看应用中可用的智能体、读取定义或从集成服务发起执行。

AI 智能体 · 3 个接口

方法路径用途
GET/applications/{listID}/agents获取应用下的AI智能体
GET/agents/{agentID}获取智能体定义
POST/agents/{agentID}/run执行AI智能体

事件与回调

订阅工作流任务变更,并将回调发送到集成服务。

Webhook 回调 · 3 个接口

方法路径用途
POST/hooks创建一个webhook
GET/hooks/{id}根据ID获取Webhook
DELETE/hooks/{id}删除Webhook

接口定义以易企办中国版公开 OpenAPI v1 为准。

查看完整规范查看官方接口文档
继续阅读 分页、筛选和排序