Viewing departments
- Print
- PDF
Viewing departments
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
It is an API to view departments of the Media Connect Center.
Requests
GET https://ncloudmcc.apigw.ntruss.co/ncloudmcc/v1/companies/{companyId}/depts/{externalKey}
Request headers
| Item | Required | Description |
|---|---|---|
| x-ncp-apigw-timestamp | Y | Time elapsed since January 1, 1970, 00:00:00 UTC in milliseconds. The request is considered invalid if the time difference from the API Gateway server is 5 minutes or longerx-ncp-apigw-timestamp:{Timestamp} |
| x-ncp-iam-access-key | Y | Value of access key ID issued from NAVER Cloud Platform portalx-ncp-iam-access-key:{Sub Account Access Key} |
| x-ncp-apigw-signature-v2 | Y | Signature encrypted with the access key ID value and secret keyx-ncp-apigw-signature-v2:{API Gateway Signature} |
| x-ncp-region_code | N | Region code (KR)x-ncp-region_code:KR |
| Content-Type | Y | Specifies the request body content type as application/jsonContent-Type: application/json |
Request path parameters
| Parameters | Type | Size | Required | Description |
|---|---|---|---|---|
| companyId | String | 36 | Y | Integration key (CompanyId) Developers > Basic settings > Integration key |
| externalKey | String | 36 | Y | External key of department |
Request examples
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
Responses
Response body parameters
| Parameters | Type | Size | Required | Description |
|---|---|---|---|---|
| dept.name | String | 100 | Department name | |
| dept.i18nNames | Map | Multilingual department nameMap<Locale, String> i18nNames | ||
| dept.sortOrd | Number | 1 | Order of department to be exposed | |
| dept.uprDeptExternalKey | String | 50 | External key of the upper department; the highest default department if not specified | |
| dept.externalKey | String | 36 | External key of department |
Response examples
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":"Sales",
"i18nNames":
{
"ko_KR": "영업",
"en_US": "Sales"
},
"uprDeptExternalKey":"dept00",
"sortOrd":0,
"externalKey":"dept01"
}
}
Was this article helpful?