ユーザーのカスタマイズ項目を取得する
ユーザーのカスタマイズ項目を取得する
ユーザーのカスタマイズ項目を取得します。
ユーザーの情報を元にした分岐処理や、ユーザーの情報を表示するUIの作成などに利用できます。
ログインユーザーのカスタマイズ項目を取得するときは、非公開のカスタマイズ項目も取得できます。
このAPIは非同期なAPIです。
同期的に処理したい場合は、次のページを参照してください。
関数
PC/モバイル
kintone.user.getCustomFields(code)
引数
| 引数名 | 型 | 必須 | 説明 |
|---|---|---|---|
| code | 文字列 | 省略可 | 情報を取得するユーザーのログイン名 省略した場合はログインユーザーの情報を取得します。 |
戻り値
戻り値はPromiseオブジェクトです。
Promiseオブジェクトの解決時に次の要素をもつオブジェクトの配列が取得できます。
| プロパティ名 | 型 | 値と説明 |
|---|---|---|
| code | 文字列 | 項目コード |
| name | 文字列 | 項目名 |
| type | 文字列 | タイプ
|
| value | 文字列/オブジェクト | 保存された値typeによってデータの型が変わります。
|
| value.code | 文字列 | 保存されたユーザーのコードtypeがUSER_SELECTの場合のみ存在します。 |
| value.name | 文字列 | 保存されたユーザーの名前typeがUSER_SELECTの場合のみ存在します。 |
| visibility | 文字列 | 公開/非公開の設定
|
利用できる画面
PC/モバイル
利用できる画面は、全体カスタマイズの適用画面に従います。
kintone全体のカスタマイズが適用される画面
ただし、次の画面では利用できません。
- 検索画面
- アプリストア
- プラグイン設定画面
注意事項
このAPIは実行時にサーバーからデータを取得します。取得したデータは画面遷移が発生するまでキャッシュされます。
ユーザーごとに1分当たり50回を超えるサーバーからのデータの取得があった場合、戻り値のPromiseオブジェクトが拒否(rejected)されます。
