部署リストの照会

Prev Next

Classic/VPC環境で利用できます。

Media Connect Centerの部署リストを照会する APIです。

リクエスト

GET https://ncloudmcc.apigw.ntruss.co/ncloudmcc/v1/companies/{companyId}/depts

リクエストヘッダ

項目 必須有無 説明
x-ncp-apigw-timestamp Y 1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表し、API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
x-ncp-apigw-timestamp:{Timestamp}
x-ncp-iam-access-key Y NAVERクラウドプラットフォームポータルで発行された Access Key ID値
x-ncp-iam-access-key:{Sub Account Access Key}
x-ncp-apigw-signature-v2 Y Access Key ID値と Secret Keyで暗号化した署名
x-ncp-apigw-signature-v2:{API Gateway Signature}
x-ncp-region_code N リージョンコード(KR)
x-ncp-region_code:KR
Content-Type Y リクエスト Body Content Typeを application/jsonに指定
Content-Type: application/json

リクエスト Pathパラメータ

パラメータ タイプ 容量 必須有無 説明
companyId String 36 Y 連携キー(CompanyId)
Developers > 基本設定 > 連携キー

リクエスト Queryパラメータ

パラメータ タイプ 容量 必須有無 説明
limit Number N 返される最大項目数、デフォルト10
offset Number N コレクションから返される最初の項目のオフセット、デフォルト0

リクエスト Bodyパラメータ

パラメータ タイプ 容量 必須有無 説明

リクエスト例

GET /ncloudmcc/v1/companies/48128f23-e29b-496e-aa04-1f741fed86bc/depts?limit=2&offset=1
Host: ncloudmcc.apigw.ntruss.com
x-ncp-apigw-signature-v2: +4kkeJ+hRUcWH4xsXDQvuDEzfpqDRPr4D+Gc+GnFPHo=
x-ncp-apigw-timestamp: 1700470912198
x-ncp-iam-access-key: HrR0s91elfiXEeTSZcwj
x-ncp-region_code: KR

レスポンス

レスポンス Bodyパラメータ

パラメータ タイプ 容量 必須有無 説明
page.count Number 返された項目数
page.offset Number 返された最初の項目のオフセット
page.limit Number 返された最大項目数
page.total Number コレクション内の全項目数
depts[].name String 100 部署名
depts[].i18nNames Map 部署の多言語名
Map<Locale, String> i18nNames
depts[].sortOrd Number 1 部署の表示順序
depts[].externalKey String 36 部署の外部キー
depts[].uprDeptExternalKey String 50 Y 上位部署の外部キー、指定しない場合はデフォルトの最上位部署

レスポンス例

HTTP/1.1 200 OK
Connection: keep-alive
Content-Type: application/json;charset=UTF-8
Date: Mon, 20 Nov 2023 09:01:52 GMT
Server: nginx
x-ncp-apigw-response-origin: ENDPOINT
x-ncp-trace-id: 68e9pckqm4c356coj1ckpjicpo

{
    "page":
    {
        "count":2,
        "offset":1,
        "limit":2,
        "total":3
    },
   "depts":
   [
        {
            "name":"営業",
            "i18nNames":
            {
                "ko_KR": "영업",
                "en_US": "Sales"
            },
            "uprDeptExternalKey": "dept00",
            "sortOrd":0,
            "externalKey":"dept01"
        },
        {
            "name":"マーケティング",
            "i18nNames":
            {
                "ko_KR": "마케팅",
                "en_US": "Marketing"
            },
            "uprDeptExternalKey":"dept00",
            "sortOrd":0,
            "externalKey":"dept02"
        }
    ]
}