选择应用类型
第三方企业应用开发

获取企业职级列表新版SDK

更新于 2024-03-19调用本接口,分页查询企业的职级相关信息,包括职级ID、职级名称等信息。

调用说明

调用本接口前,需要对智能人事产品进行升级。有以下两种升级方式,选择方式一或者方式二进行升级。

说明

选择方式二升级后,调用通讯录部分接口时会报错,详情请查看本文后续方式二说明。

方式一: 智能人事内的岗位职级字段,升级为选项类型。

方式二: 智能人事升级职位管理功能。

说明

智能人事升级职位管理功能后,需注意以下:

调用通讯录更新用户信息V1接口和更新用户信息V2接口更新员工部门或者员工职位时,接口会出现报错,报错信息如下图所示。如果需要更新员工部门或者员工职位,请参考使用智能人事员工调岗接口。

接口功能介绍

例如,在钉钉工作台 > 智能人事 > 人事 > 职位管理 > 职级管理页面,职级列表中有个名为“测试职级1”的职级,测试职级1的职级名称是测试职级1,职级描述是测试职级1。

调用本接口可获取测试职级1的职级名称、职级描述等信息,如下图所示。

权限

要调用此API,需要以下权限之一。

应用类型

是否支持

权限

API Explorer调试

企业内部应用支持智能人事个人信息读权限API Explorer
第三方企业应用支持智能人事个人信息读权限API Explorer

请求方法

Loading...

Header参数

名称

类型

是否必填

描述

x-acs-dingtalk-access-token

String

调用该接口的访问凭证。

Query参数

名称

类型

是否必填

描述

rankCategoryId

String

职级序列ID。

  • 首次查询:需先调用本接口获取rankCategoryId。
  • 非首次查询:从首次查询中的信息中获取需要的rankCategoryId值。
说明

该参数为非必填参数。

rankCode

String

职级编码。

  • 首次查询:需先调用本接口获取rankCode。
  • 非首次查询:从首次查询中的信息中获取需要的rankCode值。
说明

该参数为非必填参数。

rankName

String

职级名称。

  • 首次查询:需先调用本接口获取rankName。
  • 非首次查询:从首次查询中的信息中获取需要的rankName值。
说明

该参数为非必填参数。

nextToken

Integer

分页游标。

  • 首次调用,该参数传0。

  • 非首次调用,该参数传上次调用本接口返回的nextToken。

maxResults

Integer

每页最大条目数,最大值200。

返回参数

名称

类型

描述

nextToken

Long

分页游标。

说明

如果该字段未返回,表示数据已经读取完毕。

hasMore

Boolean

是否有更多数据。

  • true:是

  • false:否

list

Array

职级信息列表。

rankId

String

职级ID。

rankCategoryId

String

职级序列ID。

说明

只有使用方式二-升级职位管理,调用接口才可以获取该字段。

rankCode

String

职级编码。

说明

只有使用方式二-升级职位管理,调用接口才可以获取该字段。

rankName

String

职级名称。

minJobGrade

Integer

最小等级。

说明

只有使用方式二-升级职位管理,调用接口才可以获取该字段。

maxJobGrade

Integer

最大等级。

说明

只有使用方式二-升级职位管理,调用接口才可以获取该字段。

rankDescription

String

职级描述。

说明

只有使用方式二-升级职位管理,调用接口才可以获取该字段。

示例

请求示例

Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...

返回示例

Loading...

错误码

HttpCode

错误码

错误信息

说明

400

invalidParameter

参数错误

参数错误

500

systemError

系统异常

系统异常

点击纠错