组织全路径信息查询(API接口:queryOrgPathInfo)
功能介绍
查询组织的全路径信息。
相关接口
接口名称 |
调用说明 |
---|---|
调用该接口获取到Token,再调用其他接口时,需要在请求消息头中添加“Authorization”,其值即为Token。 |
URL
请求方式 |
HTTPS地址 |
服务架构 |
消息体类型 |
---|---|---|---|
POST |
https://isdp+域名/openapi/v1/organization/queryOrgPathInfo |
OpenAPI |
application/json |
请求头
KEY |
VALUE |
是否必填 |
描述 |
---|---|---|---|
Content-Type |
application/json |
是 |
无 |
Authorization |
bearer ${access_token} |
是 |
bearer +“ ”+5.2.1中获取的access_token的值 |
请求参数
参数 |
类型 |
是否必填 |
描述 |
---|---|---|---|
orgIdList |
List<Long> |
否 |
组织ID列表(集合数最多200),与组织编码列表须有一个,都为空,不作查询 |
orgNoList |
List<String> |
否 |
组织编码列表(集合数最多200),与组织ID列表须有一个,都为空,不作查询 |
响应参数
字段名 |
数据类型 |
字段名称 |
---|---|---|
status |
String |
值:success/failed,指成功/失败 |
msg |
Object |
异常时提示信息 |
success |
boolean |
true/false 成功/失败 |
failed |
boolean |
false/true 成功/失败 |
data |
Object |
查询成功返回的数据信息,具体详见下data参数表 |
data参数
字段名 |
数据类型 |
字段名称 |
---|---|---|
orgId |
Long |
当前组织ID(入参对应的) |
orgNo |
String |
当前组织编码 |
orgName |
String |
当前组织名称 |
orgPathNo |
String |
组织全路径编码(含当前组织编码),上下层级间以/分隔 |
orgPathName |
String |
组织全路径名称(含当前组织名称),上下层级间以/分隔 |
请求示例
{ "orgIdList": [ 1413713, 99007435, 57015 ], "orgNoList": [] }
响应示例
{ "status": "success", "msg": null, "data": [ { "orgName": "1234", "orgNo": "1234", "orgPathName": "SaasTenant1/123/1234", "orgId": 99007435, "orgPathNo": "SaasTenant1/123/1234" }, { "orgName": "XXX", "orgNo": "666", "orgPathName": "SaasTenant1/11/XXX", "orgId": 57015, "orgPathNo": "SaasTenant1/11/666" }, { "orgName": "9", "orgNo": "9", "orgPathName": "SaasTenant1/1$/2/3/4/5/6/7/9", "orgId": 1413713, "orgPathNo": "SaasTenant1/1/2/3/4/5/6/7/9" } ], "success": true, "failed": false