カスタムフィールドの定義の追加
ユーザー情報のカスタムフィールドの定義を追加します。ドメイン単位で設定し、1 ドメインにつき最大 5 個まで追加できます。
API の種類
サーバー API
Request URL
https://apis.worksmobile.com/r/{API ID}/organization/v2/domains/{domainId}/customfields/{schemaKey}
HTTP Method
POST (Content-Type: application/json; charset=UTF-8)
Path Parameters
パラメーター | タイプ | 上限 | 必須 | 説明 |
---|---|---|---|---|
domainId | Integer | Y | ドメイン ID | |
schemaKey | String | 100字 | Y | カスタムフィールドを定義するキー。 ドメイン内でユニークでなければなりません。 英数字のみ使うことができ、最初の文字は英字にしてください。 大文字小文字は区別しません。 |
Request Body
パラメーター | タイプ | 上限 | 必須 | 説明 |
---|---|---|---|---|
name | String | 20字 | Y | カスタムフィールド名。 ドメイン内でユニークでなければなりません。 |
type | String | Y | カスタムフィールドのタイプ。 ● STRING: テキスト ● LINK: URL |
|
order | Integer | N | 整列順。 重複を許可し、昇順で整列されます。 値を入力しない(NULL)場合、最後尾に指定されます。 |
|
displayClients[] | List<String> | N | カスタムフィールドを表示するアプリケーション。 値を入力しない(NULL)場合、すべてのアプリケーションで表示されます。 ● PC_WEB : ブラウザ版 ● PC_APP : デスクトップ版 ● MOBILE : モバイル版 |
Request Example
POST https://apis.worksmobile.com/r/apiid/organization/v2/domains/123/customfields/schema123
{
"order": 1,
"name": "担当製品",
"type": "LINK",
"displayClients": [
"PC_WEB",
"PC_APP"
]
}
Response
API 呼び出しに成功すると HTTP 200 コードを返します。
Error Code
呼び出しに失敗するとエラーコードとエラーメッセージを返します。
エラーコードは組織連携REST APIエラーコードを参照してください。