직책
- 인쇄
- PDF
직책
- 인쇄
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
설명
파트너사에 연결된 고객사의 직책 목록을 조회한다.
직책 목록 조회 API
직책 목록을 조회한다.
요청 URL
GET https://workplace.apigw.ntruss.com/partner/apigw/v2/partner/{partnerId}/company/{companyId}/job
요청 헤더
Header | Description |
---|---|
x-ncp-apigw-timestamp | |
x-ncp-iam-access-key | 네이버 클라우드 플랫폼 포털 또는 Sub Account에서 발급받은 Access Key ID |
x-ncp-apigw-signature-v2 |
요청 Path 파라미터
파라미터 | 타입 | 크기 | 필수 여부 | 설명 |
---|---|---|---|---|
partnerId | String | 15 | Y | WORKPLACE에서 제공한 파트너 ID |
companyId | String | 36 | Y | 조회할 고객사의 연동키(CompanyId) Developers > 기본 설정 > 연동키 |
요청 파라미터
파라미터 | 타입 | 크기 | 필수 여부 | 설명 |
---|---|---|---|---|
offset | long | N | offset row부터 출력 | |
limit | long | N | limit 갯수만큼 출력 |
요청 예시
GET https://workplace.apigw.ntruss.com/partner/apigw/v2/partner/partnertestid/company/c1798784-9a47-4751-ab9f-b9629825ab93/job?offset=0&limit=10
GET /partner/apigw/v2/partner/partnertestid/company/c1798784-9a47-4751-ab9f-b9629825ab93/job?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
{
"elements": [
{
"tenantId": "c1798784-9a47-4751-ab9f-b9629825ab93",
"companyId": "c1798784-9a47-4751-ab9f-b9629825ab93",
"externalKey": "apitestjob1",
"name": "개발",
"i18nNames": {
"zh_CN": "",
"ja_JP": "",
"ko_KR": "",
"zh_TW": "",
"en_US": ""
},
"sortOrder": 0,
"itemUsed": true
},
{
"tenantId": "c1798784-9a47-4751-ab9f-b9629825ab93",
"companyId": "c1798784-9a47-4751-ab9f-b9629825ab93",
"externalKey": "apitestjob2",
"name": "기획",
"i18nNames": {
"zh_CN": "",
"ja_JP": "",
"ko_KR": "",
"zh_TW": "",
"en_US": ""
},
"sortOrder": 1,
"itemUsed": true
},
{
"tenantId": "c1798784-9a47-4751-ab9f-b9629825ab93",
"companyId": "c1798784-9a47-4751-ab9f-b9629825ab93",
"externalKey": "jobTest1",
"name" : "팀원",
"i18nNames": {
"ko_KR" : "팀원",
"zh_CN": "",
"ja_JP": "",
"ko_KR": "",
"zh_TW": "",
"en_US": "Team member"
},
"sortOrder": 9,
"itemUsed": false
}
],
"totalCount": 3
}
응답
HTTP 상태 코드로 리턴되고, Body 정보로 전달한다.
HTTP 상태 코드 | 응답 메시지 | 설명 |
---|---|---|
200 | OK | 일반적인 요청 성공 |
201 | Created | 리소스 생성 성공에 대한 응답 코드 |
400 | Bad Request | 일반적인 요청 실패에 사용 |
500 | Internal Server Error | - 일반적인 서버 오류에 대한 응답 코드 XX대의 오류 코드가 클라이언트 측 오류를 나타내기 위해 사용된다면 5XX대의 오류 코드는 서버 측 오류를 나타내기 위해 사용 |
응답 예시
{
"status": 400,
"code": -4013,
"errors": [],
"message": "job not found"
}
이 문서가 도움이 되었습니까?