組織

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

説明

パートナー会社に連携されている顧客会社の部署リストを照会する。

リクエストヘッダ共通

Header	Description
x-ncp-apigw-timestamp	* 1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表したもの * API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
x-ncp-iam-access-key	* NAVERクラウドプラットフォームポータルまたはSub Accountで発行されたAccess Key ID
x-ncp-apigw-signature-v2	* 上記例のBodyをAccess Key IDとマッピングするSecret Keyで暗号化した署名 * HMAC暗号化アルゴリズムは、HmacSHA256を使用

組織リスト照会API

組織リストを照会する。

リクエストURL

GET https://workplace.apigw.ntruss.com/partner/apigw/v2/partner/{partnerId}/company/{companyId}/department

リクエストパスパラメータ

パラメータ	タイプ	サイズ	必須の有無	説明
partnerId	String	15	Y	WORKPLACEで提供されたパートナーID
companyId	String	36	Y	照会する顧客会社の連携キー(CompanyId) `Developers > 基本設定 > 連携キー`

リクエストパラメータ

パラメータ	タイプ	サイズ	必須の有無	説明
offset	long		N	オフセット行から出力
limit	long		N	リミットの数だけ出力

リクエストボディパラメータ

パラメータ	タイプ	サイズ	必須の有無	説明
tenantId	String	100	Y	顧客会社のtenant ID
companyId	String	100	Y	顧客会社company ID
name	String	100	Y	部署名
i18nNames	Map		N	部署の多言語表記`Map<Locale, String> i18nNames`
deptExternalKey	String	100	Y	部署の外部キー
parentDeptExternalKey	String	100	Y	上位部署の外部キー(最上位組織の場合のみ#)
deptEmailAddress	String	100	N	部署のメールアドレス
externalEmailReceiveYn	boolean		N	外部メールを受信するかどうか
dispOrd	String	10	Y	組織図部署の表示順序
deptNo	String	36	Y	部署key
parentDeptNo	String	36	Y	上位部署key(最上位組織の場合のみ#)
deptLeaderEmpId	String	36	Y	部署長のempId

リクエスト例

GET https://workplace.apigw.ntruss.com/partner/apigw/v2/partner/partnertestid/company/1663a976-32c9-48a4-8edb-f1ffcefb1bf3/department?offset=0&limit=10

GET /partner/apigw/v2/partner/partnertestid/company/1663a976-32c9-48a4-8edb-f1ffcefb1bf3/department?offset=0&limit=10
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

レスポンス例

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2020 01:18:11 GMT
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 68d1o68pm4cr63gc3169gm4p34

~~~ text
{
    "elements": [
        {
            "tenantId": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "companyId": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "externalKey": null,
            "name": "開発チーム",
            "i18nNames": {},
            "parentDeptExternalKey": null,
            "deptLeaderExternalKey": "",
            "deptEmailAddress": "",
            "externalEmailReceiveYn": false,
            "dispOrd": "1.0",
            "deptNo": "partner-test202202000001",
            "parentDeptNo": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "deptLeaderEmpId": null
        },
        {
            "tenantId": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "companyId": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "externalKey": null,
            "name": "企画チーム",
            "i18nNames": {},
            "parentDeptExternalKey": null,
            "deptLeaderExternalKey": "",
            "deptEmailAddress": "",
            "externalEmailReceiveYn": false,
            "dispOrd": "2.0",
            "deptNo": "partner-test202202000002",
            "parentDeptNo": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "deptLeaderEmpId": null
        },
        {
            "tenantId": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "companyId": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "externalKey": null,
            "name": "NAVERクラウド株式会社",
            "i18nNames": {
                "ko_KR": "workplace02"
            },
            "parentDeptExternalKey": null,
            "deptLeaderExternalKey": "",
            "deptEmailAddress": "",
            "externalEmailReceiveYn": false,
            "dispOrd": "1.0",
            "deptNo": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "parentDeptNo": "#",
            "deptLeaderEmpId": null
        }
    ],
    "totalCount": 3
}

レスポンス

HTTPステータスコードで返され、ボディ情報として伝達する。

HTTPステータスコード	レスポンスメッセージ	説明
200	OK	一般的なリクエスト成功
201	Created	リソース作成成功に対するレスポンスコード
400	Bad Request	一般的なリクエスト失敗に使用
500	Internal Server Error	- 一般的なサーバエラーに対するレスポンスコード 4XX番台のエラーコードがクライアント側のエラーを表示するために使用されるのに対し、 5XX番台のエラーコードはサーバ側のエラーを表示するために使用される

レスポンス例

{
    "status": 400,
    "code": -4020,
    "errors": [],
    "message": "parentDeptExternalKey is null"
}

この記事は役に立ちましたか?

What's Next

社員

説明
リクエストヘッダ共通
組織リスト照会API
レスポンス

タグ

WORKPLACE