查询企业组织结构
功能介绍
企业主账号在自建平台查询企业组织结构。
接口约束
该接口只允许使用企业主账号AK/SK或者Token调用。
调试
您可以在API Explorer中调试该接口。
URI
GET /v2/enterprises/multi-accounts/enterprise-organizations
参数说明请参见下表。
参数 |
是否必选 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|---|
recursive_query |
否 |
Integer |
- |
是否递归查询。
如果不递归,只返回起始节点的直接子节点。 此参数不携带或携带值为空时,不作为筛选条件。 |
parent_id |
否 |
String |
最大长度:20 |
指定的节点ID。为空则从根节点查起。 此参数不携带或携带值为空时,不作为筛选条件。
说明:
此参数须由纯数字组成。 |
请求消息
请求参数
无。
请求示例
GET https://bss.myhuaweicloud.com/v2/enterprises/multi-accounts/enterprise-organizations?recursive_query=1&parent_id=392 HTTP/1.1 Content-Type: application/json X-Auth-Token:MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
响应消息
响应参数
参数 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|
error_code |
String |
最大长度:20 |
状态码。具体请参考状态码,只有失败才返回该字段。 |
error_msg |
String |
最大长度:1000 |
错误描述信息。只有失败才返回该字段。 |
root_id |
String |
最大长度:20 |
根节点ID,如果请求有parent_id,则该参数无值。 |
root_name |
String |
- |
根节点名称,如果请求有parent_id,则该参数无值。
说明:
组织根节点没有设置组织名称时,可能为空。 |
child_nodes |
List<EmChildNodeV2> |
- |
企业管理子Party节点列表,具体参考表2。 |
参数 |
参数类型 |
取值范围 |
描述 |
---|---|---|---|
relation_id |
String |
最大长度:20 |
实体关系ID。 |
id |
String |
最大长度:20 |
节点ID(即组织单元的Party ID)。 |
name |
String |
- |
节点名称。 |
child_nodes |
List<EmChildNodeV2> |
- |
子节点列表。 |
响应示例
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: length Date: response time { "root_id": null, "root_name": null, "child_nodes": [ { "relation_id": "849", "id": "933", "name": "组织", "child_nodes": [] }, { "relation_id": "734", "id": "817", "name": "组织1", "child_nodes": [ { "relation_id": "735", "id": "818", "name": "组织2", "child_nodes": [] }, { "relation_id": "736", "id": "819", "name": "组织3", "child_nodes": [] }, { "relation_id": "740", "id": "823", "name": "组织4", "child_nodes": [] }, { "relation_id": "741", "id": "824", "name": "组织5", "child_nodes": [] } ] } ] }