추가정보설정

인쇄
공유
PDF

추가정보설정

인쇄
공유
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

설명

회사의 인사 정책에 따른 사원의 속성 중 기본 정보에 포함되지 않은 항목은 추가정보에서 직접 입력하여 관리할 수 있는 API입니다.
Y/N형, 선택형, 날짜형, 서술형 등 다양한 방식으로 필요한 항목을 추가할 수 있고 필요에 따라 사원정보검색에 노출할 수 있습니다.

추가 API

추가정보설정을 추가합니다.

요청 URL

POST https://workplace.apigw.ntruss.com/organization/apigw/v1/company/{companyId}/addattr/{externalKey}

요청 헤더

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 사용

요청 Path 파라미터

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

요청 Body 파라미터

파라미터	타입		크기	필수 여부	설명
fieldType	String		50	Y	필드타입
name	String		100	Y	속성명
i18nNames	Map			N	속성 다국어명 Map<Locale, String> i18nNames
fieldUsedType	String		100	N	추가정보 사용계정 유형(일반사원 : MEM)
searchDispYn	String		1	Y	사원검색 노출여부
userDispYn	String		1	Y	내정보 수정에 노출 여부
userMod	String		20	Y	사용자 수정 여부 (사용자 수정 가능 : CHANGE/사용자 수정 불가 : UNCHANGED/ 사용자 노출 안함 : INVISIBLE)
attrItemList	List			N	선택형 데이터 리스트
		externalKey		N	외부키
		itemName		N	선택형 속성 기본명
		i18nItemNames		N	선택형 속성 다국어명Map<Locale, String> i18nNames
		fieldTypeItemOrd	Int	N	순서

요청 예시

POST https://workplace.apigw.ntruss.com/organization/apigw/v1/company/adc835a8-244c-46b4-8410-7421816d4808/addattr/gw02attrext0002

POST /organization/apigw/v1/company/adc835a8-244c-46b4-8410-7421816d4808/addattr/gw02attrext0002
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=
{
   "fieldUsedType" :"MEM",
    "searchDispYn": "Y",
    "userDispYn": "N",
    "fieldType": "INPUT",
     "name": "사원번호",
    "i18nNames": {
            "ko_KR": "사원번호",
            "en_US": "empno"
        },
    "userMod": "CHANGE"
 }

or

{
   "fieldUsedType" :"MEM",
    "searchDispYn": "Y",
    "userDispYn": "N",
    "fieldType": "SELECT",
    "attrItemList" : [
       {"itemName": "재직",
	     "i18nItemNames": {
            "ko_KR": "재직",
            "en_US": "status111"
        },
       "fieldTypeItemOrd":1  }
       ,
        {"itemName": "휴직",
		"i18nItemNames": {
            "ko_KR": "휴직",
            "en_US": "status222"
        },
        "fieldTypeItemOrd": 2  }
        ],
    "name": "재직여부",
    "i18nNames": {
            "ko_KR": "재직여부",
            "en_US": "status"
        },
    "userMod": "CHANGE"
}

응답 예시

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

{
    "searchDispYn": "Y",
    "userDispYn": "N",
    "fieldType": "SELECT",
    "attrItemList" : [
       {"itemName": "재직",
	     "i18nItemNames": {
            "ko_KR": "재직",
            "en_US": "status111"
        },
       "fieldTypeItemOrd":1  }
       ,
        {"itemName": "휴직",
		"i18nItemNames": {
            "ko_KR": "휴직",
            "en_US": "status222"
        },
        "fieldTypeItemOrd": 2  }
        ],
    "name": "재직여부",
    "i18nNames": {
            "ko_KR": "재직여부",
            "en_US": "status"
        },
    "userMod": "CHANGE"
}

수정 API

추가 정보 설정을 수정합니다.

요청 URL

PUT https://workplace.apigw.ntruss.com/organization/apigw/v1/company/{companyId}/addattr/{externalKey}

요청 헤더

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 사용

요청 Path 파라미터

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

요청 Body 파라미터

파라미터	타입		크기	필수 여부	설명
fieldType	String		50	Y	필드타입
name	String		100	Y	속성명
i18nNames	Map			N	속성 다국어명 Map<Locale, String> i18nNames
searchDispYn	String		1	Y	사원검색 노출여부
userDispYn	String		1	Y	내정보 수정에 노출 여부
userMod	String		20	Y	사용자 수정 여부 (사용자 수정 가능 : CHANGE/사용자 수정 불가 : UNCHANGED/ 사용자 노출 안함 : INVISIBLE)
attrItemList	List			N	선택형 데이터 리스트
		externalKey		N	외부키
		itemName		N	선택형 속성 기본명
		i18nItemNames		N	선택형 속성 다국어명Map<Locale, String> i18nNames
		fieldTypeItemOrd	Int	N	순서

요청 예시

POST https://workplace.apigw.ntruss.com/organization/apigw/v1/company/adc835a8-244c-46b4-8410-7421816d4808/addattr/gw02attrext0002

POST /organization/apigw/v1/company/adc835a8-244c-46b4-8410-7421816d4808/addattr/gw02attrext0002
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=
{
    "searchDispYn": "Y",
    "userDispYn": "N",
    "fieldType": "INPUT",
     "name": "사원번호",
    "i18nNames": {
            "ko_KR": "사원번호",
            "en_US": "empno"
        },
    "userMod": "UNCHANGED"
 }

or

{
    "searchDispYn": "Y",
    "userDispYn": "N",
    "fieldType": "SELECT",
    "attrItemList" : [
       {"itemName": "재직",
	     "i18nItemNames": {
            "ko_KR": "재직",
            "en_US": "status111"
        },
       "fieldTypeItemOrd":1  }
       ,
        {"itemName": "휴직",
		"i18nItemNames": {
            "ko_KR": "휴직",
            "en_US": "status222"
        },
        "fieldTypeItemOrd": 2  }
        ],
    "name": "재직여부",
    "i18nNames": {
            "ko_KR": "재직여부",
            "en_US": "status"
        },
    "userMod": "INVISIBLE"
}

응답 예시

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

{
    "searchDispYn": "Y",
    "userDispYn": "N",
    "fieldType": "SELECT",
    "attrItemList" : [
       {"itemName": "재직",
	     "i18nItemNames": {
            "ko_KR": "재직",
            "en_US": "In office"
        },
       "fieldTypeItemOrd":1  }
       ,
        {"itemName": "휴직",
		"i18nItemNames": {
            "ko_KR": "휴직",
            "en_US": "On leave of absence"
        },
        "fieldTypeItemOrd": 2  }
        ],
    "name": "재직여부",
    "i18nNames": {
            "ko_KR": "재직여부",
            "en_US": "status"
        },
    "userMod": "INVISIBLE"
}

삭제 API

추가정보설정을 삭제합니다.

요청 URL

DELETE https://workplace.apigw.ntruss.com/organization/apigw/v1/company/{companyId}/addattr/{externalKey}

요청 헤더

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 사용

요청 Path 파라미터

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

전체 리스트 API

설정한 추가정보 전체 리스트를 가져옵니다.

요청 URL

GET https://workplace.apigw.ntruss.com/organization/apigw/v1/company/{companyId}/addattrs

요청 헤더

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 사용

요청 Path 파라미터

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

응답 예시

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
[
    {
        "fieldType": "SELECT",
        "searchDispYn": "Y",
        "userModYn": "N",
        "dispOrd": 0,
        "name": "셔틀버스 탑승정보",
        "i18nNames": {
            "ko_KR": "셔틀",
            "en_US": "Shuttle"
        },
        "attrItemList": [
            {
                "fieldTypeItemOrd": 0,
                "itemName": "강남",
                "i18nItemNames": {
                    "ko_KR": "강남_ko",
                    "en_US": "강남_en"
                }
            },
            {
                "fieldTypeItemOrd": 1,
                "itemName": "잠실",
                "i18nItemNames": {
                    "ko_KR": "잠실_ko",
                    "en_US": "잠실_en"
                }
            },
            {
                "fieldTypeItemOrd": 2,
                "itemName": "서울역",
                "i18nItemNames": {
                    "ko_KR": "서울역_ko",
                    "en_US": "서울역_en"
                }
            },
            {
                "fieldTypeItemOrd": 3,
                "itemName": "신도림",
                "i18nItemNames": {
                    "ko_KR": "신도림_ko",
                    "en_US": "신도림_en"
                }
            },
            {
                "fieldTypeItemOrd": 4,
                "itemName": "인천",
                "i18nItemNames": {
                    "ko_KR": "인천_ko",
                    "en_US": "인천_en"
                }
            },
            {
                "fieldTypeItemOrd": 5,
                "itemName": "수원",
                "i18nItemNames": {
                    "ko_KR": "수원_ko",
                    "en_US": "수원_en"
                }
            },
            {
                "fieldTypeItemOrd": 6,
                "itemName": "안양",
                "i18nItemNames": {
                    "ko_KR": "안양_ko",
                    "en_US": "안양_en"
                }
            }
        ]
    }
]

응답

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

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

제공되는 필드타입 fieldType

fieldType	설명
INPUT	서술형
DATE	날짜형
YESNO	Y/N형
SELECT	선택형

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

What's Next

추가정보 사원별 설정

설명
추가 API
수정 API
삭제 API
전체 리스트 API
응답
제공되는 필드타입 fieldType

태그

WORKPLACE