役職修正
役職情報を修正します。
注意
- ドメインの役職設定が有効に設定されている必要があります。
注意
フィールド値が null なら既存のデータを維持し、空の値 (Stringの""、またはListの[]など) であれば、保存されているデータを消去します。
例) 現在保存されているデータが i18nNames : [{"name": "aa", "language": "ko_KR"}, {"name": "bb", "language": "en_US"}]のとき
- i18nNames の値が null なら、保存されるデータは [{"name": "aa", "language": "ko_KR"}, {"name": "bb", "language": "en_US"}] を維持します。
- i18nNames 値が空の値なら保存されるデータは [] となり、削除されます。
- i18nNames 値が [{"name": "cc", "language": "ko_KR"}] なら、保存されるデータは [{"name": "cc", "language": "ko_KR"}] に変更されます。
API の種類
サーバー API
Request URL
https://apis.worksmobile.com/r/{API ID}/organization/v2/domains/{domainId}/positions/{externalKey}
HTTP Method
PATCH (Content-Type: application/json; charset=UTF-8)
Path Parameters
パラメーター | タイプ | 上限 | 必須 | 説明 |
---|---|---|---|---|
domainId | Integer | Y | ドメイン ID | |
externalKey | String | 100字 | Y | 修正する役職のExternal Key |
Request
パラメーター | タイプ | 上限 | 必須 | 説明 |
---|---|---|---|---|
sortLevel | Integer | Y | 整列順。重複を許可します。 | |
name | String | 100 字 | Y | 役職名。ドメイン内でユニークでなければなりません。 許容される特殊文字: !@&()-_+[]{},./ |
i18nNames | List |
N | 多言語名リスト。多言語コード。付録の言語コード参照。 | |
name | String | 100 字 | Y | 多言語名。 許容される特殊文字: !@&()-_+[]{},./ |
language | String | Y | 言語コード |
Request Example
PATCH https://apis.worksmobile.com/r/apiid/organization/v2/domains/123/positions/EX123
{
"name": "社員",
"sortLevel": 5,
"i18nNames": [
{
"name":"사원",
"language":"ko_KR"
},
{
"name":"Staff",
"language":"en_US"
},
{
"name":"员工",
"language":"zh_CN"
},
{
"name":"職員",
"language":"zh_TW"
}
]
}
Response
API 呼び出しに成功すると HTTP 200 コードと修正された役職情報を返します。
{
"name": "社員",
"externalKey": "EX123",
"sortLevel": 5,
"i18nNames": [
{
"name":"사원",
"language":"ko_KR"
},
{
"name":"Staff",
"language":"en_US"
},
{
"name":"员工",
"language":"zh_CN"
},
{
"name":"職員",
"language":"zh_TW"
}
]
}
Error code
呼び出しに失敗するとエラーコードとエラーメッセージを返します。
エラーコードは組織連携REST APIエラーコードを参照してください。