PATCH/directory/positions/{positionId}

役職を部分更新する。

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

Authorization

oauth2

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

Scope

directory

HTTP Request

PATCHhttps://www.worksapis.com/v1.0/directory/positions/{positionId}

Path Parameters

ParameterTypeDescription
positionId string 

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

  • 役職 ID (positionId)
  • 役職の ExternalKey (externalKey:{positionExternalKey})

required
example : position-7027-4a02-b838-6f52b5e38db7 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

Patch user properties to update.

PropertyTypeDescription
domainId integer 

ドメイン ID


format : int32 
displayOrder integer 

表示順位 (重複許可)


format : int32 
positionName string 

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


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 

Request Example

example

1{2  "domainId": 10000001,3  "displayOrder": 2,4  "positionName": "社員",5  "i18nNames": [6    {7      "name": "Staff",8      "language": "en_US"9    }10  ]11}

Response

HTTP 200

OK

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 

Response Example

example

1{2  "domainId": 10000001,3  "positionId": "position-7027-4a02-b838-6f52b5e38db7",4  "displayOrder": 2,5  "positionName": "社員",6  "positionExternalKey": "POSITION_EXT_02",7  "i18nNames": [8    {9      "name": "Staff",10      "language": "en_US"11    }12  ]13}

HTTP 403

Forbidden