获取入职二维码维度
获取二维码启用的所有维度信息,包括部门、职务等维度
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/corehr/v2/onboarding_qr_codes/dimension |
| HTTP Method | POST |
| 接口频率限制 | 100 次/分钟 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | corehr:pre_hire:read 获取待入职人员信息 corehr:pre_hire:write 读写待入职人员信息 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 值格式:"Bearer access_token" 示例值:"Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ dimension_list | qr_code_dimension\[\] | 维度数据 |
└ api_name | string | 维度API name |
└ display_name | i18n_v2 | 维度名称 |
└ zh_cn | string | 中文名称 |
└ en_us | string | 英文名称 |
└ type | int | 维度类型 可选值有: - 1: 单选类型 - 2: 多选类型 - 3: 布尔类型 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"dimension_list": [
{
"api_name": "company",
"display_name": {
"zh_cn": "公司",
"en_us": "Company"
},
"type": 1
},
{
"api_name": "multi_select_field__c",
"display_name": {
"zh_cn": "多选字段",
"en_us": "multi_select_field"
},
"type": 2
},
{
"api_name": "bool_field__c",
"display_name": {
"zh_cn": "布尔字段",
"en_us": "bool_field"
},
"type": 3
}
]
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 1161001 | 参数错误 | 参数错误,请检查入参格式 |
