获取组织机构数据
接口说明
该接口用于获取组织机构数据，接口将返回大于指定version值的增量数据，返回结果将按数据的version字段进行升序排序，每次查询最多返回200条数据。
接口地址
/org-api/orgs?start=12345&limit=200&root=10001
接口类型
Http
请求方式
GET
内容类型
application/json
鉴权策略
参见《Open-API鉴权协议》
请求参数
| 参数名称 | 说明 |
|---|---|
| start | 本次请求所要获取的增量数据的version起始值，客户端需要缓存接口返回的数据集合中最后一条数据的version值 |
| limit | 返回指定的数据条数 上限为200条 0 < limit <= 200 |
| root | 指定根组织节点，缺省时表示获取整个企业组织范围数据 |
响应报文
[
{
"id": 3434,
"oid": "12321312",
"parentId": 21312312,
"pmParentId": 12321312,
"bizParents": [
21312,
3323,
1213
],
"name": "xxxxx项目",
"shortName": "xxx",
"sortNo": 1,
"type": "A",
"version": 3242342342,
"deleted": false
}
]
响应状态码
| 字段名称 | 数据类型 |
|---|---|
| 200 | 成功 |
| 400 | 用户请求头中Authorization值的格式不对，错误码：InvalidArgument。 |
| 403 | AccessId不存在或被禁用 错误码：InvalidAccessId |
| 500 | 非法参数或接口执行异常 |
响应数据结构
| 字段名称 | 字段类型 | 字段描述 |
|---|---|---|
| id | long | 组织标识 |
| oid | string | 原始组织标识，与 4A 系统中的 oid 一致 |
| parentId | long | 行政上级标识 |
| pmParentId | long | 项目管控上级 |
| bizParents | array | 业务管控上级列表 |
| name | string | 组织名称 |
| shortName | string | 组织短名称 |
| sortNo | int | 节点排序号 |
| type | string | 组织类型 见表1 |
| extType | string | 管理类型 见表2 |
| version | long | 当前数据版本 |
| deleted | boolean | 逻辑删除标志 见表3 |
表1 组织类型枚举值定义
| type | |
|---|---|
| department | 部门 |
| company | 公司 |
| group | 虚拟组织（分组） |
| project | 标段项目 |
表2 管理类型枚举值定义
| extType | |
|---|---|
| command | 指挥部 |
| mixing | 搅拌站 |
| project | 一般项目 |
| none | 无 |
表3 是否逻辑删除标识
| deleted | |
|---|---|
| false | 未删除 |
| true | 已删除 |
获取用户数据
接口说明
该接口用于获取用户数据，接口将返回大于指定version值的增量数据，返回结果将按数据的version字段进行升序排序，每次查询最多返回200条数据。
接口地址
/user-api/users?start=12345&limit=200&root=10001
接口类型
Http
请求方式
GET
内容类型
application/json
鉴权策略
参见《Open-API鉴权协议》
请求参数
| 参数名称 | 说明 |
|---|---|
| start | 本次请求所要获取的增量数据的version起始值，客户端需要缓存接口返回的数据集合中最后一条数据的version值 |
| limit | 返回指定的数据条数 上限为200条 0 < limit <= 200 |
| root | 指定根组织节点，缺省时表示获取整个企业组织范围数据 |
响应报文
[
{
"id": 164430180717568,
"loginId": "",
"name": "张三",
"gender": "male",
"mainOrg": 164327963866240,
"orgs": [
164328263976320
],
"version": 168229300704384,
"deleted": false,
"phoneNum": "13562684301"
}
]
响应状态码
| 字段名称 | 数据类型 |
|---|---|
| 200 | 成功 |
| 400 | 用户请求头中Authorization值的格式不对，错误码：InvalidArgument。 |
| 403 | AccessId不存在或被禁用 错误码：InvalidAccessId |
| 500 | 非法参数或接口执行异常 |
响应数据结构
| 字段名称 | 字段类型 | 是否可以为空 | 字段描述 |
|---|---|---|---|
| id | long | 否 | 用户id |
| loginId | string | 是 | 登录账号 |
| name | string | 否 | 用户名称 |
| gender | string | 否 | 性别 见表1 |
| mainOrg | long | 是 | 主组织 ID |
| orgs | array | 是 | 所属组织 ID 列表,其中不包含mainOrg |
| version | long | 否 | 当前数据版本 |
| deleted | boolean | 否 | 逻辑删除标志 见表2 |
| phoneNum | string | 否 | 手机号 |
表1 性别
| gender | |
|---|---|
| male | 男人 |
| female | 女人 |
| none | 未指定 |
表2 是否逻辑删除标识
| deleted | |
|---|---|
| false | 未删除 |
| true | 已删除 |