文档中心 > API类目 > 钉钉API

dingtalk.oapi.smartwork.hrm.navigationbar.config.get (查询企业HRM导航栏配置)

智能人事业务，提供企业/ISV按以某个员工的身份获取导航栏的配置。

公共参数

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

名称	类型	是否必须	描述
access_token	String	是	钉钉提供的授权Token，想了解详情，ISV开发者请点击这里，企业开发者请点击这里。若有疑问，咨询邮箱dingding_open_dingtalk#list.alibaba-inc.com。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
userid	String	必须	"manager6684"		导航栏访问员工ID
type	String	必须	"pc"		基础导航了类型，枚举值, "pc"-PC端, "oa"-OA端
change_param	HrmNavChangeVo []	可选		最大列表长度：20	isv变更导航栏属性
└ url String 可选 "testUrl" 变更的链接 └ code String 可选 "test" 变更的节点code

响应参数

名称	类型	示例值	描述
errmsg	String	无访问权限	错误信息
errcode	Number	400020	错误码
success	Boolean	false	调用结果
result	HrmNavigationBarVo	{ "menuList": [ { "icon": "home", "authKey": "/baseAction/base/*", "noPermission": true, "url": "home", "code": "/hrmNav/homePage", "authType": "hrmEam", "name": "首页", "order": 0 } ], "superAdmins": [ { "avatar": "@lADPGqGoaowg6ObNC9DNC9A", "userId": "manager2407", "name": "杨斌" } ], "staffId": "30291837261019036321", "corpId": "ding492cf35abd6db52035c2f4657eb6378f" }	导航栏VO
menu_list HrmNavBarTreePointLevel1Vo [] { "code": "contract", "path": "/hrmNav/emp/relation", "name": "合同管理", "icon": "test", "url": "home", "authType": "hrmEam", "authKey": "/hrProcess/contract/", "noPermission": true, "subAppCode": "test", "order": 4 } 导航栏节点VO └ path String /hrmNav/emp/relation 路径 └ auth_key String /hrProcess/contract/ 权限key └ code String contract 节点code，全局唯一 └ no_permission Boolean true 是否无权限 └ name String 合同管理节点名称 └ icon String test 节点图标 └ sub_app_code String test 前端跳转识别字段 └ auth_type String hrmEam 权限类型 └ url String home 跳转链接 └ order Number 4 顺序 children HrmNavBarTreePointLevel2Vo [] { "code": "contract", "path": "/hrmNav/emp/relation", "name": "合同管理", "icon": "test", "url": "home", "authType": "hrmEam", "authKey": "/hrProcess/contract/", "noPermission": true, "subAppCode": "test", "order": 4 } 一级子节点 └ path String /hrmNav/emp/relation 路径 └ auth_key String /hrProcess/contract/ 权限key └ code String contract 节点code，全局唯一 └ no_permission Boolean true 是否无权限 └ name String 合同管理节点名称 └ icon String test 节点图标 └ sub_app_code String test 前端跳转识别字段 └ auth_type String hrmEam 权限类型 └ url String home 跳转链接 └ order Number 4 顺序 children HrmNavBarTreePointLevel3Vo [] { "code": "contract", "path": "/hrmNav/emp/relation", "name": "合同管理", "icon": "test", "url": "home", "authType": "hrmEam", "authKey": "/hrProcess/contract/", "noPermission": true, "subAppCode": "test", "order": 4 } 二级子节点 └ path String /hrmNav/emp/relation 路径 └ auth_key String /hrProcess/contract/ 权限key └ code String contract 节点code，全局唯一 └ no_permission Boolean true 是否无权限 └ name String 合同管理节点名称 └ icon String test 节点图标 └ sub_app_code String test 前端跳转识别字段 └ auth_type String hrmEam 权限类型 └ url String home 跳转链接 └ order Number 4 顺序 children HrmNavBarTreePointLevel4Vo [] { "code": "contract", "path": "/hrmNav/emp/relation", "name": "合同管理", "icon": "test", "url": "home", "authType": "hrmEam", "authKey": "/hrProcess/contract/", "noPermission": true, "subAppCode": "test", "order": 4 } 三级子节点 └ path String /hrmNav/emp/relation 路径 └ auth_key String /hrProcess/contract/ 权限key └ code String contract 节点code，全局唯一 └ no_permission Boolean true 是否无权限 └ name String 合同管理节点名称 └ icon String test 节点图标 └ sub_app_code String test 前端跳转识别字段 └ auth_type String hrmEam 权限类型 └ url String home 跳转链接 └ order Number 4 顺序 children HrmNavBarTreePointLevel5Vo [] { "code": "contract", "path": "/hrmNav/emp/relation", "name": "合同管理", "icon": "test", "url": "home", "authType": "hrmEam", "authKey": "/hrProcess/contract/", "noPermission": true, "subAppCode": "test", "order": 4 } 四级子节点 └ path String /hrmNav/emp/relation 路径 └ auth_key String /hrProcess/contract/ 权限key └ code String contract 节点code，全局唯一 └ no_permission Boolean true 是否无权限 └ name String 合同管理节点名称 └ icon String test 节点图标 └ sub_app_code String test 前端跳转识别字段 └ auth_type String hrmEam 权限类型 └ url String home 跳转链接 └ order Number 4 顺序 super_admins EmpBaseInfoVo [] [ { "avatar": "@lADPGqGoaowg6ObNC9DNC9A", "userId": "manager2407", "name": "测试" } ] 管理员列表 └ avatar String @lADPGqGoaowg6ObNC9DNC9A 管理员头像 └ name String 测试管理员名字 └ userid String manager2407 管理员员工id └ userid String manager2407 员工id └ corp_id String testCorp 企业id

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/smartwork/hrm/navigationbar/config/get");
OapiSmartworkHrmNavigationbarConfigGetRequest req = new OapiSmartworkHrmNavigationbarConfigGetRequest();
req.setUserid("\"manager6684\"");
req.setType("\"pc\"");
List<HrmNavChangeVo> list2 = new ArrayList<HrmNavChangeVo>();
HrmNavChangeVo obj3 = new HrmNavChangeVo();
list2.add(obj3);
obj3.setUrl("\"testUrl\"");
obj3.setCode("\"test\"");
req.setChangeParam(list2);
OapiSmartworkHrmNavigationbarConfigGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/smartwork/hrm/navigationbar/config/get");
OapiSmartworkHrmNavigationbarConfigGetRequest req = new OapiSmartworkHrmNavigationbarConfigGetRequest();
req.Userid = "\"manager6684\"";
req.Type = "\"pc\"";
List<OapiSmartworkHrmNavigationbarConfigGetRequest.HrmNavChangeVoDomain> list2 = new List<OapiSmartworkHrmNavigationbarConfigGetRequest.HrmNavChangeVoDomain>();
OapiSmartworkHrmNavigationbarConfigGetRequest.HrmNavChangeVoDomain obj3 = new OapiSmartworkHrmNavigationbarConfigGetRequest.HrmNavChangeVoDomain();
list2.Add(obj3);
obj3.Url = "\"testUrl\"";
obj3.Code = "\"test\"";
req.ChangeParam_ = list2;
OapiSmartworkHrmNavigationbarConfigGetResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);

include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');

$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiSmartworkHrmNavigationbarConfigGetRequest;
$req->setUserid("\"manager6684\"");
$req->setType("\"pc\"");
$change_param = new HrmNavChangeVo;
$change_param->url="\"testUrl\"";
$change_param->code="\"test\"";
$req->setChangeParam(array($change_param));
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/smartwork/hrm/navigationbar/config/get");

curl -X POST "https://oapi.dingtalk.com/topapi/smartwork/hrm/navigationbar/config/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=2ee681e6-eda8-434f-a46d-4bfbb671db07' \
-d 'change_param=null' \
-d 'type=%5C%22pc%5C%22' \
-d 'userid=%5C%22manager6684%5C%22'

# -*- coding: utf-8 -*-
import dingtalk.api

req=dingtalk.api.OapiSmartworkHrmNavigationbarConfigGetRequest("https://oapi.dingtalk.com/topapi/smartwork/hrm/navigationbar/config/get")

req.userid="\"manager6684\""
req.type="\"pc\""
req.change_param=""
try:
	resp= req.getResponse(access_token)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"dingtalk.oapi.smartwork.hrm.navigationbar.config.get");
add_param(pRequest,"userid","\"manager6684\"");
add_param(pRequest,"type","\"pc\"");
add_param(pRequest,"change_param","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('dingtalk.oapi.smartwork.hrm.navigationbar.config.get', {
	'userid':'\"manager6684\"',
	'type':'\"pc\"',
	'change_param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "errmsg":"无访问权限",
    "errcode":400020,
    "success":false,
    "result":{
        "menu_list":[
            {
                    "path":"\/hrmNav\/emp\/relation",
                    "auth_key":"\/hrProcess\/contract\/*",
                    "code":"contract",
                    "no_permission":true,
                    "name":"合同管理",
                    "icon":"test",
                    "sub_app_code":"test",
                    "auth_type":"hrmEam",
                    "url":"home",
                    "order":4,
                    "children":[
                        {
                                "path":"\/hrmNav\/emp\/relation",
                                "auth_key":"\/hrProcess\/contract\/*",
                                "code":"contract",
                                "no_permission":true,
                                "name":"合同管理",
                                "icon":"test",
                                "sub_app_code":"test",
                                "auth_type":"hrmEam",
                                "url":"home",
                                "order":4,
                                "children":[
                                    {
                                            "path":"\/hrmNav\/emp\/relation",
                                            "auth_key":"\/hrProcess\/contract\/*",
                                            "code":"contract",
                                            "no_permission":true,
                                            "name":"合同管理",
                                            "icon":"test",
                                            "sub_app_code":"test",
                                            "auth_type":"hrmEam",
                                            "url":"home",
                                            "order":4,
                                            "children":[
                                                {
                                                        "path":"\/hrmNav\/emp\/relation",
                                                        "auth_key":"\/hrProcess\/contract\/*",
                                                        "code":"contract",
                                                        "no_permission":true,
                                                        "name":"合同管理",
                                                        "icon":"test",
                                                        "sub_app_code":"test",
                                                        "auth_type":"hrmEam",
                                                        "url":"home",
                                                        "order":4,
                                                        "children":[
                                                            {
                                                                    "path":"\/hrmNav\/emp\/relation",
                                                                    "auth_key":"\/hrProcess\/contract\/*",
                                                                    "code":"contract",
                                                                    "no_permission":true,
                                                                    "name":"合同管理",
                                                                    "icon":"test",
                                                                    "sub_app_code":"test",
                                                                    "auth_type":"hrmEam",
                                                                    "url":"home",
                                                                    "order":4
                                                            }
                                                        ]
                                                }
                                            ]
                                    }
                                ]
                        }
                    ]
            }
        ],
        "super_admins":[
            {
                    "avatar":"@lADPGqGoaowg6ObNC9DNC9A",
                    "name":"测试",
                    "userid":"manager2407"
            }
        ],
        "userid":"manager2407",
        "corp_id":"testCorp"
    }
}

异常示例

JSON示例

{
	"errcode":88,
	"errmsg":"ding talk error"
}

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.smartwork.hrm.navigationbar.config.get (查询企业HRM导航栏配置)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ