GET/directory/levels/{levelId}

職級を取得する。

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

Authorization

oauth2

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

Scope

directory
directory.read

HTTP Request

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

Path Parameters

ParameterTypeDescription
levelId string 

職級を特定する ID (URLエンコードする)

  • 職級 ID (levelId)
  • 職級の ExternalKey (externalKey:{levelExternalKey})

required
example : levelaa7-b824-4937-66af-042f1f43cefa 

Query Parameters

ParameterTypeDescription
domainId integer 

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


example : 10000001
format : int32 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

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 

Response Example

example

1{2  "domainId": 10000001,3  "levelId": "levelaa7-b824-4937-66af-042f1f43cefa",4  "displayOrder": 1,5  "levelName": "一般社員",6  "levelExternalKey": "LEVEL_EXT_01",7  "executive": true,8  "i18nNames": [9    {10      "name": "Staff",11      "language": "en_US"12    }13  ]14}

HTTP 403

Forbidden

HTTP 404

Not Found