Metadata Form Controller

The Metadata Form Controller provides endpoints for retrieving form configurations used for metadata entry in the AdmiralCloud platform. These forms define how metadata fields are presented to users, streamlining the data collection process through structured interfaces.

With this controller, you can access form definitions that determine how metadata fields are presented to users in the AdmiralCloud interface. Well-designed metadata forms improve data quality and enhance user experience when working with metadata.

Reference

Find metadata form

Retrieves form configurations for metadata entry based on specified criteria. This endpoint returns form definitions with their fields, layout, and validation rules. Use this endpoint to discover available forms for specific containers or to access form structures for rendering in custom interfaces.

GET/v5/metadataform

Request Parameters

Field	Type	Required	Description
refresh	boolean	✗	Do not respond from cache
subtype	string	✗	If set, only forms for this subtype will be returned
type	string	✗	If set, only forms for this type will be returned

Response

Field	Type	Description
form	array	Array of categories and fields for this metadata form
└ categoryId	integer	Category id for a section/collection of fields
└ category	string	Category name for a section/collection of fields
└ settings	object	Settings of this category
└ label	object	Translation of this category
└ de	string	German translation of this metadata category
└ en	string	English translation of this metadata category
└ fields	array	Fields in this category
└ fieldId	integer	Id of the field (not the relation)
└ title	string	Technical field name – use it as property title in metadata operation
└ type	string	Type of this field, e.g. input, select, etc
└ searchable	boolean	Indicates if this field is searchable or just for displaying.
└ settings	object
└ required	boolean	TRUE if field is required in this form
└ readOnly	boolean	Set to true if you want this field to be read-only
└ multiselect	boolean	If true, make the select list a multi-select
└ placeholder	string	Placeholder for this field
└ defaultValue	string	Default value for this field
└ range	array	Array with 2 values – lower boundary and upper boundary. Searches are only valid within this range.
└ multiselect	boolean	If true, multiple values can be stored. Please send them as comma-separated list of entries (e.g. meta_productionCountry).
└ autocomplete	object	Autocomplete settings for this field-category relation Beta
└ enabled	boolean	Set to true if you want this field in this category to be required Beta
└ source	string	Source of the autocomplete feature. Elasticsearch (es), settings (this object), fixed (client module like ac-countrylist, fileExtensions), contacts. Beta ≡ allowed values: essettingsfixedcontacts
└ filter	string	filter for source field. The operation is defined on client side, e.g. to filter contacts by type Beta
└ path	boolean	Path for autocomplete, e.g. field for ES Beta
└ items	array	Autocomplete items for this field
└ label	object	Rranslation of this category
└ de	string	German translation of this metadata form
└ en	string	English translation of this metadata form
└ copy	object	Additional text to describe this field Beta
└ de	string	German translation of the text for this field
└ en	string	English translation of the text for this field
freshness	integer	Time this response has been created (especially interesting if delivered from cache)
fromCache	boolean	True if the response is delivered from cache
settings	object	Settings of the subype for this metadata form
└ label	object	Translations for this metadata form Beta
└ de	string	German translation of this metadata form
└ en	string	English translation of this metadata form
subtype	string	subtype of the metadata form
type	string	type of the metadata form

Create or update metadata form

Creates a new metadata form or updates an existing one in the AdmiralCloud platform. Forms provide structured interfaces for metadata entry, making it easier for users to input required information consistently. When creating or updating a form, you define its structure, including sections, fields, and validation rules, as well as its appearance and behavior in the UI.

If a formId is provided in the payload, the endpoint will update the existing form with that ID. If no formId is specified, a new form will be created.

IMPORTANT: Always send the complete form definition to the API when updating, not just the changed parts. Make sure there are no gaps in the positioning of fields within sections, as this can lead to unexpected behavior in the form rendering. The API replaces the entire form configuration with the new one provided, so omitting sections or fields will result in their deletion from the form.

PUT/v5/metadataform

Request Parameters

Field	Type	Required	Description
form	array	✓	Array of categories and field definitions for this form
└ categoryId	integer	✗	Category id for a section/collection of fields
└ category	string	✓	Category name for a section/collection of fields
└ settings	object	✗	Settings of this category
└ label	object	✓	Translation of this category
└ de	string	✓	German translation of this metadata category
└ en	string	✗	English translation of this metadata category
└ fields	array	✓	Fields in this category
└ fieldId	integer	✓	Id of the field
└ title	string	✗	Technical field name – use it as property title in metadata operation
└ type	string	✗	Type of this field, e.g. input, select, etc
└ searchable	boolean	✗	Indicates if this field is searchable or just for displaying.
└ settings	object	✗
└ required	boolean	✗	TRUE if field is required in this form
└ readOnly	boolean	✗	Set to true if you want this field to be read-only
└ multiselect	boolean	✗	If true, make the select list a multi-select
└ placeholder	string	✗	Placeholder for this field
└ defaultValue	string	✗	Default value for this field
└ range	array	✗	Array with 2 values – lower boundary and upper boundary. Searches are only valid within this range.
└ multiselect	boolean	✗	If true, multiple values can be stored. Please send them as comma-separated list of entries (e.g. meta_productionCountry).
└ autocomplete	object	✗	Autocomplete settings for this field-category relation Beta
└ enabled	boolean	✗	Set to true if you want this field in this category to be required Beta
└ source	string	✗	Source of the autocomplete feature. Elasticsearch (es), settings (this object), fixed (client module like ac-countrylist, fileExtensions), contacts. Beta ≡ allowed values: essettingsfixedcontacts
└ filter	string	✗	filter for source field. The operation is defined on client side, e.g. to filter contacts by type Beta
└ path	boolean	✗	Path for autocomplete, e.g. field for ES Beta
└ items	array	✗	Autocomplete items for this field
└ label	object	✗	Rranslation of this category
└ de	string	✗	German translation of this metadata form
└ en	string	✗	English translation of this metadata form
└ copy	object	✗	Additional text to describe this field Beta
└ de	string	✗	German translation of the text for this field
└ en	string	✗	English translation of the text for this field
subtype	string	✓
type	string	✓	type of the metadata form

Response

Field	Type	Description
form	array	Array of categories and fields for this metadata form
└ categoryId	integer	Category id for a section/collection of fields
└ category	string	Category name for a section/collection of fields
└ settings	object	Settings of this category
└ label	object	Translation of this category
└ de	string	German translation of this metadata category
└ en	string	English translation of this metadata category
└ fields	array	Fields in this category
└ fieldId	integer	Id of the field (not the relation)
└ title	string	Technical field name – use it as property title in metadata operation
└ type	string	Type of this field, e.g. input, select, etc
└ searchable	boolean	Indicates if this field is searchable or just for displaying.
└ settings	object
└ required	boolean	TRUE if field is required in this form
└ readOnly	boolean	Set to true if you want this field to be read-only
└ multiselect	boolean	If true, make the select list a multi-select
└ placeholder	string	Placeholder for this field
└ defaultValue	string	Default value for this field
└ range	array	Array with 2 values – lower boundary and upper boundary. Searches are only valid within this range.
└ multiselect	boolean	If true, multiple values can be stored. Please send them as comma-separated list of entries (e.g. meta_productionCountry).
└ autocomplete	object	Autocomplete settings for this field-category relation Beta
└ enabled	boolean	Set to true if you want this field in this category to be required Beta
└ source	string	Source of the autocomplete feature. Elasticsearch (es), settings (this object), fixed (client module like ac-countrylist, fileExtensions), contacts. Beta ≡ allowed values: essettingsfixedcontacts
└ filter	string	filter for source field. The operation is defined on client side, e.g. to filter contacts by type Beta
└ path	boolean	Path for autocomplete, e.g. field for ES Beta
└ items	array	Autocomplete items for this field
└ label	object	Rranslation of this category
└ de	string	German translation of this metadata form
└ en	string	English translation of this metadata form
└ copy	object	Additional text to describe this field Beta
└ de	string	German translation of the text for this field
└ en	string	English translation of the text for this field
freshness	integer	Time this response has been created (especially interesting if delivered from cache)
fromCache	boolean	True if the response is delivered from cache
settings	object	Settings of the subype for this metadata form
└ label	object	Translations for this metadata form Beta
└ de	string	German translation of this metadata form
└ en	string	English translation of this metadata form
subtype	string	subtype of the metadata form
type	string	type of the metadata form

API

Reference

Find metadata form

Create or update metadata form

Related Articles