metadata-profile - click on schema id to expand documentation

metadata-profile - click on schema id to expand

Data interface for defining metadata for objects based on vocabularies of IQB.

Operations

SEND iqb_data_structures
Operation IDPlease select one schema
Accepts the following message:
Message IDselect_schema
Examples

Schemas

object [Metadata Profile]
uid: metadata-profile@iqb-standard@0.9
Data interface for defining metadata for objects based on vocabularies of IQB.

id
required
string
Identifier for the metadata profile

required
array<object>
non-empty
Used for storing the input of texts. This type applies also in cases when only one language is used.

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
required
array<object>
non-empty
object
required
array<object>
non-empty
Used for storing the input of texts. This type applies also in cases when only one language is used.

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
required
array<object>
non-empty
object
id
required
string
must match: ^[a-zA-Z][0-9a-zA-Z_]*$
Identifier for the property as part of the metadata profile

array<object>
non-empty
Used for storing the input of texts. This type applies also in cases when only one language is used.

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
type
required
string
Allowed values:
"text"
"vocabulary"
"boolean"
"number"
anyOf
object
Creates values of type string (one possible id), string[] (multiple ids) or id+text tuples, if text input is allowed.

url
required
string
URI to the JSON representation (SkoHub) of the vocabulary definition

allowMultipleValues
boolean
If true, multiple values are allowed taken from the vocabulary

Default value:false
selectionMode
string
UI variants: 'in-form' sets an radio or checkbox list in the form, 'dialog' challenges a modal dialog for selection (default).

Default value:"dialog"
Allowed values:
"in-form"
"dialog"
maxLevel
integer
Maximum level taken from the hierarchical vocabulary. This is to hide lower levels. Use '0' for all levels (default).

Default value:0
hideNumbering
boolean
If true, the numbering of vocabulary entries is not used/showed in components.

Default value:false
hideDescription
boolean
If true, the description of vocabulary entries is not used/showed in components.

Default value:false
hideTitle
boolean
If true, the title of vocabulary entries is not used/showed in components.

Default value:false
array<string>
If not empty, text can be added to the selected vocabulary entry. The given entries specify the expected language(s).

Default value:[]
Items:
string
must match: ^[a-z]{2}$
ISO-language code

Additional properties are allowed.
object
Creates values of type string (one possible language) or multi-language texts.

format
string
If true, more then one line of text is prepared for input. Text is wrapped and vertical scrolling is possible.

Default value:"single"
Allowed values:
"single"
"multiline"
"html"
array<string>
Use this property to add languages, so you provide more then one text input form field.

Default value:[de]
Items:
string
must match: ^[a-z]{2}$
ISO-language code

pattern
string
Use this regular expression to validate the input value.

Additional properties are allowed.
object
Creates values of type string with number content. The decimal separator is always dot '.'.

digits
integer
>= 0
Number of digits. Negative values are not valid.

Default value:0
minValue
number
Minimal value valid for this entry.

maxValue
number
Maximal value valid for this entry.

isPeriodSeconds
boolean
If true, the (integer) value is interpreted as a number of seconds (duration, time period). This might adapt the form controls.

Default value:false
Additional properties are allowed.
object
Creates values of type string 'true' or 'false'.

array<object>
non-empty
Used for storing the input of texts. This type applies also in cases when only one language is used.

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
array<object>
non-empty
Used for storing the input of texts. This type applies also in cases when only one language is used.

object
lang
required
string
must match: ^[a-z]{2}$non-empty
ISO-language code

value
required
string
Additional properties are NOT allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.

Operations

SEND iqb_data_structures

Examples

Schemas