GET/directory/levels

職級リストを取得する。

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

Authorization

oauth2

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

Scope

directory
directory.read

HTTP Request

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

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
levels array (Level) 

職級情報

 
responseMetaData object (responseMetaData) 

レスポンスのメタデータ

 

Level

PropertyTypeDescription
domainId integer 

ドメイン ID


required
format : int32 
levelId string 

職級 ID

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

readOnly : true 
displayOrder integer 

表示順位 (重複許可)


required
format : int32 
levelName string 

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


required
maxLength : 100 
levelExternalKey string 

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


maxLength : 100
nullable : true 
executive boolean 

役員フラグ


required 
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  "levels": [3    {4      "domainId": 10000001,5      "levelId": "levelaa7-b824-4937-66af-042f1f43cefa",6      "displayOrder": 1,7      "levelName": "一般社員",8      "levelExternalKey": "LEVEL_EXT_01",9      "executive": true,10      "i18nNames": [11        {12          "name": "Staff",13          "language": "en_US"14        }15      ]16    },17    {18      "domainId": 10000001,19      "levelId": "leveld4d-1b15-450f-b674-e6a3338fe25b",20      "displayOrder": 2,21      "levelName": "代理",22      "levelExternalKey": "LEVEL_EXT_02",23      "executive": false,24      "i18nNames": []25    }26  ],27  "responseMetaData": {28    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="29  }30}

HTTP 403

Forbidden