1. 获取项目组织机构树接口

获取项目下组织结构树

注意

  • 如果接口需要提供auth-token,你需要通过轻筑开放平台创建应用来获取appid和secret,然后通过appid和secret来获取接口访问凭证auth-token。
  • 如果需要获取当前用户的使用信息,授权确保你能获取到qzcode,然后通过网页授权接口获取相关信息。

1.1. 基本信息

概况 内容
接口地址 /api/platform/project/org/tree
请求方法 GET
请求数据类型 URL参数
响应数据类型 JSON

1.2. 请求数据

1.2.1. 请求头(request-header)

请求头除了默认的参数还需要添加如下请求头参数:

字段 描述
auth-token 接口访问凭据,你可以通过平台下发的appid和secret获取凭据

1.2.2. 请求参数(request-parameter)

字段 是否必传 描述
projectId 项目id

参数请求示例:

http://api.example.com/xxx?key=value

1.3. 响应数据

响应数据中 code, message, data 为默认字段,通用的响应数据机构为:

{
    "code": 0,
    "message": "",
    "data": {...}
}

其中data字段包含内容如下表所示:

字段 类型 是否必填 描述
0 object
orgId string 项目组织机构id
orgType number 节点类型(1 = 公司, 2 = 部门, 3 = 班组)
orgName string 节点名称
isParent boolean 是否是父节点
children array 子节点信息
orgId string 项目组织机构id
orgType number 节点类型(1 = 公司, 2 = 部门, 3 = 班组)
orgName string 节点名称
remarks string 备注

响应数据结构如下所示:

[
    {
        "orgId": "xxxx",
        "orgType": 1,
        "orgName": "xxxx",
        "isParent": true,
        "children": [
            {
                "orgId": "xxxx",
                "orgType": 1,
                "orgName": "xxxx"
            }
        ]
    }
]

1.4. 错误码

当返回数据中的 code 不为 0 时,为错误返回。其中errCode为详细的错误码。

© All Rights Reserved            updated 2024-08-23 10:14:55

results matching ""

    No results matching ""