PATCH/directory/levels/{levelId}

직급 정보를 수정한다.

참고

  • 필드값이 null이면 저장된 데이터를 지운다.

Authorization

oauth2

OAuth 2.0 인증.
자세한 인증 방식은 인가·인증를 참고한다.

Scope

directory

HTTP Request

PATCHhttps://www.worksapis.com/v1.0/directory/levels/{levelId}

Path Parameters

ParameterTypeDescription
levelId string 

직급 리소스 ID 또는 외부 키.
외부 키는 "externalKey:{externalKey}" 형태


required
example : levelaa7-b824-4937-66af-042f1f43cefa 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
domainId integer 

직급의 도메인 ID


format : int32 
displayOrder integer 

정렬 순서. 음수와 중복이 허용되며 상대 비교를 통해 오름차순으로 정렬된다.


format : int32 
levelName string 

직급명. 도메인 내에서 유일해야 한다. 특수 문자는 !@&()-_+[]{},./만 허용된다.


maxLength : 100 
levelExternalKey string 

직급 외부 키
%#/? 입력 불가


maxLength : 100
nullable : true 
executive boolean 

임원 여부

 
i18nNames array (i18nName) 

다국어 목록 정보.
Admin > 기본환경 > 회사 정보 > 다국어 설정에서 지정된 항목의 다국어만 표시된다.

 

i18nName

PropertyTypeDescription
name string 

다국어 이름


required
minLength : 1
maxLength : 100 
language string 

다국어 언어 코드


required
Allowed values : ko_KR, en_US, ja_JP, zh_CN, zh_TW 

Request Example

example

1{2  "domainId": 10000001,3  "displayOrder": 1,4  "levelName": "사원",5  "levelExternalKey": "LEVEL_EXT_01",6  "executive": true,7  "i18nNames": [8    {9      "name": "Staff",10      "language": "en_US"11    }12  ]13}

Response

HTTP 200

OK

PropertyTypeDescription
domainId integer 

직급의 도메인 ID


required
format : int32 
levelId string 

자동으로 부여되는 ID


readOnly : true 
displayOrder integer 

정렬 순서. 음수와 중복이 허용되며 상대 비교를 통해 오름차순으로 정렬된다.


required
format : int32 
levelName string 

직급명. 도메인 내에서 유일해야 한다. 특수 문자는 !@&()-_+[]{},./만 허용된다.


required
maxLength : 100 
levelExternalKey string 

직급 외부 키
%#/? 입력 불가


maxLength : 100
nullable : true 
executive boolean 

임원 여부


required 
i18nNames array (i18nName) 

다국어 목록 정보.
Admin > 기본환경 > 회사 정보 > 다국어 설정에서 지정된 항목의 다국어만 표시된다.

 

i18nName

PropertyTypeDescription
name string 

다국어 이름


required
minLength : 1
maxLength : 100 
language string 

다국어 언어 코드


required
Allowed values : ko_KR, en_US, ja_JP, zh_CN, zh_TW 

Response Example

example

1{2  "domainId": 10000001,3  "levelId": "levelaa7-b824-4937-66af-042f1f43cefa",4  "displayOrder": 1,5  "levelName": "사원",6  "levelExternalKey": "LEVEL_EXT_01",7  "executive": true,8  "i18nNames": [9    {10      "name": "Staff",11      "language": "en_US"12    }13  ]14}

HTTP 403

Forbidden