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

dingtalk.oapi.smartwork.hrm.roster.meta.get (智能人事花名册元数据查询)

获取员工花名册的元数据定义（包括花名册分组、字段定义）

公共参数

环境	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。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
agentid	Number	必须	123456		微应用在企业的AgentId

响应参数

名称	类型	示例值	描述
result	GroupMetaInfo []	[ { "groupName": "自定义分组", "groupId": "custom654390323db34a97942f00f2210cbe7b", "fieldMetaInfoList": [ { "fieldName": "自定义字段", "fieldCode": "494c20ee-4aa1-4465-ae8c-a25e406219eb", "derived": false } ], "detail": false }, { "groupName": "基本信息", "groupId": "sys00", "fieldMetaInfoList": [ { "fieldName": "姓名", "fieldCode": "姓名", "derived": false }, { "fieldName": "邮箱", "fieldCode": "邮箱", "derived": false } ], "detail": false }, { "groupName": "工作信息", "groupId": "sys01", "fieldMetaInfoList": [ { "fieldName": "员工类型", "fieldCode": "sys01-employeeType", "derived": false }, { "fieldName": "员工状态", "fieldCode": "sys01-employeeStatus", "derived": false } ], "detail": false }, { "groupName": "学历信息", "groupId": "sys03", "fieldMetaInfoList": [ { "fieldName": "学历", "fieldCode": "sys03-highestEdu", "derived": false }, { "fieldName": "毕业院校", "fieldCode": "sys03-graduateSchool", "derived": false }, { "fieldName": "自定义", "fieldCode": "c63c6f30-5474-49d7-8ce9-6f97c1c92346", "derived": false } ], "detail": true } ]	花名册分组定义
└ group_name String 自定义分组分组名称 └ group_id String custom654390323db34a97942f00f2210cbe7b 分组标识 field_meta_info_list FieldMetaInfo [] [ { "fieldName": "姓名", "fieldCode": "姓名", "derived": false }, { "fieldName": "邮箱", "fieldCode": "邮箱", "derived": false } ] 花名册分组内字段定义 └ field_name String 自定义字段字段名称 └ field_code String 494c20ee-4aa1-4465-ae8c-a25e406219eb 字段标识 └ derived Boolean false 是否衍生字段(比如司龄、年龄等系统计算的字段) └ field_type String DDSelectField 字段类型："TextField", "文本"； "DDPhotoField", "附件"； "DDSelectField", "选项"； "DDDateField", "时间" └ option_text String [{\"label\":\"男\",\"value\":\"0\"},{\"label\":\"女\",\"value\":\"1\"}] 选型类型字段的kv值 └ required Boolean false 是否必填字段 └ detail Boolean false 分组是否支持明细
success	Boolean	true	服务调用成功
errcode	Number	0	错误码
errmsg	String	ok	错误信息

请求示例

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

DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/smartwork/hrm/roster/meta/get");
OapiSmartworkHrmRosterMetaGetRequest req = new OapiSmartworkHrmRosterMetaGetRequest();
req.setAgentid(123456L);
OapiSmartworkHrmRosterMetaGetResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());

IDingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/smartwork/hrm/roster/meta/get");
OapiSmartworkHrmRosterMetaGetRequest req = new OapiSmartworkHrmRosterMetaGetRequest();
req.Agentid = 123456L;
OapiSmartworkHrmRosterMetaGetResponse 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 OapiSmartworkHrmRosterMetaGetRequest;
$req->setAgentid("123456");
$resp = $c->execute($req, $access_token, "https://oapi.dingtalk.com/topapi/smartwork/hrm/roster/meta/get");

curl -X POST "https://oapi.dingtalk.com/topapi/smartwork/hrm/roster/meta/get" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=9f0debc2-d746-467e-85ca-6993c638323a' \
-d 'agentid=123456'

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

req=dingtalk.api.OapiSmartworkHrmRosterMetaGetRequest("https://oapi.dingtalk.com/topapi/smartwork/hrm/roster/meta/get")

req.agentid=123456
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.roster.meta.get");
add_param(pRequest,"agentid","123456");
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.roster.meta.get', {
	'agentid':'123456'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

响应示例

JSON示例

{
    "result":[
        {
                "group_name":"自定义分组",
                "group_id":"custom654390323db34a97942f00f2210cbe7b",
                "field_meta_info_list":[
                    {
                            "field_name":"自定义字段",
                            "field_code":"494c20ee-4aa1-4465-ae8c-a25e406219eb",
                            "derived":false,
                            "field_type":"DDSelectField",
                            "option_text":"[{\\\"label\\\":\\\"男\\\",\\\"value\\\":\\\"0\\\"},{\\\"label\\\":\\\"女\\\",\\\"value\\\":\\\"1\\\"}]",
                            "required":false
                    }
                ],
                "detail":false
        }
    ],
    "success":true,
    "errcode":0,
    "errmsg":"ok"
}

异常示例

JSON示例

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

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

钉钉API

dingtalk.oapi.smartwork.hrm.roster.meta.get (智能人事花名册元数据查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ