> ## 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.

# ロール詳細の取得

> ロール ID を指定してロール名や説明などを確認し、ロール管理に活用します

本インターフェースを呼び出して、ロール ID により指定したロールの詳細を取得します。

## リクエスト

| **基本情報**     |                                                                                            |
| ------------ | ------------------------------------------------------------------------------------------ |
| HTTP URL     | [https://api.dingtalk.io/topapi/role/getrole](https://api.dingtalk.io/topapi/role/getrole) |
| HTTP Method  | POST                                                                                       |
| サポートするアプリタイプ | appType-社内アプリ appType-サードパーティ社内アプリ                                                         |
| 権限要件         | permission-qyapi\_get\_department\_member-連絡先部門ユーザー読み取り権限                                  |

### クエリパラメータ

| 名前            | タイプ    | 必須 | 例        | 説明                                                                                                                                                                                     |
| ------------- | ------ | -- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| access\_token | String | はい | bE74xxxx | この API を呼び出すためのアプリ認証情報。   - 社内アプリの場合、[社内アプリの access\_token 取得](/ja/open/development/obtain-orgapp-token)インターフェースから取得します。 - サードパーティ社内アプリの場合、サードパーティ企業の access\_token 取得インターフェースから取得します。 |

### リクエストボディ

| 名前     | タイプ    | 必須 | 例          | 説明                                                                                                           |
| ------ | ------ | -- | ---------- | ------------------------------------------------------------------------------------------------------------ |
| roleId | Number | はい | 1581321999 | ロール ID。[ロールリストの取得](/ja/open/development/obtains-a-list-of-enterprise-roles)インターフェースを呼び出して id パラメータの値を取得できます。 |

### リクエスト例

```curl theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl -X POST "https://api.dingtalk.io/topapi/role/getrole" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=2c9ecxxxx4210' \
-d 'roleId=1001'
```

Java

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/role/getrole");
OapiRoleGetroleRequest req = new OapiRoleGetroleRequest();
req.setRoleId(1507113578L);
OapiRoleGetroleResponse 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.OapiRoleGetroleRequest("https://api.dingtalk.io/topapi/role/getrole")

req.roleId=1001
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 OapiRoleGetroleRequest;
$req->setRoleId("1001");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/role/getrole");
```

C#

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/role/getrole");
OapiRoleGetroleRequest req = new OapiRoleGetroleRequest();
req.RoleId = 1001L;
OapiRoleGetroleResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
```

## レスポンス

### レスポンスボディ

| 名前          | タイプ      | 例            | 説明              |
| ----------- | -------- | ------------ | --------------- |
| role        | OpenRole |              | ロール情報。          |
| name        | String   | 責任者          | ロール名。           |
| groupId     | Number   | 1507113577   | 所属するロールグループ ID。 |
| errcode     | Number   | 0            | リターンコード。        |
| errmsg      | String   | ok           | リターンコードの説明。     |
| request\_id | String   | 4cmr6app8ujf | リクエスト ID。       |

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

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "errcode":0,
  "role":{
    "groupId":1507113577,
    "name":"責任者"
  },
  "request_id":"4cmr6app8ujf"
}
```

### エラーコード

本インターフェースの呼び出しでエラーが発生した場合は、エラーメッセージをもとに[グローバルエラーコード](/ja/open/development/server-api-error-codes-1)ドキュメントから解決方法を検索してください。

| エラーコード（errcode） | エラーコードの説明（errmsg） | 解決方法                          |
| --------------- | ----------------- | ----------------------------- |
| 33011           | 無効な roleId        | roleId が正しいか確認してください          |
| 43007           | 操作権限が必要           | access\_token に権限があるか確認してください |
| 400001          | システムエラー           | 後で再試行してください                   |
