メインコンテンツまでスキップ

UpdateField

フィールド設定を更新

Description​

data_typeに合わせてフィールド設定を更新します。

※更新するフィールドのdata_type（型）に応じて設定可能な各項目が異なります

data_type項目の種類　　　　一意キー　　タイトルに利用　検索条件に利用　検索インデックスの有無　全文検索の対象とする　一覧に表示する　アクション実行時に表示しない　APIの結果に表示しない
textテキスト〇〇〇〇〇〇〇
textarea複数行テキスト〇〇〇〇〇
select選択肢〇〇〇〇〇
radioラジオ〇〇〇〇〇
checkboxチェックボックス〇〇〇〇〇
autonum自動採番〇〇〇〇〇〇〇
number数値〇〇〇〇〇
calc計算式〇〇〇〇〇
datetime日付・時刻〇〇〇〇〇
file添付ファイル〇〇〇〇〇
usersユーザー〇〇〇〇〇
dslookupデータベース参照〇〇〇〇〇
labelラベル〇〇
separatorセパレーター〇〇

Method​

PUT

Request URL Format​

/api/v0/applications/:app-id/datastores/:datastore-id/fields/:field-id

URL Params​

app-id          : アプリケーションID（Hexabase画面から入力したID）
datastore-id    : データストアID（Hexabase画面から入力したID）
field-id        : フィールドID（Hexabase画面から入力したID）

Request URL Sample​

PUT https://api.xxx.com/api/v0/applications/624bea3a879f4e8d8b5dcc6f/datastores/639912c0b1ea5632b8bc0545/fields/63991301fa9223af047f436f

Payload​

{
  "name": "フィールド名",　// 画面項目名
  "search": true, // 「検索条件に利用する」を設定
  "show_list": true, // 「一覧に表示する」を設定
  "as_title": false, // 「タイトルに利用する」を設定
  "full_text": false, // 「全文検索の対象とする」を設定
  "hideOnInput": false, // 「アクション実行時に表示しない」を設定
  "hide_from_api": false, // 「APIの結果に表示しない」を設定
  "has_index": false, // 「検索インデックスの有無」を設定
  "roles": [ // 権限の設定
    "MEMBER", // ロールIDを指定
    "624bea3a879f4e8d8b5dcc72",
  ]
}

data_type別の設定項目​

data_type: select, radio​

オプションの追加更新はCreateFieldOptionsなどを参照

{
  "selected": "91b81ac7-907b-4d7b-bc27-4e1d53241ac3", // 初期選択としたいオプションのo_idを指定
}

data_type: checkbox​

オプションの追加更新はCreateFieldOptionsなどを参照

{
  "selected": ["91b81ac7-907b-4d7b-bc27-4e1d53241ac3", "91b81ac7-907b-4d7b-bc27-4e1d53241ac4"], // 初期選択としたいオプションのo_idを指定
}

data_type: autonum​

{
  "autonum_info": {
      "prefix": "PREFIX-", // プレフィックスを指定
      "zero_padding": true, // ゼロ埋め可否
      "digit": 3 // ゼロ埋め時の桁数を指定
  }
}

data_type: number​

{
  "num_info": {
      "prefix": "PREFIX-", // プレフィックスを指定
      "suffix": "-SUFFIX", // サフィックスを指定
      "no_comma": true // カンマで桁区切りを行わない
  },
  "min_value": "10", // 入力チェックの最小値を指定
  "max_value": "1000" // 入力チェックの最大値を指定
}

data_type: calc​

{
  "calc_info": {
    "formula": "{Fld-O9DRbjC0}+1", // 計算式を設定。{}でフィールドIDを囲むことで計算式に利用可能
    "calc_target_fields": [
      "63ce11f063c4431d4443e881" // 計算式用のフィールドIDを設定
    ],
    "prefix": "PREFIX-", // プレフィックスを指定
    "suffix": "-SUFFIX", // サフィックスを指定
    "no_comma": true // カンマで桁区切りを行わない
  }
}

data_type: datetime​

{
  "min_value": "2023-01-23T16:21:52.000Z",　// 入力チェックの最小値を指定
  "max_value": "2023-01-24T16:21:52.000Z"　// 入力チェックの最大値を指定
}

data_type: file​

{
  "file_info": {
      "show_img": true // Hexabase管理画面上で画像をプレビューする
  }
}

data_type: users​

{
  "users_info": {
      "users_show_workspacemembers": false, // ワークスペースメンバーを表示する
      "users_publish_userfield": true, // 指定したユーザーへ公開する
      "single_select": false, // 単数ユーザーを選択
      "users_show_mygroup": true, // 自分が所属するグループメンバーを表示する
      "roles": [
          {
              "has_relation": true,  // trueを設定
              "r_id": "624bea3a879f4e8d8b5dcc70", // ロールIDを設定
          },
          {
              "has_relation": true,
              "r_id": "624bea3a879f4e8d8b5dcc72"
          }
        ],
        "groups": [
            {
                "g_id": "62b92e2768805f4d43812291", // グループIDを指定
                "has_relation": true
            },
            {
                "g_id": "63159cc93e323584c62139ef",
                "has_relation": true
            }
        ]
    }
}

data_type: dslookup​

{
  "dslookup_info": {
    "dslookup_project_id": "624bea3a879f4e8d8b5dcc6f", // データベース参照先のアプリケーションIDを指定します
    "dslookup_datastore_id": "624d172b719ba29522e3c11f", // データベース参照先のデータストアIDを指定します
    "dslookup_field_id": "6254d681e0eb8314120db69f" // データベース参照先のフィールドID（一意）を指定します
  }
}

※詳細を確認されたい場合は別途お問合せください

Response Sample​

null