GET/directory/positions

직책 목록을 조회한다.

참고

  • 도메인의 직책 사용 여부가 'true'로 설정되어 있어야 한다.

Authorization

oauth2

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

Scope

directory
directory.read

HTTP Request

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

Query Parameters

ParameterTypeDescription
domainId integer 

도메인 ID


example : 10000001
format : int32 
count integer 

조회 개수


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

커서값


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
positions array (Position) 

직책 정보

 
responseMetaData object (responseMetaData) 

응답 메타데이터

 

Position

PropertyTypeDescription
domainId integer 

직책의 도메인 ID


required
format : int32 
positionId string 

자동으로 부여되는 ID


readOnly : true 
displayOrder integer 

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


required
format : int32 
positionName string 

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


required
maxLength : 100 
positionExternalKey string 

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


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

responseMetaData

PropertyTypeDescription
nextCursor string 

다음 목록 조회 시 사용하는 커서값

 

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": "사원",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