조직

인쇄
공유
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

설명

파트너사에 연결된 고객사의 부서목록을 조회한다.

요청 헤더 공통

Header	Description
x-ncp-apigw-timestamp	- 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것 - API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
x-ncp-iam-access-key	- 네이버 클라우드 플랫폼 포털 또는 Sub Account에서 발급받은 Access Key ID
x-ncp-apigw-signature-v2	- 위 예제의 Body를 Access Key ID와 맵핑되는 Secret Key로 암호화한 서명 - HMAC 암호화 알고리즘은 HmacSHA256 사용

조직목록 조회 API

조직목록을 조회한다.

요청 URL

GET https://workplace.apigw.ntruss.com/partner/apigw/v2/partner/{partnerId}/company/{companyId}/department

요청 Path 파라미터

파라미터	타입	크기	필수 여부	설명
partnerId	String	15	Y	WORKPLACE에서 제공한 파트너 ID
companyId	String	36	Y	조회할 고객사의 연동키(CompanyId) Developers > 기본 설정 > 연동키

요청 파라미터

파라미터	타입	크기	필수 여부	설명
offset	long		N	offset row부터 출력
limit	long		N	limit 갯수만큼 출력

요청 Body 파라미터

파라미터	타입	크기	필수 여부	설명
tenantId	String	100	Y	고객사 tenant ID
companyId	String	100	Y	고객사 company ID
name	String	100	Y	부서명
i18nNames	Map		N	부서 다국어명`Map<Locale, String> i18nNames`
deptExternalKey	String	100	Y	부서 외부키
parentDeptExternalKey	String	100	Y	상위부서 외부키(최상위 조직일 경우만 #)
deptEmailAddress	String	100	N	부서 이메일 주소
externalEmailReceiveYn	boolean		N	외부이메일 수신여부
dispOrd	String	10	Y	조직도 부서 노출 순서
deptNo	String	36	Y	부서 key
parentDeptNo	String	36	Y	상위부서 key(최상위 조직일 경우만 #)
deptLeaderEmpId	String	36	Y	부서장의 empId

요청 예시

GET https://workplace.apigw.ntruss.com/partner/apigw/v2/partner/partnertestid/company/1663a976-32c9-48a4-8edb-f1ffcefb1bf3/department?offset=0&limit=10

GET /partner/apigw/v2/partner/partnertestid/company/1663a976-32c9-48a4-8edb-f1ffcefb1bf3/department?offset=0&limit=10
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

응답 예시

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2020 01:18:11 GMT
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 68d1o68pm4cr63gc3169gm4p34

~~~ text
{
    "elements": [
        {
            "tenantId": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "companyId": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "externalKey": null,
            "name": "개발팀",
            "i18nNames": {},
            "parentDeptExternalKey": null,
            "deptLeaderExternalKey": "",
            "deptEmailAddress": "",
            "externalEmailReceiveYn": false,
            "dispOrd": "1.0",
            "deptNo": "partner-test202202000001",
            "parentDeptNo": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "deptLeaderEmpId": null
        },
        {
            "tenantId": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "companyId": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "externalKey": null,
            "name": "기획팀",
            "i18nNames": {},
            "parentDeptExternalKey": null,
            "deptLeaderExternalKey": "",
            "deptEmailAddress": "",
            "externalEmailReceiveYn": false,
            "dispOrd": "2.0",
            "deptNo": "partner-test202202000002",
            "parentDeptNo": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "deptLeaderEmpId": null
        },
        {
            "tenantId": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "companyId": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "externalKey": null,
            "name": "클라우드주식회사",
            "i18nNames": {
                "ko_KR": "workplace02"
            },
            "parentDeptExternalKey": null,
            "deptLeaderExternalKey": "",
            "deptEmailAddress": "",
            "externalEmailReceiveYn": false,
            "dispOrd": "1.0",
            "deptNo": "1663a976-32c9-48a4-8edb-f1ffcefb1bf3",
            "parentDeptNo": "#",
            "deptLeaderEmpId": null
        }
    ],
    "totalCount": 3
}

응답

HTTP 상태 코드로 리턴되고, Body 정보로 전달한다.

HTTP 상태 코드	응답 메시지	설명
200	OK	일반적인 요청 성공
201	Created	리소스 생성 성공에 대한 응답 코드
400	Bad Request	일반적인 요청 실패에 사용
500	Internal Server Error	- 일반적인 서버 오류에 대한 응답 코드 4XX대의 오류 코드가 클라이언트 측 오류를 나타내기 위해 사용 - 5XX대의 오류 코드는 서버 측 오류를 나타내기 위해 사용

응답 예시

{
    "status": 400,
    "code": -4020,
    "errors": [],
    "message": "parentDeptExternalKey is null"
}

이 문서가 도움이 되었습니까?

What's Next

사원

설명
요청 헤더 공통
조직목록 조회 API
응답

태그

WORKPLACE