Metadata fields

A metadata field is an ingredient of definition of the metadata set. Metadata fields define name and type of fields. Metadata fields can be organized into groups of fields. Furthermore fields can also be assigned additional data.

Access to fields can be restricted using access controls.

Managing metadata fields

Get list of fields

GET /metadata-field

Returns a list of all defined fields. See Field identifiers.

Produces:
  • application/xml, application/jsonURIListDocument
  • text/plain – CRLF-delimited list of ids or URLs
Role:

_metadata_field_read

Get field definition

GET /metadata-field/(field-name)

Returns information about a specific metadata field definition.

Status Codes:
  • 404 Not found – The specified field could not be found.
Produces:
Role:

_metadata_field_read

Create or update field definition

PUT /metadata-field/(field-name)

Creates or updates a metadata field definition.

Status Codes:
  • 400 Bad request – Either the MetadataFieldDocument was not specified correctly or an illegal type was given.
Accepts:
Produces:
Role:

_metadata_field_write

Remove field definition

DELETE /metadata-field/(field-name)

Removes the metadata field definition. Note that this action may invalidate existing metadata.

Status Codes:
  • 200 OK – The field was deleted successfully.
  • 404 Not found – The field could not be found.
Role:

_metadata_field_write

Field metadata

Metadata fields can be assigned additional data in a key-value fashion. This data can later be seen when retrieving metadata, using the include parameter in Get metadata.

Deprecated since version 4.1.2: Use the Key-value metadata interface instead.

Terse metadata schema

Retrieve terse metadata schema

GET /metadata-field/terse-schema

Retrieves the schema that defines terse metadata (see Metadata). This schema is dynamically generated based on the fields present in the system.

Produces:
  • application/xml – An XML schema.
Role:

_metadata_field_read