부서 조회

Media Connect Center의 부서를 조회하는 API입니다.

요청

GET https://ncloudmcc.apigw.fin-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	네이버 클라우드 플랫폼 포털에서 발급받은 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	부서 외부키

요청 Body 파라미터

파라미터	타입	크기	필수 여부	설명

요청 예시

GET /ncloudmcc/v1/companies/48128f23-e29b-496e-aa04-1f741fed86bc/depts/dept01
Host: ncloudmcc.apigw.fin-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"
    }
}