リクエスト
| 基本情報 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/role/simplelist |
| HTTP Method | POST |
| 対応アプリタイプ | appType-社内アプリappType-サードパーティ社内アプリ |
| 必要な権限 | permission-qyapi_get_department_member-連絡先の部門ユーザー読み取り権限 |
クエリパラメータ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| access_token | String | 必須 | bE74xxxx | この API を呼び出すためのアプリ認証情報。 - 社内アプリの場合、社内アプリの access_token 取得 API から取得します。 - サードパーティ社内アプリの場合、サードパーティ企業の access_token 取得 API から取得します。 |
リクエストボディ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| role_id | Number | 必須 | 1203141 | ロールの roleId。ロールリストの取得 API を呼び出して id パラメータの値を取得できます。 |
| size | Number | 任意 | 20 | ページサイズ。 説明 offset パラメータと同時に設定した場合にのみ有効です。このパラメータはページサイズを表します。デフォルトは 20、最大 100。 |
| offset | Number | 任意 | 0 | ページオフセット。 説明 size パラメータと同時に設定した場合にのみ有効です。このパラメータはオフセットを表し、オフセットは 0 から始まります。 |
リクエスト例
curl -X POST "https://api.dingtalk.io/topapi/role/simplelist" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=d1812xxxxc53245' \
-d 'offset=0' \
-d 'role_id=1203141' \
-d 'size=20'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/role/simplelist");
OapiRoleSimplelistRequest req = new OapiRoleSimplelistRequest();
req.setRoleId(1203141L);
req.setSize(20L);
req.setOffset(0L);
OapiRoleSimplelistResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiRoleSimplelistRequest("https://api.dingtalk.io/topapi/role/simplelist")
req.role_id=1203141
req.offset=0
req.size=20
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 OapiRoleSimplelistRequest;
$req->setRoleId("1203141");
$req->setOffset("0");
$req->setSize("20");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/role/simplelist");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/role/simplelist");
OapiRoleSimplelistRequest req = new OapiRoleSimplelistRequest();
req.RoleId = 1203141L;
req.Offset = 0L;
req.Size = 20L;
OapiRoleSimplelistResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
レスポンス
レスポンスボディ
| 名前 | タイプ | 例 | 説明 |
|---|---|---|---|
| request_id | String | f6249uw1kuus | リクエスト ID。 |
| errcode | Number | 0 | レスポンスコード。 |
| errmsg | String | ok | レスポンスコードの説明。 |
| result | PageVo | クエリ結果。 | |
| hasMore | Boolean | true | さらにデータがあるかどうか。 |
| list | OpenEmpSimple[] | ロールに属する社員リスト。 | |
| userid | String | manager4220 | 社員の userid。 |
| name | String | 山田太郎 | 社員の名前。 |
| manageScopes | OrgDeptVo[] | 管理範囲。 | |
| dept_id | Number | 11 | 部門 ID。 |
| name | String | 監査部 | 部門名。 |
レスポンスボディの例
{
"errcode": 0,
"result": {
"hasMore": false,
"list": [
{
"name": "山田太郎",
"userid": "manager4220",
"manageScopes":[
{
"dept_id":11,
"name":"監査部"
}
]
}
]
},
"request_id": "f6249uw1kuus"
}
エラーコード
この API の呼び出しでエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントで解決策を検索してください。| エラーコード(errorcode) | エラーコードの説明(errmsg) | 解決策 |
|---|---|---|
| 33011 | 無効な roleId | roleId が正しいか確認してください |
| 40069 | 無効な size | ページサイズを調整してください |
| 40068 | 無効なオフセット | オフセットを調整してください |
| 400001 | システムエラー | 後で再試行してください |