利用権限タイプ追加
利用権限タイプを追加します。
参考
- ドメインの利用権限タイプ設定が「使用する」になっている必要があります。
API の種類
サーバー API
Request URL
https://apis.worksmobile.com/r/{API ID}/organization/v2/domains/{domainId}/employtypes
HTTP Method
POST (Content-Type: application/json; charset=UTF-8)
Path Parameters
パラメーター | タイプ | 上限 | 必須 | 説明 |
---|---|---|---|---|
domainId | Integer | Y | ドメイン ID |
Request Body
パラメーター | タイプ | 上限 | 必須 | 説明 |
---|---|---|---|---|
name | String | 100 字 | Y | 利用権限タイプ名。 ドメイン内でユニークでなければなりません。 許容される特殊文字: !@&()-_+[]{},./ |
externalKey | String | 100 字 | Y | 利用権限タイプの External Key。 テナント内でユニークでなければなりません。 特殊文字 \%#/? は許容されません |
sortLevel | Integer | Y | 整列順。 重複を許可します。 |
|
i18nNames | List |
N | 多言語名リスト 付録の言語/タイムゾーンコード 参照。 |
|
name | String | 100 字 | Y | 多言語名。 許容される特殊文字: !@&()-_+[]{},./ |
language | String | Y | 言語コード |
Request Example
POST https://apis.worksmobile.com/r/apiid/organization/v2/domains/123/employtypes
{
"externalKey": "EX123",
"name": "アルバイト",
"sortLevel": 5,
"i18nNames": [
{
"name":"아르바이트",
"language":"ko_KR"
},
{
"name":"Contract Employee",
"language":"en_US"
},
{
"name":"合同员工",
"language":"zh_CN"
},
{
"name":"合同員工",
"language":"zh_TW"
}
]
}
Response
API 呼び出しに成功すると HTTP 200 コードを返します。
Response Example
{
"externalKey": "EX123",
"name": "アルバイト",
"sortLevel": 5,
"i18nNames": [
{
"name":"아르바이트",
"language":"ko_KR"
},
{
"name":"Contract Employee",
"language":"en_US"
},
{
"name":"合同员工",
"language":"zh_CN"
},
{
"name":"合同員工",
"language":"zh_TW"
}
]
}
Error code
呼び出しに失敗するとエラーコードとエラーメッセージを返します。
エラーコードは組織連携REST APIエラーコードを参照してください。