Classic/VPC環境で利用できます。
Media Connect Centerの部署を照会する APIです。
リクエスト
GET https://ncloudmcc.apigw.ntruss.co/ncloudmcc/v1/companies/{companyId}/depts/{externalKey}
リクエストヘッダ
| 項目 | 必須有無 | 説明 |
|---|---|---|
| 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 > 基本設定 > 連携キー |
| externalKey | String | 36 | Y | 部署の外部キー |
リクエスト例
GET /ncloudmcc/v1/companies/48128f23-e29b-496e-aa04-1f741fed86bc/depts/dept01
Host: ncloudmcc.apigw.ntruss.com
x-ncp-apigw-signature-v2: yyoug5garNKcbEjaNkt+P9tfAVgwhYgOM3I/EO2lutU=
x-ncp-apigw-timestamp: 1700459601582
x-ncp-iam-access-key: HrR0s91elfiXEeTSZcwj
x-ncp-region_code: KR
レスポンス
レスポンス Bodyパラメータ
| パラメータ | タイプ | 容量 | 必須有無 | 説明 |
|---|---|---|---|---|
| dept.name | String | 100 | 部署名 | |
| dept.i18nNames | Map | 部署の多言語名Map<Locale, String> i18nNames |
||
| dept.sortOrd | Number | 1 | 部署の表示順序 | |
| dept.uprDeptExternalKey | String | 50 | 上位部署の外部キー、指定しない場合はデフォルトの最上位部署 | |
| dept.externalKey | String | 36 | 部署の外部キー |
レスポンス例
HTTP/1.1 200 OK
Connection: keep-alive
Content-Type: application/json;charset=UTF-8
Date: Mon, 20 Nov 2023 05:53:21 GMT
Server: nginx
x-ncp-apigw-response-origin: ENDPOINT
x-ncp-trace-id: 32p9oc8rj8db63cp9oc5imacb4
{
"dept":
{
"name":"営業",
"i18nNames":
{
"ko_KR": "영업",
"en_US": "Sales"
},
"uprDeptExternalKey":"dept00",
"sortOrd":0,
"externalKey":"dept01"
}
}