開発ガイドAPI 呼び出し説明
- この API は、休暇関連フィールドの ID を返しません。休暇関連のデータを取得するには、レポートの休暇データを取得 API を呼び出してください。
- スマート統計機能が有効になっていることを確認してください。
リクエスト
| 基本情報 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/attendance/getattcolumns |
| HTTP メソッド | POST |
| 対応アプリタイプ | appType-社内アプリ appType-サードパーティ社内アプリ |
| 必要な権限 | permission-qyapi_base-組織 API の呼び出しに必要なベーシック権限 |
クエリパラメータ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| access_token | String | はい | bE74xxxx | この API の呼び出しに使用するアプリ認証情報です。 - 社内アプリの場合は、社内アプリの access_token を取得 API で取得します。 - サードパーティ社内アプリの場合は、サードパーティ組織の access_token を取得 API で取得します。 |
リクエスト例
curl -X POST "https://api.dingtalk.io/topapi/attendance/getattcolumns" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=1aae6dxxxx7bf36'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/getattcolumns");
OapiAttendanceGetattcolumnsRequest req = new OapiAttendanceGetattcolumnsRequest();
OapiAttendanceGetattcolumnsResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiAttendanceGetattcolumnsRequest("https://api.dingtalk.io/topapi/attendance/getattcolumns")
try:
resp= req.getResponse(access_token)
print(resp)
except Exception,e:
print(e)
include "TopSdk.php";
date_default_timezone_set('Asia/Shanghai');
$c = new DingTalkClient(DingTalkConstant::$CALL_TYPE_OAPI, DingTalkConstant::$METHOD_POST , DingTalkConstant::$FORMAT_JSON);
$req = new OapiAttendanceGetattcolumnsRequest;
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/attendance/getattcolumns");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/getattcolumns");
OapiAttendanceGetattcolumnsRequest req = new OapiAttendanceGetattcolumnsRequest();
OapiAttendanceGetattcolumnsResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
レスポンス
レスポンスボディ
| 名前 | タイプ | 例 | 説明 |
|---|---|---|---|
| request_id | String | emhw3318cdhv | リクエスト ID です。 |
| errcode | Number | 0 | 戻りコードです。 |
| result | AttColumnsForTopVo | 照会結果です。 | |
| columns | ColumnForTopVo[] | レポート列の情報です。 | |
| id | Number | 123 | レポート列の ID です。 |
| type | Number | 0 | レポート列のタイプです。 |
| name | String | 労働時間 | レポート列の名前です。 |
| alias | String | 3_on_duty_user_check_result | レポート列の表示名です。 |
| status | Number | 0 | レポート列のステータスです。 |
| sub_type | Number | 0 | サブタイプです。 |
| expression_id | Number | 129334038 | 廃止されたフィールドです。業務ロジックでは使用しないでください。 |
レスポンスボディの例
{
"errcode": 0,
"result": {
"columns": [
{
"alias": "should_attendance_days",
"expression_id": 129334038,
"id": 129339038,
"name": "所定出勤日数",
"status": 0,
"sub_type": 0,
"type": 0
},
{
"alias": "making_up_lack_times",
"expression_id": 129334039,
"id": 129339039,
"name": "打刻修正回数",
"status": 0,
"sub_type": 0,
"type": 0
}
]
},
"request_id": "10stq4mcre2wu"
}