부서 조회

Classic/VPC 환경에서 이용 가능합니다.

부서의 상세 정보를 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	/ncloudmcc/v1/companies/{companyId}/depts/{externalKey}

요청 헤더

Media Connect Center API에서 공통으로 사용하는 헤더에 대한 정보는 Media Connect Center 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`companyId`	String	Required	연동키 콘솔에서 확인: Media Connect Center > Developers > 기본 설정 > 연동키
`externalKey`	String	Required	부서 외부 키(External Key) 부서 목록 조회 참조

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://ncloudmcc.apigw.ntruss.com/ncloudmcc/v1/companies/2b64fc1e-6e9c-40dc-8b40-991bcaada5ef/depts/hg-tw-md' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'x-ncp-region_code: KR' \
--header 'Content-Type: application/json'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`dept`	Object	-	부서 정보
`dept.uprDeptExternalKey`	String	-	상위 부서 외부 키(External Key) 최상위 코드가 없는 경우 `null`로 표시
`dept.name`	String	-	부서 이름
`dept.i18nNames`	Object	-	부서 다국어 이름
`dept.i18nNames.{locale}`	String	-	언어별 부서 이름 `"언어 코드": "값"` 형태 한국어, 영어, 일본어 중 등록된 값 표시
`dept.sortOrd`	Number	-	조회 노출 순서
`dept.externalKey`	String	-	부서 외부 키(External Key)

응답 상태 코드

Media Connect Center API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Media Connect Center 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "dept": {
        "uprDeptExternalKey": "",
        "name": "매뉴얼개발팀",
        "i18nNames": {
            "ko_KR": "매뉴얼개발팀",
            "en_US": "Manual Development Team"
        },
        "sortOrd": 1,
        "externalKey": "hg-tw-md"
    }
}