更新假期规则

PUT

/v1.0/attendance/leaves/types

接口调用量说明钉钉标准版接口累计可调用次数为1万次/月，当前接口会消耗调用次数。若该调用量无法满足需求，你可升级钉钉专业版(Open API调用量50万次/月)或钉钉专属版(Open API调用量500万次/月)扩容调用次数。

调用本接口，更新指定假期的相关规则。

接口适用范围

创建假期规则有2种方式，通过调用接口创建、通过钉钉官方应用考勤产品创建：

创建假期规则方式	调用本接口是否支持更新假期类型
调用添加假期规则接口创建的假期类型。企业内部应用，调用添加假期规则创建。第三方企业应用，调用添加假期规则创建。	支持
企业管理后台考勤应用创建的假期类型。考勤应用系统默认创建。通过考勤应用后台创建。	不支持

如下图所示，在考勤应用 > 假期管理 > 假期规则页面，可以查看共4个假期规则。

接口添加的假期1、接口添加的假期2，是通过接口创建的假期类型。调用本接口，可以更新假期相关的信息，如请假名称、请假单位、计算请假时长方式、余额范围等。

事假、调休，是考勤应用系统默认创建的假期类型。调用本接口，无法更新假期类型，报以下错误信息：errcode:880015,errmsg:批量leaveCode或userId都不存在。

说明

查询哪些假期规则是通过调用接口创建的，可调用查询假期类型列表接口获取：

企业内部应用，调用查询假期规则列表接口查询。

第三方企业应用，调用查询假期规则列表接口查询。

权限

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

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	钉钉假期管理的权限	API Explorer
第三方企业应用	支持	钉钉假期管理的权限	API Explorer
第三方个人应用	暂不支持	钉钉假期管理的权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	lieuLeaveValidityIncorrect	调休假有效期不正确	调休假有效期不正确
400	bizTypeCannotModified	假期业务类型不能修改	假期业务类型不能修改
400	lieuLeaveOnlyOne	加班调休全局只能有一个	加班调休全局只能有一个
400	bizTypeIncorrect	假期业务类型不正确	假期业务类型不正确
400	unitIncorrect	假期单位不正确	假期单位不正确
400	nameTooLong	假期名称过长	假期名称过长
400	nameAlreadyExists	已存在相同假期名称	已存在相同假期名称
400	leaveOrgIsUsed	只允许企业接入使用	只允许企业接入使用
400	notPermission	无访问权限	无访问权限
400	notManage	部门的管理员不存在	部门的管理员不存在
400	notFound	未找到该假期类型	未找到该假期类型
400	notUpdateType	假期业务类型不能修改	假期业务类型不能修改
400	tryAgainLater	更新失败，请稍后重试	更新失败，请稍后重试
400	updateSpeedfast	亲，该操作速度过快，请5分钟后再试	亲，该操作速度过快，请5分钟后再试
400	systemError	系统错误	系统错误
400	invalidParam	参数错误	参数错误

请求示例

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.dingtalk.com/v1.0/attendance/leaves/types?opUserId=String' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "leaveName" : "String",
  "leaveViewUnit" : "String",
  "bizType" : "String",
  "naturalDayLeave" : Boolean,
  "hoursInPerDay" : Long,
  "leaveCode" : "String",
  "extras" : "String",
  "visibilityRules" : [ {
    "visible" : [ "String" ],
    "type" : "String"
  } ],
  "submitTimeRule" : {
    "timeValue" : Long,
    "timeUnit" : "String",
    "timeType" : "String",
    "enableTimeLimit" : Boolean
  },
  "leaveCertificate" : {
    "unit" : "String",
    "duration" : Double,
    "enable" : Boolean,
    "promptInformation" : "String"
  }
}'

响应示例

{
    "result": {
        "leaveName": "string",
        "leaveCode": "string",
        "leaveViewUnit": "string",
        "bizType": "string",
        "naturalDayLeave": true,
        "hoursInPerDay": 0,
        "visibilityRules": [
            {
                "visible": [
                    "string"
                ],
                "type": "string"
            }
        ],
        "submitTimeRule": {
            "timeValue": 0,
            "timeUnit": "string",
            "timeType": "string",
            "enableTimeLimit": true
        },
        "leaveCertificate": {
            "unit": "string",
            "duration": 0,
            "enable": true,
            "promptInformation": "string"
        }
    }
}

请求参数

Query 参数

opUserId

string

必需

操作者userId。

示例值:

String

Header 参数

x-acs-dingtalk-access-token

string

必需

调用该接口的访问凭证。

企业内部应用，调用获取企业内部应用的accessToken接口获取。

第三方企业应用，调用获取第三方应用授权企业的accessToken接口获取。

Body 参数application/json

leaveName

string

假期名称。

可选

leaveViewUnit

string

必需

请假单位。 day：天 halfDay：半天 hour：小时

bizType

string

必需

假期类型。 general_leave：普通假期 lieu_leave：加班转调休

leaveCode

string

必需

接口添加的假期规则标识，leave_code必须是通过接口添加的假期类型。企业内部应用，调用添加假期规则接口获取的leave_code参数值。第三方企业应用，调用添加假期规则接口获取的leave_code参数值。

extras

string

可选

调休假有效期规则。 validity_type：有效类型 absolute_time：绝对时间 relative_time：相对时间 validity_value：延长日期当validity_type为absolute_time，该值不为空且满足“yy-mm”格式。当validity_type为relative_time，该值为大于1的整数。

visibilityRules

array [object {2}]

可选

适用范围规则列表，不传默认为全公司。

visible

array[string]

可选

适用范围内数据列表。当type=staff时，传员工userId列表。当type=dept时，传部门id列表。当type=label时，传角色id列表。

type

string

可选

适用范围规则类型。 dept：部门 staff：员工 label：角色

submitTimeRule

object

限时提交规则。

可选

timeUnit

string

必需

时间单位。 day：天 hour：小时

timeType

string

必需

限制类型。 before：提前 after：补交

leaveCertificate

object

请假证明。

可选

unit

string

必需

请假证明单位。 hour：小时 day：天

promptInformation

string

请假提示文案。

必需

示例

返回响应

🟢200成功

application/json

Body

result

object

返回信息。

必需

leaveName

string

假期名称。

必需

leaveCode

string

假期规则唯一标识。

必需

leaveViewUnit

string

必需

请假单位。 day：天 halfDay：半天 hour：小时

bizType

string

必需

假期类型。 general_leave：普通假期 lieu_leave：加班转调休

naturalDayLeave

boolean

必需

是否按照自然日统计请假时长。 true：是 false：否说明当为false的时候，用户发起请假时候会根据用户在请假时间段内的排班情况来计算请假时长。

hoursInPerDay

integer

必需

每天折算的工作时长，为参数值的百分之一。例如，某企业每天的工作时长设置为10小时，则该参数值为10*100=1000。

visibilityRules

array [object {2}]

必需

适用范围规则列表，不传默认为全公司。

submitTimeRule

object

限时提交规则。

必需

leaveCertificate

object

请假证明。

必需

修改于 2024-01-11 05:59:32

添加假期规则

删除假期规则

更新假期规则

接口适用范围#

权限#

错误码#

请求参数

返回响应

接口适用范围

权限

错误码