残業ルール一覧のページ単位の取得

この API を呼び出すと、勤怠の打刻設定に登録された残業ルールの一覧をページ単位で取得できます。各ルールの名前と ID が含まれます。

API 呼び出し説明

たとえば、社内の勤怠ルール管理に 承認後に打刻時間で残業を計算、承認時間で残業を計算、打刻時間で残業を計算 の 3 つの残業ルールがあるとします。この API を呼び出すと、3 つの残業ルールすべてのルール名とルール ID を取得できます。残業ルールは 勤怠ルール管理 > 残業ルール で管理します。残業ルールを追加 からルールを追加でき、既存のルールは編集または削除できます。例に挙げた 3 つのルールの動作は次のとおりです。

ルール名	コンテンツ（勤務日 / 休息日 / 祝日）	適用範囲
承認時間で残業を計算	残業には承認が必要です。残業時間は承認フォームに基づきます	企業全体（他の残業ルールが適用されているメンバーを除く）
承認後に打刻時間で残業を計算	残業には承認が必要です。打刻に基づきますが、承認フォームの時間を超えることはできません	未使用
打刻時間で残業を計算	残業に承認は不要です。残業時間は打刻時間から計算されます	未使用

リクエスト

基本情報

フィールド	値
HTTP URL	https://api.dingtalk.io/v1.0/attendance/overtimeSettings
HTTP メソッド	GET
対応するアプリタイプ	appType-社内アプリ　appType-サードパーティ社内アプリ
必要な権限	permission-qyapi_attendance_group_read-勤怠グループの読み取り権限

リクエストヘッダー

名前	タイプ	必須	説明
x-acs-dingtalk-access-token	String	はい	この API を呼び出すためのアクセス認証情報です。以下の方法で取得します。 - 社内アプリ：社内アプリのアクセストークンを取得 API を呼び出します。 - サードパーティ社内アプリ：サードパーティアプリを承認した組織のアクセストークンを取得する API を呼び出します。

クエリパラメータ

名前	タイプ	必須	説明
pageNumber	Long	はい	開始ページ番号です。値は 1 から始まります。
pageSize	Long	はい	1 ページあたりの件数です。最大値は 50 です。

リクエスト例

HTTP

GET /v1.0/attendance/overtimeSettings?pageNumber=1&pageSize=10 HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:xxxxx
Content-Type:application/json

Java

// このファイルは自動生成されています。編集しないでください。
package com.aliyun.sample;

import com.aliyun.tea.*;

public class Sample {

    /**
     * トークンを使用してアカウント 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.GetSimpleOvertimeSettingHeaders getSimpleOvertimeSettingHeaders = new com.aliyun.dingtalkattendance_1_0.models.GetSimpleOvertimeSettingHeaders();
        getSimpleOvertimeSettingHeaders.xAcsDingtalkAccessToken = "<your access token>";
        com.aliyun.dingtalkattendance_1_0.models.GetSimpleOvertimeSettingRequest getSimpleOvertimeSettingRequest = new com.aliyun.dingtalkattendance_1_0.models.GetSimpleOvertimeSettingRequest()
                .setPageNumber(1L)
                .setPageSize(10L);
        try {
            client.getSimpleOvertimeSettingWithOptions(getSimpleOvertimeSettingRequest, getSimpleOvertimeSettingHeaders, 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 属性が含まれます
            }

        }        
    }
}

Python

# -*- 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:
        """
        トークンを使用してアカウント 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()
        get_simple_overtime_setting_headers = dingtalkattendance__1__0_models.GetSimpleOvertimeSettingHeaders()
        get_simple_overtime_setting_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_simple_overtime_setting_request = dingtalkattendance__1__0_models.GetSimpleOvertimeSettingRequest(
            page_number=1,
            page_size=10
        )
        try:
            client.get_simple_overtime_setting_with_options(get_simple_overtime_setting_request, get_simple_overtime_setting_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()
        get_simple_overtime_setting_headers = dingtalkattendance__1__0_models.GetSimpleOvertimeSettingHeaders()
        get_simple_overtime_setting_headers.x_acs_dingtalk_access_token = '<your access token>'
        get_simple_overtime_setting_request = dingtalkattendance__1__0_models.GetSimpleOvertimeSettingRequest(
            page_number=1,
            page_size=10
        )
        try:
            await client.get_simple_overtime_setting_with_options_async(get_simple_overtime_setting_request, get_simple_overtime_setting_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

<?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\GetSimpleOvertimeSettingHeaders;
use AlibabaCloud\SDK\Dingtalk\Vattendance_1_0\Models\GetSimpleOvertimeSettingRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;

class Sample {

    /**
     * トークンを使用してアカウント 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();
        $getSimpleOvertimeSettingHeaders = new GetSimpleOvertimeSettingHeaders([]);
        $getSimpleOvertimeSettingHeaders->xAcsDingtalkAccessToken = "<your access token>";
        $getSimpleOvertimeSettingRequest = new GetSimpleOvertimeSettingRequest([
            "pageNumber" => 1,
            "pageSize" => 10
        ]);
        try {
            $client->getSimpleOvertimeSettingWithOptions($getSimpleOvertimeSettingRequest, $getSimpleOvertimeSettingHeaders, 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"
)

/**
 * トークンを使用してアカウント 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
  }

  getSimpleOvertimeSettingHeaders := &dingtalkattendance_1_0.GetSimpleOvertimeSettingHeaders{}
  getSimpleOvertimeSettingHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
  getSimpleOvertimeSettingRequest := &dingtalkattendance_1_0.GetSimpleOvertimeSettingRequest{
    PageNumber: tea.Int64(1),
    PageSize: tea.Int64(10),
  }
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    _, _err = client.GetSimpleOvertimeSettingWithOptions(getSimpleOvertimeSettingRequest, getSimpleOvertimeSettingHeaders, &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)
  }
}

Node.js

// このファイルは自動生成されています。編集しないでください
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 {

  /**
   * トークンを使用してアカウント 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 getSimpleOvertimeSettingHeaders = new $dingtalkattendance_1_0.GetSimpleOvertimeSettingHeaders({ });
    getSimpleOvertimeSettingHeaders.xAcsDingtalkAccessToken = "<your access token>";
    let getSimpleOvertimeSettingRequest = new $dingtalkattendance_1_0.GetSimpleOvertimeSettingRequest({
      pageNumber: 1,
      pageSize: 10,
    });
    try {
      await client.getSimpleOvertimeSettingWithOptions(getSimpleOvertimeSettingRequest, getSimpleOvertimeSettingHeaders, 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 
    {

        /**
         * トークンを使用してアカウント 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.GetSimpleOvertimeSettingHeaders getSimpleOvertimeSettingHeaders = new AlibabaCloud.SDK.Dingtalkattendance_1_0.Models.GetSimpleOvertimeSettingHeaders();
            getSimpleOvertimeSettingHeaders.XAcsDingtalkAccessToken = "<your access token>";
            AlibabaCloud.SDK.Dingtalkattendance_1_0.Models.GetSimpleOvertimeSettingRequest getSimpleOvertimeSettingRequest = new AlibabaCloud.SDK.Dingtalkattendance_1_0.Models.GetSimpleOvertimeSettingRequest
            {
                PageNumber = 1,
                PageSize = 10,
            };
            try
            {
                client.GetSimpleOvertimeSettingWithOptions(getSimpleOvertimeSettingRequest, getSimpleOvertimeSettingHeaders, 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	返される結果です。
pageNumber	Long	現在のページ番号です。
totalPage	Long	総ページ数です。
items	Array	残業ルールの一覧です。
id	Long	残業ルールの ID です。
name	String	残業ルールの名前です。
settingId	Long	残業ルールの settingId です。

レスポンスボディの例

HTTP/1.1 200 OK
Content-Type:application/json

{
  "result" : {
    "pageNumber" : 1,
    "totalPage" : 10,
    "items" : [ {
      "id" : 221375127,
      "name" : "承認時間で残業を計算",
      "settingId" : 221375127
    } ]
  }
}

エラーコード

API 呼び出しでエラーが返された場合は、エラーメッセージをもとにグローバルエラーコードドキュメントで解決方法を確認してください。

HttpCode	エラーコード	エラーメッセージ	説明
400	system.error	システムエラー	システムエラー
400	paging.parameter.error	ページングのパラメータエラー	ページングのパラメータエラー

API 呼び出しガイド

認証と認可

連絡先

カレンダー

会議

AI Table

勤怠

Docs とファイル

IM

残業ルール一覧のページ単位の取得

API 呼び出し説明

リクエスト

基本情報

リクエストヘッダー

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディの例

エラーコード

​API 呼び出し説明

​リクエスト

​基本情報

​リクエストヘッダー

​クエリパラメータ

​リクエスト例

​レスポンス

​レスポンスボディ

​レスポンスボディの例

​エラーコード

API 呼び出し説明

リクエスト

基本情報

リクエストヘッダー

クエリパラメータ

リクエスト例

レスポンス

レスポンスボディ

レスポンスボディの例

エラーコード