> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# 勤怠レポートの列定義の取得

> 勤怠レポートの列定義を取得する API です。各列の ID・タイプ・名前を取得でき、給与計算などに使う勤怠データの列を柔軟に選択できます。

この API を呼び出すと、列 ID を指定してスマート勤怠レポートの列の統計情報を照会します。組織は、給与計算に使用する列の値を選択できます。

## API 呼び出し説明

* この API は、休暇関連フィールドの ID を返しません。休暇関連のデータを取得するには、[レポートの休暇データを取得](https://help.dingtalk.io/ja/open/development/obtains-the-holiday-data-from-the-smart-attendance-report.md) API を呼び出してください。
* スマート統計機能が有効になっていることを確認してください。

## リクエスト

| **基本情報** | |
| - | - |
| HTTP URL | [https://api.dingtalk.io/topapi/attendance/getattcolumns](https://api.dingtalk.io/topapi/attendance/getattcolumns) |
| HTTP メソッド | POST |
| 対応アプリタイプ | appType-社内アプリ　appType-サードパーティ社内アプリ |
| 必要な権限 | permission-qyapi\_base-組織 API の呼び出しに必要なベーシック権限 |

### クエリパラメータ

| 名前 | タイプ | 必須 | 例 | 説明 |
| - | - | - | - | - |
| access\_token | String | はい | bE74xxxx | この API の呼び出しに使用するアプリ認証情報です。   - 社内アプリの場合は、[社内アプリの access\_token を取得](https://help.dingtalk.io/ja/open/development/obtain-orgapp-token) API で取得します。 - サードパーティ社内アプリの場合は、サードパーティ組織の access\_token を取得 API で取得します。 |

### リクエスト例

```curl theme={"theme":{"light":"github-light","dark":"github-dark"}}
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'
```

Java

```java theme={"theme":{"light":"github-light","dark":"github-dark"}}
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());
```

Python

```python theme={"theme":{"light":"github-light","dark":"github-dark"}}
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)
```

PHP

```php theme={"theme":{"light":"github-light","dark":"github-dark"}}
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");
```

C#

```csharp theme={"theme":{"light":"github-light","dark":"github-dark"}}
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 | 廃止されたフィールドです。業務ロジックでは使用しないでください。 |

### レスポンスボディの例

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "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"
}
```

### エラーコード

この API の呼び出しに失敗した場合は、エラーメッセージをもとに[グローバルエラーコード](https://help.dingtalk.io/ja/open/development/server-api-error-codes-1.md)ドキュメントで解決方法を確認してください。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.