Skip to main content

UpdateFieldOptions

Update field selection options

Description​

Updates an option item in the Choice, Radio, and Checkbox fields.

Method​

PUT

Request URL Format​

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

URL Params​

app-id          : Application ID (ID entered from the Hexabase screen)
datastore-id    : Data store ID (ID entered from the Hexabase screen)
field-id        : Field ID (ID entered from Hexabase screen)

Request URL Sample​

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

Payload​

{
  "options": [
    {
      "o_id": "91b81ac7-907b-4d7b-bc27-4e1d53241ac3", // (required) specify the o_id to be updated
      "name": "option1-name-update", // The same value is set for Japanese and English names
      "display_id": "option1-display_id-update",
      "enabled": false,
      "sort_id": 4 // Ability to set the order of options in the Hexabase administration screen
    },
    {
      "o_id": "e66ec32c-b781-4f93-97b7-92d0e6dff438",
      "value": { // If you want to register Japanese and English names with their respective values, specify a value object instead of name
          "en": "option2-en", // Option English name
          "ja": "option2-ja"  // Option Japanese name
      },
      "display_id": "option2-display_id-update",
      "enabled": false,
      "sort_id": 5
    }
  ]
}

Response Sample​

null