リクエスト
| ベーシック情報 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/attendance/group/search |
| HTTP メソッド | POST |
| 対応アプリタイプ | appType-社内アプリ appType-サードパーティ社内アプリ |
| 必要な権限 | permission-qyapi_attendance_group_read-勤怠グループの読み取り権限 |
クエリパラメータ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| access_token | String | はい | bE74xxxx | この API の呼び出しに使用するアプリ認証情報です。 - 社内アプリ:社内アプリの access_token を取得 API を呼び出して取得します。 - サードパーティ社内アプリ:サードパーティ組織の access_token を取得 API を呼び出して取得します。 |
リクエストボディ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| op_user_id | String | はい | manager123 | 操作者の userId です。 |
| group_name | String | はい | 勤怠 | 勤怠グループ名です。 |
リクエスト例
curl -X POST "https://api.dingtalk.io/topapi/attendance/group/search" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=d7689axxxx70e7a' \
-d 'group_name=%Exxxx%BA%97' \
-d 'op_user_id=dd_dd'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/group/search");
OapiAttendanceGroupSearchRequest req = new OapiAttendanceGroupSearchRequest();
req.setOpUserId("manager123");
req.setGroupName("勤怠");
OapiAttendanceGroupSearchResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiAttendanceGroupSearchRequest("https://api.dingtalk.io/topapi/attendance/group/search")
req.op_user_id="dd_dd"
req.group_name="渋谷店"
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 OapiAttendanceGroupSearchRequest;
$req->setOpUserId("dd_dd");
$req->setGroupName("渋谷店");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/attendance/group/search");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/group/search");
OapiAttendanceGroupSearchRequest req = new OapiAttendanceGroupSearchRequest();
req.OpUserId = "dd_dd";
req.GroupName = "渋谷店";
OapiAttendanceGroupSearchResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
レスポンス
レスポンスボディ
| 名前 | タイプ | 例 | 説明 |
|---|---|---|---|
| result | TopMinimalismGroupVO[] | クエリ結果です。 | |
| name | String | 勤怠 | 勤怠グループ名です。 |
| id | Number | 685935028 | 勤怠グループ ID です。 |
| success | Boolean | true | クエリが成功したかどうかを示します。 - true:成功 - false:失敗 |
| errcode | Number | 0 | リターンコードです。 |
| request_id | String | 750mu3wy9fu | リクエスト ID です。 |
レスポンスボディの例
{
"errcode": 0,
"result": [
{
"id": 685935028,
"name": "勤怠"
}
],
"success": true,
"request_id": "750muu3wy9fu"
}