BioStar 2設定->サーバーに移動すると、カスタムユーザーフィールドを設定できます。カスタムユーザーフィールドは、BioStar2の登録済みユーザーに使用できるユーザー定義情報です。
カスタムユーザーフィールドを利用して「誕生日」または「ニックネーム」の情報を追加できます。
また、BioStar 2 New Local APIを使用してカスタムユーザーフィールドを追加することもできます。 カスタムユーザーフィールドに関連する2つのAPI関数を確認します。
1．カスタムユーザーフィールドを検索する方法
2．カスタムユーザーフィールドを更新（または追加）する方法
*上記のAPI呼び出しはまだSwaggerにリストされていません。（2021-09-30）
1. カスタムユーザーフィールドを検索する方法
Method | API | 目的 | パラメーター |
GET | /api/setting/custom_fields | BioStar2のすべてのカスタムユーザーフィールドを検索します。 |
|
[GET] /api/setting/custom_fields
[レスポンス]
{ "CustomFieldCollection": { "total": "3", "rows": [ { "id": "1", "name": "Birthday", "type": "0", "order": "1" }, { "id": "8", "name": "CUF_Number", "type": "1", "order": "2" }, { "id": "9", "name": "CUF_Combo", "type": "2", "order": "3", "data": "Option 1; Option 2; Option 3" } ] }, "Response": { "code": "0", "link": "https://support.supremainc.com/en/support/home", "message": "Success" } } |
- ‘total’: カスタムユーザーフィールドアイテムの数
- ‘id’: カスタムユーザーフィールドID
- ‘name’: カスタムユーザーフィールド名称
- ‘type’: カスタムユーザーフィールドのタイプ 0 = テキスト, 1 = 数字, 2 = コンボボックス
- ‘data’: このパラメータは、「コンボ」フィールドにのみ存在します。 選択オプションを示します。
2. カスタムユーザーフィールドを更新（または追加）する方法
Method | API | 目的 | Parameters |
PUT | /api/setting/custom_fields | BioStar2のカスタムユーザーフィールドを更新します | Id, name, type, order, data, enable |
[PUT] /api/setting/custom_fields
[パラメーター：既存のフィールドの場合]
名称 | タイプ | *M/O | 説明 |
Id | String | M | カスタムユーザーフィールドID |
Name | String | M | カスタムユーザーフィールド名称 |
Type | String | M | カスタムユーザーフィールドタイプ 0 = テキスト 1 = 数字 2 = コンボボックス |
Order | String | O | カスタムユーザーフィールドコンボ |
* M – 必須, O – オプション
[パラメーター：新しいカスタムユーザーフィールドを追加する]
名称 | タイプ | *M/O | 説明 |
Order | String | O | カスタムユーザーフィールドコンボ |
Name | String | M | カスタムユーザーフィールド名称 |
Type | String | M | カスタムユーザーフィールドタイプ 0 = テキスト 1 = 数字 2 = コンボ |
Enable | True/False | M | 使用/未使用の設定です。使用する場合は「true」に設定してください。 |
[リクエストボディ]
{ "CustomFieldCollection": { "total": "3", "rows": [ { "id": "1", "name": "Birthday", "type": "0", "order": "1" }, { "id": "8", "name": "CUF_Number", "type": "1", "order": "2" }, { "id": "9", "name": "CUF_Combo", "type": "2", "order": "3", "data": "Option 1; Option 2; Option 3; Option 4" }, { "order": 4, "name": "CUF_NEW", "type": 0, "enable": true } ] } } |
*黄色のところは、追加する新しいカスタムユーザーフィールドを示します
[レスポンス]
{ "Response": { "code": "0", "link": "https://support.supremainc.com/en/support/home", "message": "Success" } } |
*BioStar2に追加したカスタムユーザーフィールドが表示されます。
3. 例– カスタムフィールドでユーザー情報を取得する
[GET] /api/users/{user_id}を呼び出すと、選択したユーザーのカスタムフィールド値を確認できます。
{ "UserCollection": { "total": "6", "rows": [ { "user_id": "2", "name": "Sharon", "gender": "0", "photo_exists": "false", "pin_exists": "false", "login_id": "sharon", …(skipped) "user_custom_fields": [ { "item": "1990-02-31", "user_id": { "user_id": "2", "name": "Sharon" }, "custom_field": { "id": "1", "name": "Birthday", "type": "0", "order": "1" } }, { "item": "33333", "user_id": { "user_id": "2", "name": "Sharon" }, "custom_field": { "id": "8", "name": "CUF_Number", "type": "1", "order": "2" } }, { "item": "Option 1", "user_id": { "user_id": "2", "name": "Sharon" }, "custom_field": { "id": "9", "name": "CUF_Combo", "type": "2", "order": "3" } }, { "item": "New Field", "user_id": { "user_id": "2", "name": "Sharon" }, "custom_field": { "id": "10", "name": "CUF_NEW", "type": "0", "order": "4" } } ] } ] }, … "Response": { "code": "0", "link": "https://support.supremainc.com/en/support/home", "message": "Success" } } |
[Swagger上の結果]