リクエスト
| ベーシック情報 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/attendance/shift/search |
| HTTP メソッド | POST |
| 対応アプリタイプ | appType-社内アプリ appType-サードパーティ社内アプリ |
| 必須の権限 | qyapi_attendance_group_read(勤怠グループの読み取り権限) |
クエリパラメータ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| access_token | String | はい | 6d1bxxxx | この API を呼び出すためのアプリ認証情報です。 - 社内アプリ:社内アプリの access_token の取得 API を呼び出して取得します。 - サードパーティ社内アプリ:「サードパーティ社内アプリの access_token の取得」API を呼び出して取得します。 |
リクエストボディ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| op_user_id | String | はい | manager4220 | 操作者の userId です。 |
| shift_name | String | はい | A | シフト名です。 |
リクエスト例
curl -X POST "https://api.dingtalk.io/topapi/attendance/shift/search" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=ab85bxxxx739d5' \
-d 'op_user_id=dd_dd' \
-d 'shift_name=%E6%97%A5%E5%8B%A4'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/shift/search");
OapiAttendanceShiftSearchRequest req = new OapiAttendanceShiftSearchRequest();
req.setOpUserId("dd_dd");
req.setShiftName("日勤");
OapiAttendanceShiftSearchResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiAttendanceShiftSearchRequest("https://api.dingtalk.io/topapi/attendance/shift/search")
req.op_user_id="dd_dd"
req.shift_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 OapiAttendanceShiftSearchRequest;
$req->setOpUserId("dd_dd");
$req->setShiftName("日勤");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/attendance/shift/search");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/attendance/shift/search");
OapiAttendanceShiftSearchRequest req = new OapiAttendanceShiftSearchRequest();
req.OpUserId = "dd_dd";
req.ShiftName = "日勤";
OapiAttendanceShiftSearchResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
レスポンス
レスポンスボディ
| 名前 | タイプ | 例 | 説明 |
|---|---|---|---|
| result | TopMinimalismShiftVO[] | クエリ結果です。 | |
| name | String | 日勤 | シフト名です。 |
| id | Number | 677995086 | シフト ID です。 |
| success | Boolean | true | 呼び出しに成功したかどうかを示します。 - true:成功 - false:失敗 |
| errcode | Number | 0 | リターンコードです。 |
| errmsg | String | ok | リターンコードのメッセージです。 |
| request_id | String | 4wsw01tcq1h4 | リクエスト ID です。 |
レスポンスボディの例
{
"errcode": 0,
"errmsg":"ok",
"result": [
{
"id": 677995086,
"name": "日勤"
}
],
"success": true,
"request_id": "4wsw01tcq1h4"
}