リクエスト
| 基本情報 | |
|---|---|
| HTTP URL | https://api.dingtalk.io/topapi/v2/department/listparentbydept |
| HTTP Method | POST |
| サポートされるアプリタイプ | appType-社内アプリ appType-サードパーティ社内アプリ |
| 権限要件 | permission-qyapi_get_department_list-連絡先部門情報の読み取り権限 |
クエリパラメータ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| access_token | String | はい | bE74xxxx | 当該APIを呼び出すためのアプリ認証情報。 - 社内アプリの場合、社内アプリの access_token 取得インターフェースから取得します。 - サードパーティ社内アプリの場合、サードパーティ企業の access_token 取得インターフェースから取得します。 |
リクエストボディ
| 名前 | タイプ | 必須 | 例 | 説明 |
|---|---|---|---|---|
| dept_id | Number | はい | 42xxxx36 | 検索する部門ID。部門リストの取得 インターフェースを呼び出して dept_id パラメータの値を取得できます。 |
リクエスト例
curl -X POST "https://api.dingtalk.io/topapi/v2/department/listparentbydept" \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'access_token=a456xxxx13da5' \
-d 'dept_id=100'
DingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/v2/department/listparentbydept");
OapiV2DepartmentListparentbydeptRequest req = new OapiV2DepartmentListparentbydeptRequest();
req.setDeptId(100L);
OapiV2DepartmentListparentbydeptResponse rsp = client.execute(req, access_token);
System.out.println(rsp.getBody());
import dingtalk.api
req=dingtalk.api.OapiV2DepartmentListparentbydeptRequest("https://api.dingtalk.io/topapi/v2/department/listparentbydept")
req.dept_id=100
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 OapiV2DepartmentListparentbydeptRequest;
$req->setDeptId("100");
$resp = $c->execute($req, $access_token, "https://api.dingtalk.io/topapi/v2/department/listparentbydept");
IDingTalkClient client = new DefaultDingTalkClient("https://api.dingtalk.io/topapi/v2/department/listparentbydept");
OapiV2DepartmentListparentbydeptRequest req = new OapiV2DepartmentListparentbydeptRequest();
req.DeptId = 100L;
OapiV2DepartmentListparentbydeptResponse rsp = client.Execute(req, access_token);
Console.WriteLine(rsp.Body);
レスポンス
レスポンスボディ
| 名前 | タイプ | 例 | 説明 |
|---|---|---|---|
| request_id | String | 10u9dj0853fwe | リクエストID。 |
| errcode | Number | 0 | リターンコード。 |
| errmsg | String | 不正な部門ID | 呼び出しに失敗した場合に返されるエラーメッセージ。 |
| result | DeptListParentByDeptIdResponse | 親部門IDリスト。 | |
| parent_id_list | Number[] | [789, 456, 123, 1] | 当該部門のすべての親部門IDリスト。 説明 取得した list の最初の要素は現在の部門ID、最後の要素は親部門IDであり、左から右に部門階層が高くなっていきます。 |
レスポンスボディの例
{
"errcode": 0,
"errmsg": "ok",
"result": {
"parent_id_list": [
42xxxx36,
1
]
},
"request_id": "ov7bc964j9pe"
}
エラーコード
本インターフェースの呼び出しでエラーが発生した場合、エラーメッセージをもとに グローバルエラーコード ドキュメントから解決策を検索してください。| エラーコード(errcode) | エラーコードの説明(errmsg) | 解決策 |
|---|---|---|
| 43007 | 権限付与が必要 | access_token に操作権限があるかご確認ください |
| 60003 | 対応する部門が見つかりません | dept_id が正しいかご確認ください |
| 400002 | 無効なパラメータ | パラメータが要件どおりに入力されているかご確認ください |
| -1 | システムビジー | 後でもう一度お試しください |