GET/directory/positions

Gets a list of positions.

Note

  • The usePosition parameter for the domain must be set to "true" to use this API operation.

Authorization

oauth2

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

Scope

directory
directory.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/directory/positions

Query Parameters

ParameterTypeDescription
domainId integer 

Domain ID


example : 10000001
format : int32 
count integer 

Number of items to get


default : 100
minimum : 1
maximum : 100
example : 100
format : int32 
cursor string 

Cursor


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
positions array (Position) 

Position information

 
responseMetaData object (responseMetaData) 

Response metadata

 

Position

PropertyTypeDescription
domainId integer 

Position's domain ID


required
format : int32 
positionId 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 
positionName string 

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


required
maxLength : 100 
positionExternalKey string 

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


maxLength : 100
nullable : true 
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 

responseMetaData

PropertyTypeDescription
nextCursor string 

Cursor value for pagination

 

Response Example

example

1{2  "positions": [3    {4      "domainId": 10000001,5      "positionId": "position-bba1-4d6f-8397-511f673467ec",6      "displayOrder": 1,7      "positionName": "Position Name1",8      "positionExternalKey": "POSITION_EXT_01",9      "i18nNames": []10    },11    {12      "domainId": 10000001,13      "positionId": "position-7027-4a02-b838-6f52b5e38db7",14      "displayOrder": 2,15      "positionName": "Employee",16      "positionExternalKey": "POSITION_EXT_02",17      "i18nNames": [18        {19          "name": "Staff",20          "language": "en_US"21        }22      ]23    }24  ],25  "responseMetaData": {26    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="27  }28}

HTTP 403

Forbidden