직책

인쇄
공유
PDF

직책

인쇄
공유
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

설명

고객사의 직책 정보를 WORKBOX로 설정하기 위한 API입니다.

추가 API

직책 정보를 추가한다.

요청 URL

POST https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/{companyId}/job-position/{externalKey}

요청 헤더

헤더명	설명
x-ncp-apigw-timestamp	1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타내며 API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주 `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-apigw-api-key	APIGW에서 발급받은 키 값 `x-ncp-apigw-api-key:{API Gateway API Key}`
x-ncp-iam-access-key	네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값 `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v1	Access Key ID 값과 Secret Key로 암호화한 서명 `x-ncp-apigw-signature-v1:{API Gateway Signature}`
Content-Type	Request body content type을 application/json으로 지정 `Content-Type: application/json`

요청 Path 파라미터

Parameter	Type	Length	Mandatory	Description
companyId	String	36	Y	연동키(CompanyId) Developers > 기본 설정 > 연동키
externalKey	String	36	Y	직책 외부키

요청 Body 파라미터

Parameter	Type	Length	Mandatory	Description
name	String	100	Y	직책명
i18nNames	Map		N	직책 다국어명 `Map<Locale, String> i18nNames`
sortOrd	int		Y	직책 노출 순서

요청 예시

POST https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/578c7009-bdad-4493-9835-72302cf988c6/job-position/job-position0001

POST /openapi/v1/organization/company/578c7009-bdad-4493-9835-72302cf988c6/job-position/job-position0001
HOST: workbox.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-v1: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
{
	"sortOrd": 99,
    "name": "팀원",
	"i18nNames": {
		"ko_KR": "팀원",
		"en_US": "Team member"
	}
}

응답 예시

HTTP/1.1 201 OK
Server: nginx
Date: Wed, 12 Sep 2018 10: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

{
	"sortOrd": 99,
    "name": "팀원",
	"i18nNames": {
		"ko_KR": "팀원",
		"en_US": "Team member"
	}
}

수정 API

직책 정보를 수정한다.

요청 URL

PUT https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/{companyId}/job-position/{externalKey}

요청 헤더

헤더명	설명
x-ncp-apigw-timestamp	1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타내며 API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주 `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-apigw-api-key	APIGW에서 발급받은 키 값 `x-ncp-apigw-api-key:{API Gateway API Key}`
x-ncp-iam-access-key	네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값 `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v1	Access Key ID 값과 Secret Key로 암호화한 서명 `x-ncp-apigw-signature-v1:{API Gateway Signature}`
Content-Type	Request body content type을 application/json으로 지정 `Content-Type: application/json`

요청 Path 파라미터

파라미터	타입	크기	필수 여부	설명
companyId	String	36	Y	연동키(CompanyId) Developers > 기본 설정 > 연동키
externalKey	String	36	Y	직책 외부키

요청 Body 파라미터

파라미터	타입	크기	필수 여부	설명
name	String	100	Y	직책명
i18nNames	Map		N	직책 다국어명 `Map<Locale, String> i18nNames`
sortOrd	int		Y	직책 노출 순서

요청 예시

POST https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/578c7009-bdad-4493-9835-72302cf988c6/job-position/job-position0001

POST /openapi/v1/organization/company/578c7009-bdad-4493-9835-72302cf988c6/job-position/job-position0001
HOST: workbox.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-v1: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
{
	"sortOrd": 99,
    "name": "팀원",
	"i18nNames": {
		"ko_KR": "팀원",
		"en_US": "Team member"
	}
}

응답 예시

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2018 10: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

{
	"sortOrd": 99,
    "name": "팀원",
	"i18nNames": {
		"ko_KR": "팀원",
		"en_US": "Team member"
	}
}

삭제 API

직책 정보를 삭제한다.

요청 URL

DELETE  https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/{companyId}/job-position/{externalKey}

요청 헤더

헤더명	설명
x-ncp-apigw-timestamp	1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타내며 API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주 `x-ncp-apigw-timestamp:{Timestamp}`
x-ncp-apigw-api-key	APIGW에서 발급받은 키 값 `x-ncp-apigw-api-key:{API Gateway API Key}`
x-ncp-iam-access-key	네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값 `x-ncp-iam-access-key:{Account Access Key}`
x-ncp-apigw-signature-v1	Access Key ID 값과 Secret Key로 암호화한 서명 `x-ncp-apigw-signature-v1:{API Gateway Signature}`
Content-Type	Request body content type을 application/json으로 지정 `Content-Type: application/json`

요청 Path 파라미터

파라미터	타입	크기	필수 여부	설명
companyId	String	36	Y	연동키(CompanyId) Developers > 기본 설정 > 연동키
externalKey	String	36	Y	직책 외부키

응답

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

HTTP 상태 코드	응답 메시지	설명
200	OK	일반적인 요청 성공
201	Created	리소스 생성 성공에 대한 응답 코드
400	Bad Request	일반적인 요청 실패에 사용(대체로 서버가 이해할 수 없는 형식의 요청이 왔을 때 응답하기 위해 사용)
500	Internal Server Error	- 일반적인 서버 오류에 대한 응답 코드 4XX대의 오류 코드가 클라이언트 측 오류를 나타내기 위해 사용된다면, 5XX대의 오류 코드는 서버 측 오류를 나타내기 위해 사용됨

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

What's Next

구성원

설명
추가 API
수정 API
삭제 API
응답

태그

WORKBOX