GET/directory/positions

役職リストを取得する。

  • ドメインの役職設定が有効である必要がある。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

directory
directory.read

HTTP Request

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

Query Parameters

ParameterTypeDescription
domainId integer 

ドメイン ID (既定値: 認可ドメイン ID)


example : 10000001
format : int32 
count integer 

取得数


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

リストのカーソル値 (URL エンコードする)


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

  • 役職のリソース ID
  • 登録時に自動発行されるユニーク ID

readOnly : true 
displayOrder integer 

表示順位 (重複許可)


required
format : int32 
positionName string 

役職名
ドメイン内で一意
許容される特殊文字: !@&()-_+[]{},./


required
maxLength : 100 
positionExternalKey string 

役職の ExternalKey
利用できない特殊文字: %#/?


maxLength : 100
nullable : true 
i18nNames array (I18nName) 

多国語名リスト
[管理者画面 > 基本設定 > 会社情報 > 多国語設定] で指定された項目の多国語のみ表示される。

 

I18nName

PropertyTypeDescription
name string 

多国語表示名


required
minLength : 1
maxLength : 100 
language string 

多国語言語コード


required
Allowed values : ja_JP, ko_KR, en_US, 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": "社長",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