获取花名册字段组详情

POST

http://127.0.0.1/topapi/smartwork/hrm/employee/field/grouplist

服务端API/智能人事/花名册

最后修改时间：2022-08-30 09:19:22

责任人：未设置

说明

调用本接口查询花名册的员工档案信息中有权限的字段列表。
服务地址：https://oapi.dingtalk.com

权限

服务端API是以应用维度授权的，在调用接口前，确保已经为应用添加了接口权限。详情请参考接口权限。

应用类型	是否支持调用	权限申请方式	API Explorer调试
企业内部应用	是	开发者后台申请	调试
第三方企业应用	否	—	—
第三方个人应用	否	—	—

请求参数

Query 参数

access_token

string

必需

调用服务端API授权凭证，可通过获取企业内部应用的access_token接口获取。

示例值:

6d1bxxxx

Body 参数application/json

agentid

number

必需

应用AgentID，可在钉钉开发者后台的应用详情页获取。

示例

{
  "agentid": "23470561"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://127.0.0.1/topapi/smartwork/hrm/employee/field/grouplist?access_token=6d1bxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "agentid": "23470561"
}'

返回响应

🟢200成功

application/json

Body

request_id

string

请求ID。

可选

errmsg

string

返回码描述。

可选

errcode

number

返回码。

可选

success

boolean

成功标记。

可选

result

array [object {3}]

返回结果。

可选

group_id

string

字段组ID。

可选

has_detail

boolean

是否支持明细。

可选

field_list

array [object {3}]

组里面的字段集合。

可选

示例

{
  "request_id": "string",
  "errmsg": "string",
  "errcode": 0,
  "success": true,
  "result": [
    {
      "group_id": "string",
      "has_detail": true,
      "field_list": [
        {
          "field_type": "string",
          "field_name": "string",
          "field_code": "string"
        }
      ]
    }
  ]
}

获取员工花名册字段信息

获取花名册字段组详情

说明#

权限#

请求参数

示例代码

返回响应

说明

权限