List a field's compatible types

GET/forms/{form_id}/fields/{id}/compatible-types

forms:read get_form_field_compatible_typesRead-only

Lists the field types the field can be safely changed to. With no answers a field can become any convertible type; once answered it is constrained to its conversion group. An unknown or hidden form, or a field of another form, returns 404. It changes nothing.

Path parameters

form_idstring (uuid)Required#
The form's id, a uuid. An unknown id, or a hidden form, returns 404.
idstring (uuid)Required#
The field's id, a uuid. A field of another form returns 404.

Responses

200

The compatible types.

CompatibleFieldTypes

{
  "data": {
    "current_type": "TEXT",
    "has_answers": false,
    "compatible_types": [
      "TEXT",
      "BIGTEXT"
    ]
  }
}

401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error

403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error

404

Resource not found (error.code = not_found).

Error

429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/forms/{form_id}/fields/{id}/compatible-types\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"