부서 목록 조회
- 인쇄
- PDF
부서 목록 조회
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Media Connect Center의 부서 목록을 조회하는 API입니다.
요청
GET https://ncloudmcc.apigw.fin-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 | 네이버 클라우드 플랫폼 포털에서 발급받은 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.fin-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"
}
]
}
이 문서가 도움이 되었습니까?