PATCH/directory/levels/{levelId}

Updates part of job level information.

Note

  • The previous data is deleted if the parameter is null.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

directory

HTTP Request

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

Path Parameters

ParameterTypeDescription
levelId string 

Job level resource ID or external key.
An external key is in 'externalKey:{externalKey}' format.


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 

Job level's domain ID


format : int32 
displayOrder integer 

Sort order. A negative or duplicate number is allowed. Based on this value, items are sorted in ascending order.


format : int32 
levelName string 

Job level name. It must be unique within a domain. The allowed special characters are ! @ & ( ) - _ + [ ] { } , . /.


maxLength : 100 
levelExternalKey string 

Job level external key.
Some special characters, \ % # / ? are not allowed.


maxLength : 100
nullable : true 
executive boolean 

Indicates whether the member is an executive or not.

 
i18nNames array (i18nName) 

Multi-language information.
It shows only the languages specified under Settings > Company Information > Set Multi-language in the LINE WORKS Admin.

 

i18nName

PropertyTypeDescription
name string 

Multilingual name


required
minLength : 1
maxLength : 100 
language string 

Language code


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": "Employee",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 

Job level's domain ID


required
format : int32 
levelId string 

It is automatically assigned.


readOnly : true 
displayOrder integer 

Sort order. A negative or duplicate number is allowed. Based on this value, items are sorted in ascending order.


required
format : int32 
levelName string 

Job level name. It must be unique within a domain. The allowed special characters are ! @ & ( ) - _ + [ ] { } , . /.


required
maxLength : 100 
levelExternalKey string 

Job level external key.
Some special characters, \ % # / ? are not allowed.


maxLength : 100
nullable : true 
executive boolean 

Indicates whether the member is an executive or not.


required 
i18nNames array (i18nName) 

Multi-language information.
It shows only the languages specified under Settings > Company Information > Set Multi-language in the LINE WORKS Admin.

 

i18nName

PropertyTypeDescription
name string 

Multilingual name


required
minLength : 1
maxLength : 100 
language string 

Language code


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": "Employee",6  "levelExternalKey": "LEVEL_EXT_01",7  "executive": true,8  "i18nNames": [9    {10      "name": "Staff",11      "language": "en_US"12    }13  ]14}

HTTP 403

Forbidden