Field

API endpoints for Field.

DELETE /api/field/:id/dimension

Remove the dimension associated to field at ID.

PARAMS:

  • id

GET /api/field/:id

Get Field with ID.

PARAMS:

  • id

GET /api/field/:id/related

Return related entities.

PARAMS:

  • id

GET /api/field/:id/remapping/:remapped-id

Fetch remapped Field values.

PARAMS:

  • id

  • remapped-id

  • value

GET /api/field/:id/search/:search-id

Search for values of a Field with search-id that start with value. See docstring for metabase.api.field/search-values for a more detailed explanation.

PARAMS:

  • id

  • search-id

  • value value must be a non-blank string.

GET /api/field/:id/summary

Get the count and distinct count of Field with ID.

PARAMS:

  • id

GET /api/field/:id/values

If a Field’s value of has_field_values is :list, return a list of all the distinct values of the Field, and (if defined by a User) a map of human-readable remapped values.

PARAMS:

  • id

GET /api/field/field%2C:field-name%2C:options/values

Implementation of the field values endpoint for fields in the Saved Questions ‘virtual’ DB. This endpoint is just a convenience to simplify the frontend code. It just returns the standard ‘empty’ field values response.

PARAMS:

  • _

POST /api/field/:id/dimension

Sets the dimension for the given field at ID.

PARAMS:

  • id

  • type value must be one of: external, internal.

  • name value must be a non-blank string.

  • human_readable_field_id value may be nil, or if non-nil, value must be an integer greater than zero.

POST /api/field/:id/discard_values

Discard the FieldValues belonging to this Field. Only applies to fields that have FieldValues. If this Field’s Database is set up to automatically sync FieldValues, they will be recreated during the next cycle.

PARAMS:

  • id

POST /api/field/:id/rescan_values

Manually trigger an update for the FieldValues for this Field. Only applies to Fields that are eligible for FieldValues.

PARAMS:

  • id

POST /api/field/:id/values

Update the fields values and human-readable values for a Field whose semantic type is category/city/state/country or whose base type is type/Boolean. The human-readable values are optional.

PARAMS:

  • id

  • value-pairs value must be an array. Each value must be an array.

PUT /api/field/:id

Update Field with ID.

PARAMS:

  • visibility_type value may be nil, or if non-nil, value must be one of: details-only, hidden, normal, retired, sensitive.

  • display_name value may be nil, or if non-nil, value must be a non-blank string.

  • points_of_interest value may be nil, or if non-nil, value must be a non-blank string.

  • description value may be nil, or if non-nil, value must be a non-blank string.

  • semantic_type value may be nil, or if non-nil, value must be a valid field semantic or relation type (keyword or string).

  • coercion_strategy value may be nil, or if non-nil, value must be a valid coercion strategy (keyword or string).

  • has_field_values value may be nil, or if non-nil, value must be one of: auto-list, list, none, search.

  • settings value may be nil, or if non-nil, value must be a map.

  • caveats value may be nil, or if non-nil, value must be a non-blank string.

  • fk_target_field_id value may be nil, or if non-nil, value must be an integer greater than zero.

  • nfc_path value may be nil, or if non-nil, value must be an array. Each value must be a non-blank string.

  • id


« Back to API index

Thanks for your feedback!

See something that needs fixing? Propose a change.