PUT/directory/employment-types/{employmentTypeId}

利用権限タイプを更新する。

  • ドメインの利用権限タイプ設定が有効である必要がある。

注意
本 API は提供終了予定です。今後は こちら を使用してください。

Authorization

oauth2

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

Scope

directory

HTTP Request

PUThttps://www.worksapis.com/v1.0/directory/employment-types/{employmentTypeId}

Path Parameters

ParameterTypeDescription
employmentTypeId string 

利用権限タイプを特定する ID (URL エンコードする)

  • 利用権限タイプ ID (employmentTypeId)
  • 利用権限タイプの ExternalKey (externalKey:{employmentTypeExternalKey})

required
example : employ2c-f321-47a6-ac11-e81fcc23a8c3 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
displayOrder integer 

表示順位 (重複許可)


required
format : int32 
employmentTypeName string 

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


required
maxLength : 100 
employmentTypeExternalKey string 

利用権限タイプの ExternalKey
テナント内で一意になること
利用できない特殊文字: %#/?


maxLength : 100
nullable : true 
i18nNames array (I18nName) 

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

 
userTypeCode string 

利用権限タイプコード
英字 (A ~ Z、a ~ z)、数字 (0 ~ 9)、underscore (_) が利用でき、最大 50 文字まで指定できる。
英字で始めなければならない。


maxLength : 50
nullable : true 

I18nName

PropertyTypeDescription
name string 

多国語表示名


required
minLength : 1
maxLength : 100 
language string 

多国語言語コード


required
Allowed values : ja_JP, ko_KR, en_US, zh_CN, zh_TW 

Request Example

example

1{2  "displayOrder": 1,3  "employmentTypeName": "利用権限タイプ01",4  "employmentTypeExternalKey": "EMPLOYMENTTYPE_EXT_01",5  "i18nNames": [6    {7      "name": "English Name",8      "language": "en_US"9    }10  ],11  "userTypeCode": "code"12}

Response

HTTP 200

OK

PropertyTypeDescription
domainId integer 

ドメイン ID


required
format : int32 
employmentTypeId string 

利用権限タイプ ID

  • 利用権限タイプのリソース ID
  • 登録時に自動発行されるユニーク ID

readOnly : true 
displayOrder integer 

表示順位 (重複許可)


required
format : int32 
employmentTypeName string 

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


required
maxLength : 100 
employmentTypeExternalKey string 

利用権限タイプの ExternalKey
テナント内で一意になること
利用できない特殊文字: %#/?


maxLength : 100
nullable : true 
i18nNames array (I18nName) 

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

 
userTypeCode string 

利用権限タイプコード
英字 (A ~ Z、a ~ z)、数字 (0 ~ 9)、underscore (_) が利用でき、最大 50 文字まで指定できる。
英字で始めなければならない。


maxLength : 50
nullable : true 

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  "employmentTypeId": "employ2c-f321-47a6-ac11-e81fcc23a8c3",4  "displayOrder": 1,5  "employmentTypeName": "利用権限タイプ01",6  "employmentTypeExternalKey": "EMPLOYMENTTYPE_EXT_01",7  "i18nNames": [8    {9      "name": "English Name",10      "language": "en_US"11    }12  ],13  "userTypeCode": "code"14}

HTTP 403

Forbidden