API 呼び出し説明
休暇ルールの作成方法は 2 つあります。API を呼び出して作成する方法と、DingTalk 公式の勤怠アプリで作成する方法です。| 休暇ルールの作成方法 | この API による休暇タイプの更新可否 |
|---|---|
| 休暇ルールの追加 API を呼び出して作成した休暇タイプ | 可 |
| 管理コンソールの勤怠アプリで作成した休暇タイプ - 勤怠アプリのシステムによりデフォルトで作成されたもの - 勤怠アプリの管理画面で作成したもの | 不可 |
- 「API で作成した休暇タイプ1」と「API で作成した休暇タイプ2」は API で作成されたものです。この API を呼び出して、休暇名、休暇申請の単位、休暇時間の計算方法、残高の適用範囲などの情報を更新できます。
- 「私用休暇」と「代休」は、勤怠アプリのシステムによりデフォルトで作成された休暇タイプです。この API ではこれらの休暇タイプを更新できず、次のエラーメッセージが返されます:errcode:880015,errmsg:指定された leaveCode または userId が存在しません。
API で作成された休暇ルールを確認するには、休暇ルール一覧の取得 API を呼び出してください。
| 列 | 説明 |
|---|---|
| 休暇名 | 例:私用休暇、代休、API で作成した休暇タイプ1/2 |
| 休暇申請の単位 | 時間単位 または 日単位 |
| 休暇時間の計算方法 | 例:勤務日で計算 |
| 残高ルール | 例:残高制限なし |
| 適用範囲 | 例:全社 |
| 操作 | 編集、削除 |
リクエスト
基本情報
| フィールド | 値 |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/attendance/leaves/types |
| HTTP メソッド | PUT |
| 対応するアプリタイプ | appType-社内アプリ appType-サードパーティ社内アプリ |
| 必要な権限 | permission-qyapi_holiday_manage-DingTalk 休暇管理権限 |
リクエストヘッダー
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | はい | この API を呼び出すためのアクセス認証情報です。次の方法で取得します。 - 社内アプリ:社内アプリのアクセストークンの取得 API を呼び出します。 - サードパーティ社内アプリ:サードパーティアプリに権限を付与した組織のアクセストークンを取得する API を呼び出します。 |
クエリパラメータ
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| opUserId | String | はい | 操作者の userId です。 |
リクエストボディ
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| leaveName | String | いいえ | 休暇名です。 |
| leaveViewUnit | String | はい | 休暇申請の単位です。 - day:日 - halfDay:半日 - hour:時間 |
| bizType | String | はい | 休暇タイプです。 - general_leave:通常の休暇 - lieu_leave:残業を代休に振り替える休暇 |
| naturalDayLeave | Boolean | いいえ | 休暇時間を暦日で計算するかどうかを指定します。 - true:はい - false:いいえ 例えば、社員の山田さんが、2022年4月11日 9:30 から 2022年4月18日 18:30 までの休暇申請の承認フォームを提出したとします。4月16日と4月17日は土曜日・日曜日の休日です。 - このパラメータが true の場合、承認フォームの休暇日数は、勤務予定のない休日と祝日を含めて 8 日として計算されます。 - このパラメータが false の場合、承認フォームの休暇日数は、勤務予定のない休日と祝日を除いて 6 日として計算されます。 |
| hoursInPerDay | Long | いいえ | 換算に使用する 1 日あたりの労働時間です。パラメータ値を 100 で割った値になります。 例えば、社員のシフトの労働時間が 8 時間の場合、このパラメータには 8*100=800 を設定します。 |
| leaveCode | String | はい | API で追加した休暇ルールの識別子です。leave_code は、API で追加した休暇タイプに属するものである必要があります。 - 社内アプリ:休暇ルールの追加 API が返す leave_code の値を使用します。 - サードパーティ社内アプリ:休暇ルールの追加 API が返す 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 | いいえ | 適用範囲ルールのリストです。指定しない場合、ルールは全社に適用されます。 |
| visible | Array of String | いいえ | 適用範囲に含まれるデータのリストです。 - type=staff の場合、社員の userId のリストを渡します。 - type=dept の場合、部門 ID のリストを渡します。 - type=label の場合、ロール ID のリストを渡します。 |
| type | String | いいえ | 適用範囲ルールのタイプです。 - dept:部門 - staff:社員 - label:ロール |
| submitTimeRule | Object | いいえ | 提出期限ルールです。 |
| timeValue | Long | いいえ | 制限値です。 - timeUnit が day の場合、有効範囲は 0〜30 日です。 - timeUnit が hour の場合、有効範囲は 0〜24 時間です。 |
| timeUnit | String | いいえ | 時間の単位です。 - day:日 - hour:時間 |
| timeType | String | いいえ | 制限のタイプです。 - before:事前提出 - after:事後提出 |
| enableTimeLimit | Boolean | いいえ | 提出期限を有効にするかどうかを指定します。 - true:オン - false:オフ |
| leaveCertificate | Object | いいえ | 休暇証明です。 |
| unit | String | いいえ | 休暇証明の単位です。 - hour:時間 - day:日 |
| duration | double | いいえ | 休暇証明が必要となる休暇時間のしきい値です。 |
| enable | Boolean | いいえ | 休暇証明を必須にするかどうかを指定します。 - true:オン - false:オフ |
| promptInformation | String | いいえ | 休暇申請時に表示するプロンプトテキストです。 |
リクエスト例
HTTPPUT /v1.0/attendance/leaves/types?opUserId=user01 HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:1d97cxxx
Content-Type:application/json
{
"leaveName" : "年次有給休暇",
"leaveViewUnit" : "day",
"bizType" : "general_leave",
"naturalDayLeave" : true,
"hoursInPerDay" : 1000,
"leaveCode" : "047477ae-1009-4632-b8e9-e919ae5e7973",
"extras" : "{\"validity_type\":\"absolute_time\",\"validity_value\":\"12-31\"}",
"visibilityRules" : [ {
"visible" : [ "user01" ],
"type" : "staff"
} ],
"submitTimeRule" : {
"timeValue" : 2,
"timeUnit" : "day",
"timeType" : "before",
"enableTimeLimit" : true
},
"leaveCertificate" : {
"unit" : "hour",
"duration" : 1.0,
"enable" : false,
"promptInformation" : "休暇申請に関するお知らせ"
}
}
// このファイルは自動生成されています。編集しないでください。
package com.aliyun.sample;
import com.aliyun.tea.*;
public class Sample {
/**
* Token を使用してアカウント Client を初期化します
* @return Client
* @throws Exception
*/
public static com.aliyun.dingtalkattendance_1_0.Client createClient() throws Exception {
com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config();
config.protocol = "https";
config.regionId = "central";
return new com.aliyun.dingtalkattendance_1_0.Client(config);
}
public static void main(String[] args_) throws Exception {
java.util.List<String> args = java.util.Arrays.asList(args_);
com.aliyun.dingtalkattendance_1_0.Client client = Sample.createClient();
com.aliyun.dingtalkattendance_1_0.models.UpdateLeaveTypeHeaders updateLeaveTypeHeaders = new com.aliyun.dingtalkattendance_1_0.models.UpdateLeaveTypeHeaders();
updateLeaveTypeHeaders.xAcsDingtalkAccessToken = "<your access token>";
com.aliyun.dingtalkattendance_1_0.models.UpdateLeaveTypeRequest.UpdateLeaveTypeRequestLeaveCertificate leaveCertificate = new com.aliyun.dingtalkattendance_1_0.models.UpdateLeaveTypeRequest.UpdateLeaveTypeRequestLeaveCertificate()
.setUnit("hour")
.setDuration(1D)
.setEnable(false)
.setPromptInformation("休暇申請に関するお知らせ");
com.aliyun.dingtalkattendance_1_0.models.UpdateLeaveTypeRequest.UpdateLeaveTypeRequestSubmitTimeRule submitTimeRule = new com.aliyun.dingtalkattendance_1_0.models.UpdateLeaveTypeRequest.UpdateLeaveTypeRequestSubmitTimeRule()
.setTimeValue(2L)
.setTimeUnit("day")
.setTimeType("before")
.setEnableTimeLimit(true);
com.aliyun.dingtalkattendance_1_0.models.UpdateLeaveTypeRequest.UpdateLeaveTypeRequestVisibilityRules visibilityRules0 = new com.aliyun.dingtalkattendance_1_0.models.UpdateLeaveTypeRequest.UpdateLeaveTypeRequestVisibilityRules()
.setVisible(java.util.Arrays.asList(
"user01"
))
.setType("staff");
com.aliyun.dingtalkattendance_1_0.models.UpdateLeaveTypeRequest updateLeaveTypeRequest = new com.aliyun.dingtalkattendance_1_0.models.UpdateLeaveTypeRequest()
.setOpUserId("user01")
.setLeaveName("年次有給休暇")
.setLeaveViewUnit("day")
.setBizType("general_leave")
.setNaturalDayLeave(true)
.setHoursInPerDay(1000L)
.setLeaveCode("047477ae-1009-4632-b8e9-e919ae5e7973")
.setExtras("{\"validity_type\":\"absolute_time\",\"validity_value\":\"12-31\"}")
.setVisibilityRules(java.util.Arrays.asList(
visibilityRules0
))
.setSubmitTimeRule(submitTimeRule)
.setLeaveCertificate(leaveCertificate);
try {
client.updateLeaveTypeWithOptions(updateLeaveTypeRequest, updateLeaveTypeHeaders, new com.aliyun.teautil.models.RuntimeOptions());
} catch (TeaException err) {
if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
// err には code 属性と message 属性が含まれており、問題の特定に役立ちます
}
} catch (Exception _err) {
TeaException err = new TeaException(_err.getMessage(), _err);
if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
// err には code 属性と message 属性が含まれており、問題の特定に役立ちます
}
}
}
}
# -*- coding: utf-8 -*-
# このファイルは自動生成されています。編集しないでください。
import sys
from typing import List
from alibabacloud_dingtalk.attendance_1_0.client import Client as dingtalkattendance_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.attendance_1_0 import models as dingtalkattendance__1__0_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient
class Sample:
def __init__(self):
pass
@staticmethod
def create_client() -> dingtalkattendance_1_0Client:
"""
Token を使用してアカウント Client を初期化します
@return: Client
@throws Exception
"""
config = open_api_models.Config()
config.protocol = 'https'
config.region_id = 'central'
return dingtalkattendance_1_0Client(config)
@staticmethod
def main(
args: List[str],
) -> None:
client = Sample.create_client()
update_leave_type_headers = dingtalkattendance__1__0_models.UpdateLeaveTypeHeaders()
update_leave_type_headers.x_acs_dingtalk_access_token = '<your access token>'
leave_certificate = dingtalkattendance__1__0_models.UpdateLeaveTypeRequestLeaveCertificate(
unit='hour',
duration=1,
enable=False,
prompt_information='休暇申請に関するお知らせ'
)
submit_time_rule = dingtalkattendance__1__0_models.UpdateLeaveTypeRequestSubmitTimeRule(
time_value=2,
time_unit='day',
time_type='before',
enable_time_limit=True
)
visibility_rules_0 = dingtalkattendance__1__0_models.UpdateLeaveTypeRequestVisibilityRules(
visible=[
'user01'
],
type='staff'
)
update_leave_type_request = dingtalkattendance__1__0_models.UpdateLeaveTypeRequest(
op_user_id='user01',
leave_name='年次有給休暇',
leave_view_unit='day',
biz_type='general_leave',
natural_day_leave=True,
hours_in_per_day=1000,
leave_code='047477ae-1009-4632-b8e9-e919ae5e7973',
extras='{"validity_type":"absolute_time","validity_value":"12-31"}',
visibility_rules=[
visibility_rules_0
],
submit_time_rule=submit_time_rule,
leave_certificate=leave_certificate
)
try:
client.update_leave_type_with_options(update_leave_type_request, update_leave_type_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err には code 属性と message 属性が含まれており、問題の特定に役立ちます
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
update_leave_type_headers = dingtalkattendance__1__0_models.UpdateLeaveTypeHeaders()
update_leave_type_headers.x_acs_dingtalk_access_token = '<your access token>'
leave_certificate = dingtalkattendance__1__0_models.UpdateLeaveTypeRequestLeaveCertificate(
unit='hour',
duration=1,
enable=False,
prompt_information='休暇申請に関するお知らせ'
)
submit_time_rule = dingtalkattendance__1__0_models.UpdateLeaveTypeRequestSubmitTimeRule(
time_value=2,
time_unit='day',
time_type='before',
enable_time_limit=True
)
visibility_rules_0 = dingtalkattendance__1__0_models.UpdateLeaveTypeRequestVisibilityRules(
visible=[
'user01'
],
type='staff'
)
update_leave_type_request = dingtalkattendance__1__0_models.UpdateLeaveTypeRequest(
op_user_id='user01',
leave_name='年次有給休暇',
leave_view_unit='day',
biz_type='general_leave',
natural_day_leave=True,
hours_in_per_day=1000,
leave_code='047477ae-1009-4632-b8e9-e919ae5e7973',
extras='{"validity_type":"absolute_time","validity_value":"12-31"}',
visibility_rules=[
visibility_rules_0
],
submit_time_rule=submit_time_rule,
leave_certificate=leave_certificate
)
try:
await client.update_leave_type_with_options_async(update_leave_type_request, update_leave_type_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err には code 属性と message 属性が含まれており、問題の特定に役立ちます
pass
if __name__ == '__main__':
Sample.main(sys.argv[1:])
<?php
// このファイルは自動生成されています。編集しないでください。
namespace AlibabaCloud\SDK\Sample;
use AlibabaCloud\SDK\Dingtalk\Vattendance_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vattendance_1_0\Models\UpdateLeaveTypeHeaders;
use AlibabaCloud\SDK\Dingtalk\Vattendance_1_0\Models\UpdateLeaveTypeRequest\leaveCertificate;
use AlibabaCloud\SDK\Dingtalk\Vattendance_1_0\Models\UpdateLeaveTypeRequest\submitTimeRule;
use AlibabaCloud\SDK\Dingtalk\Vattendance_1_0\Models\UpdateLeaveTypeRequest\visibilityRules;
use AlibabaCloud\SDK\Dingtalk\Vattendance_1_0\Models\UpdateLeaveTypeRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* Token を使用してアカウント Client を初期化します
* @return Dingtalk Client
*/
public static function createClient(){
$config = new Config([]);
$config->protocol = "https";
$config->regionId = "central";
return new Dingtalk($config);
}
/**
* @param string[] $args
* @return void
*/
public static function main($args){
$client = self::createClient();
$updateLeaveTypeHeaders = new UpdateLeaveTypeHeaders([]);
$updateLeaveTypeHeaders->xAcsDingtalkAccessToken = "<your access token>";
$leaveCertificate = new leaveCertificate([
"unit" => "hour",
"duration" => 1,
"enable" => false,
"promptInformation" => "休暇申請に関するお知らせ"
]);
$submitTimeRule = new submitTimeRule([
"timeValue" => 2,
"timeUnit" => "day",
"timeType" => "before",
"enableTimeLimit" => true
]);
$visibilityRules0 = new visibilityRules([
"visible" => [
"user01"
],
"type" => "staff"
]);
$updateLeaveTypeRequest = new UpdateLeaveTypeRequest([
"opUserId" => "user01",
"leaveName" => "年次有給休暇",
"leaveViewUnit" => "day",
"bizType" => "general_leave",
"naturalDayLeave" => true,
"hoursInPerDay" => 1000,
"leaveCode" => "047477ae-1009-4632-b8e9-e919ae5e7973",
"extras" => "{\"validity_type\":\"absolute_time\",\"validity_value\":\"12-31\"}",
"visibilityRules" => [
$visibilityRules0
],
"submitTimeRule" => $submitTimeRule,
"leaveCertificate" => $leaveCertificate
]);
try {
$client->updateLeaveTypeWithOptions($updateLeaveTypeRequest, $updateLeaveTypeHeaders, new RuntimeOptions([]));
}
catch (Exception $err) {
if (!($err instanceof TeaError)) {
$err = new TeaError([], $err->getMessage(), $err->getCode(), $err);
}
if (!Utils::empty_($err->code) && !Utils::empty_($err->message)) {
// err には code 属性と message 属性が含まれており、問題の特定に役立ちます
}
}
}
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
require_once $path;
}
Sample::main(array_slice($argv, 1));
// このファイルは自動生成されています。編集しないでください。
package main
import (
"os"
util "github.com/alibabacloud-go/tea-utils/v2/service"
dingtalkattendance_1_0 "github.com/alibabacloud-go/dingtalk/attendance_1_0"
openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
"github.com/alibabacloud-go/tea/tea"
)
/**
* Token を使用してアカウント Client を初期化します
* @return Client
* @throws Exception
*/
func CreateClient () (_result *dingtalkattendance_1_0.Client, _err error) {
config := &openapi.Config{}
config.Protocol = tea.String("https")
config.RegionId = tea.String("central")
_result = &dingtalkattendance_1_0.Client{}
_result, _err = dingtalkattendance_1_0.NewClient(config)
return _result, _err
}
func _main (args []*string) (_err error) {
client, _err := CreateClient()
if _err != nil {
return _err
}
updateLeaveTypeHeaders := &dingtalkattendance_1_0.UpdateLeaveTypeHeaders{}
updateLeaveTypeHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
leaveCertificate := &dingtalkattendance_1_0.UpdateLeaveTypeRequestLeaveCertificate{
Unit: tea.String("hour"),
Duration: tea.Float64(1),
Enable: tea.Bool(false),
PromptInformation: tea.String("休暇申請に関するお知らせ"),
}
submitTimeRule := &dingtalkattendance_1_0.UpdateLeaveTypeRequestSubmitTimeRule{
TimeValue: tea.Int64(2),
TimeUnit: tea.String("day"),
TimeType: tea.String("before"),
EnableTimeLimit: tea.Bool(true),
}
visibilityRules0 := &dingtalkattendance_1_0.UpdateLeaveTypeRequestVisibilityRules{
Visible: []*string{tea.String("user01")},
Type: tea.String("staff"),
}
updateLeaveTypeRequest := &dingtalkattendance_1_0.UpdateLeaveTypeRequest{
OpUserId: tea.String("user01"),
LeaveName: tea.String("年次有給休暇"),
LeaveViewUnit: tea.String("day"),
BizType: tea.String("general_leave"),
NaturalDayLeave: tea.Bool(true),
HoursInPerDay: tea.Int64(1000),
LeaveCode: tea.String("047477ae-1009-4632-b8e9-e919ae5e7973"),
Extras: tea.String("{\"validity_type\":\"absolute_time\",\"validity_value\":\"12-31\"}"),
VisibilityRules: []*dingtalkattendance_1_0.UpdateLeaveTypeRequestVisibilityRules{visibilityRules0},
SubmitTimeRule: submitTimeRule,
LeaveCertificate: leaveCertificate,
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.UpdateLeaveTypeWithOptions(updateLeaveTypeRequest, updateLeaveTypeHeaders, &util.RuntimeOptions{})
if _err != nil {
return _err
}
return nil
}()
if tryErr != nil {
var err = &tea.SDKError{}
if _t, ok := tryErr.(*tea.SDKError); ok {
err = _t
} else {
err.Message = tea.String(tryErr.Error())
}
if !tea.BoolValue(util.Empty(err.Code)) && !tea.BoolValue(util.Empty(err.Message)) {
// err には code 属性と message 属性が含まれており、問題の特定に役立ちます
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
// このファイルは自動生成されています。編集しないでください
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkattendance_1_0, * as $dingtalkattendance_1_0 from '@alicloud/dingtalk/attendance_1_0';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import * as $tea from '@alicloud/tea-typescript';
export default class Client {
/**
* Token を使用してアカウント Client を初期化します
* @return Client
* @throws Exception
*/
static createClient(): dingtalkattendance_1_0 {
let config = new $OpenApi.Config({ });
config.protocol = "https";
config.regionId = "central";
return new dingtalkattendance_1_0(config);
}
static async main(args: string[]): Promise<void> {
let client = Client.createClient();
let updateLeaveTypeHeaders = new $dingtalkattendance_1_0.UpdateLeaveTypeHeaders({ });
updateLeaveTypeHeaders.xAcsDingtalkAccessToken = "<your access token>";
let leaveCertificate = new $dingtalkattendance_1_0.UpdateLeaveTypeRequestLeaveCertificate({
unit: "hour",
duration: 1,
enable: false,
promptInformation: "休暇申請に関するお知らせ",
});
let submitTimeRule = new $dingtalkattendance_1_0.UpdateLeaveTypeRequestSubmitTimeRule({
timeValue: 2,
timeUnit: "day",
timeType: "before",
enableTimeLimit: true,
});
let visibilityRules0 = new $dingtalkattendance_1_0.UpdateLeaveTypeRequestVisibilityRules({
visible: [
"user01"
],
type: "staff",
});
let updateLeaveTypeRequest = new $dingtalkattendance_1_0.UpdateLeaveTypeRequest({
opUserId: "user01",
leaveName: "年次有給休暇",
leaveViewUnit: "day",
bizType: "general_leave",
naturalDayLeave: true,
hoursInPerDay: 1000,
leaveCode: "047477ae-1009-4632-b8e9-e919ae5e7973",
extras: "{\"validity_type\":\"absolute_time\",\"validity_value\":\"12-31\"}",
visibilityRules: [
visibilityRules0
],
submitTimeRule: submitTimeRule,
leaveCertificate: leaveCertificate,
});
try {
await client.updateLeaveTypeWithOptions(updateLeaveTypeRequest, updateLeaveTypeHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// err には code 属性と message 属性が含まれており、問題の特定に役立ちます
}
}
}
}
Client.main(process.argv.slice(2));
// このファイルは自動生成されています。編集しないでください。
using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;
using Tea;
using Tea.Utils;
namespace AlibabaCloud.SDK.Sample
{
public class Sample
{
/**
* Token を使用してアカウント Client を初期化します
* @return Client
* @throws Exception
*/
public static AlibabaCloud.SDK.Dingtalkattendance_1_0.Client CreateClient()
{
AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
config.Protocol = "https";
config.RegionId = "central";
return new AlibabaCloud.SDK.Dingtalkattendance_1_0.Client(config);
}
public static void Main(string[] args)
{
AlibabaCloud.SDK.Dingtalkattendance_1_0.Client client = CreateClient();
AlibabaCloud.SDK.Dingtalkattendance_1_0.Models.UpdateLeaveTypeHeaders updateLeaveTypeHeaders = new AlibabaCloud.SDK.Dingtalkattendance_1_0.Models.UpdateLeaveTypeHeaders();
updateLeaveTypeHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkattendance_1_0.Models.UpdateLeaveTypeRequest.UpdateLeaveTypeRequestLeaveCertificate leaveCertificate = new AlibabaCloud.SDK.Dingtalkattendance_1_0.Models.UpdateLeaveTypeRequest.UpdateLeaveTypeRequestLeaveCertificate
{
Unit = "hour",
Duration = 1,
Enable = false,
PromptInformation = "休暇申請に関するお知らせ",
};
AlibabaCloud.SDK.Dingtalkattendance_1_0.Models.UpdateLeaveTypeRequest.UpdateLeaveTypeRequestSubmitTimeRule submitTimeRule = new AlibabaCloud.SDK.Dingtalkattendance_1_0.Models.UpdateLeaveTypeRequest.UpdateLeaveTypeRequestSubmitTimeRule
{
TimeValue = 2,
TimeUnit = "day",
TimeType = "before",
EnableTimeLimit = true,
};
AlibabaCloud.SDK.Dingtalkattendance_1_0.Models.UpdateLeaveTypeRequest.UpdateLeaveTypeRequestVisibilityRules visibilityRules0 = new AlibabaCloud.SDK.Dingtalkattendance_1_0.Models.UpdateLeaveTypeRequest.UpdateLeaveTypeRequestVisibilityRules
{
Visible = new List<string>
{
"user01"
},
Type = "staff",
};
AlibabaCloud.SDK.Dingtalkattendance_1_0.Models.UpdateLeaveTypeRequest updateLeaveTypeRequest = new AlibabaCloud.SDK.Dingtalkattendance_1_0.Models.UpdateLeaveTypeRequest
{
OpUserId = "user01",
LeaveName = "年次有給休暇",
LeaveViewUnit = "day",
BizType = "general_leave",
NaturalDayLeave = true,
HoursInPerDay = 1000,
LeaveCode = "047477ae-1009-4632-b8e9-e919ae5e7973",
Extras = "{\"validity_type\":\"absolute_time\",\"validity_value\":\"12-31\"}",
VisibilityRules = new List<AlibabaCloud.SDK.Dingtalkattendance_1_0.Models.UpdateLeaveTypeRequest.UpdateLeaveTypeRequestVisibilityRules>
{
visibilityRules0
},
SubmitTimeRule = submitTimeRule,
LeaveCertificate = leaveCertificate,
};
try
{
client.UpdateLeaveTypeWithOptions(updateLeaveTypeRequest, updateLeaveTypeHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// err には code 属性と message 属性が含まれており、問題の特定に役立ちます
}
}
catch (Exception _err)
{
TeaException err = new TeaException(new Dictionary<string, object>
{
{ "message", _err.Message }
});
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// err には code 属性と message 属性が含まれており、問題の特定に役立ちます
}
}
}
}
}
レスポンス
レスポンスボディ
| 名前 | タイプ | 説明 |
|---|---|---|
| result | Object | 戻り値です。 |
| leaveName | String | 休暇名です。 |
| leaveCode | String | 休暇タイプの一意の識別子です。 |
| leaveViewUnit | String | 休暇申請の単位です。 - day:日 - halfDay:半日 - hour:時間 |
| bizType | String | 休暇タイプです。 - general_leave:通常の休暇 - lieu_leave:残業を代休に振り替える休暇 |
| naturalDayLeave | Boolean | 休暇時間を暦日で計算するかどうかを示します。 - true:はい - false:いいえ 例えば、社員の山田さんが、2022年4月11日 9:30 から 2022年4月18日 18:30 までの休暇申請の承認フォームを提出したとします。4月16日と4月17日は土曜日・日曜日の休日です。 - このパラメータが true の場合、承認フォームの休暇日数は、勤務予定のない休日と祝日を含めて 8 日として計算されます。 - このパラメータが false の場合、承認フォームの休暇日数は、勤務予定のない休日と祝日を除いて 6 日として計算されます。 |
| hoursInPerDay | Long | 換算に使用する 1 日あたりの労働時間です。フィールド値を 100 で割った値になります。 例えば、社員のシフトの労働時間が 8 時間の場合、フィールド値は 8*100=800 になります。 |
| visibilityRules | Array | 適用範囲ルールのリストです。指定されていない場合、ルールは全社に適用されます。 |
| visible | Array of String | 適用範囲に含まれるデータのリストです。 - type=staff の場合、社員の userId のリストです。 - type=dept の場合、部門 ID のリストです。 - type=label の場合、ロール ID のリストです。 |
| type | String | 適用範囲ルールのタイプです。 - dept:部門 - staff:社員 - label:ロール |
| submitTimeRule | Object | 提出期限ルールです。 |
| timeValue | Long | 制限値です。 - timeUnit が day の場合、有効範囲は 0〜30 日です。 - timeUnit が hour の場合、有効範囲は 0〜24 時間です。 |
| timeUnit | String | 時間の単位です。 - day:日 - hour:時間 |
| timeType | String | 制限のタイプです。 - before:事前提出 - after:事後提出 |
| enableTimeLimit | Boolean | 提出期限が有効かどうかを示します。 - true:オン - false:オフ |
| leaveCertificate | Object | 休暇証明です。 |
| unit | String | 休暇証明の時間単位です。 - hour:時間 - day:日 |
| duration | double | 休暇証明が必要となる休暇時間のしきい値です。 |
| enable | Boolean | 休暇証明が必須かどうかを示します。 - true:オン - false:オフ |
| promptInformation | String | 休暇申請時に表示するプロンプトテキストです。 |
レスポンスボディの例
HTTP/1.1 200 OK
Content-Type:application/json
{
"result" : {
"leaveName" : "年次有給休暇",
"leaveCode" : "037477ae-1009-4632-b8e9-e919ae5e7973",
"leaveViewUnit" : "day",
"bizType" : "general_leave",
"naturalDayLeave" : true,
"hoursInPerDay" : 1000,
"visibilityRules" : [ {
"visible" : [ "user01" ],
"type" : "staff"
} ],
"submitTimeRule" : {
"timeValue" : 1,
"timeUnit" : "day",
"timeType" : "before",
"enableTimeLimit" : false
},
"leaveCertificate" : {
"unit" : "hour",
"duration" : 1,
"enable" : false,
"promptInformation" : "休暇申請に関するお知らせ"
}
}
}
エラーコード
API の呼び出しでエラーが返された場合は、エラーメッセージをもとに グローバルエラーコード ドキュメントで解決方法を確認してください。| HttpCode | エラーコード | エラーメッセージ | 説明 |
|---|---|---|---|
| 400 | lieuLeaveValidityIncorrect | 代休の有効期限が無効です | 代休の有効期限が無効です |
| 400 | bizTypeCannotModified | 休暇の業務タイプは変更できません | 休暇の業務タイプは変更できません |
| 400 | lieuLeaveOnlyOne | 残業の代休タイプは全体で 1 つのみ設定できます | 残業の代休タイプは全体で 1 つのみ設定できます |
| 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 | パラメータエラー | パラメータエラー |