リクエスト
| 基本情報 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/role/getrolegroup |
| HTTP Method | POST |
| サポートされるアプリタイプ | appType-社内アプリappType-サードパーティ社内アプリ |
| 必要な権限 | permission-qyapi_get_department_list-連絡先部門情報の読み取り権限 |
クエリパラメータ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| access_token | String | はい | bE74xxxx | このAPIを呼び出すためのアプリ認証情報。 - 社内アプリの場合、社内アプリのaccess_token取得インターフェースを通じて取得します。 - サードパーティ社内アプリの場合、サードパーティ企業のaccess_token取得インターフェースを通じて取得します。 |
リクエストボディ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| group_id | Number | はい | 1507113580 | ロールグループのID。 |
リクエスト例
curl -X POST "https://api.dingtalk.io/topapi/role/getrolegroup" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=ab02axxxx7d770' \
-d 'group_id=1'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/role/getrolegroup");
OapiRoleGetrolegroupRequest req = new OapiRoleGetrolegroupRequest();
req.setGroupId(1507113580L);
OapiRoleGetrolegroupResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiRoleGetrolegroupRequest("https://api.dingtalk.io/topapi/role/getrolegroup")
req.group_id=1
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 OapiRoleGetrolegroupRequest;
$req->setGroupId("1");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/role/getrolegroup");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/role/getrolegroup");
OapiRoleGetrolegroupRequest req = new OapiRoleGetrolegroupRequest();
req.GroupId = 1L;
OapiRoleGetrolegroupResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
レスポンス
レスポンスボディ
| 名前 | タイプ | 例 | 説明 |
|---|---|---|---|
| role_group | OpenRoleGroup | ロールグループ情報。 | |
| roles | OpenRole[] | ロールリスト情報。 | |
| role_id | Number | 1507113580 | ロールID。 |
| role_name | String | マネージャー | ロール名。 |
| group_name | String | 既定 | ロールグループ名。 |
| errcode | Number | 0 | リターンコード。 |
| errmsg | String | ok | リターンコードの説明。 |
| request_id | String | 8lgzequlri0o | リクエストID。 |
レスポンスボディ例
{
"errcode": 0,
"errmsg": "ok",
"role_group": {
"group_name": "デフォルト",
"roles": [
{
"role_name": "責任者",
"role_id": 1507113580
},
{
"role_name": "マネージャー",
"role_id": 1507113581
},
{
"role_name": "スーパー管理者",
"role_id": 1507113578
},
{
"role_name": "サブ管理者",
"role_id": 1507113579
}
]
},
"request_id": "8lgzequlri0o"
}
エラーコード
このインターフェースの呼び出しでエラーが発生した場合は、エラーメッセージをもとにグローバルエラーコードドキュメントで解決方法を検索してください。| エラーコード(errcode) | エラーコードの説明(errmsg) | 解決方法 |
|---|---|---|
| 400002 | 無効なパラメータ | groupIdが正しいかご確認ください |
| -1 | システムビジー | 後で再度お試しください |