Object specifications for metadata profiles and metadata values 0.1.0 documentation

Object specifications for metadata profiles and metadata values 0.1.0

The web applications of IQB use a flexible metadata system. The data structures described below help to implement components and libraries to edit, store and process these values.

Go to the Schema section of this document and select one schema. Expand all nodes and explore.

Operations

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

Schemas

object
uid: https://w3id.org/iqb/vocabs/md-profile.json
Data structure to manage UI components for metadata of objects

id
required
string
Identifier for the metadata profile

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

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

value
required
string
required
array<object>
non-empty
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
lang
required
string
must match: ^[a-z]{2}$
ISO-language code

value
required
string
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 (see md-values).

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
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 (see md-values).

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
lang
required
string
must match: ^[a-z]{2}$
ISO-language code

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

value
required
string
Additional properties are allowed.
Additional properties are allowed.
object
uid: https://w3id.org/iqb/vocabs/md-values.json
Data structure to store metadata

profileId
required
string
Identifier for the metadata profile

required
array<object>
non-empty
id
required
string
Id of the profile entry related to these data

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

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

value
required
string
array<object>
id
required
string
Id of the vocabulary entry

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

value
required
string
Or to:
string
array<string>
Items:
string
Additional properties are allowed.
object
uid: https://w3id.org/iqb/vocabs/md-profile-config.schema.json
Configuration file to validate a metadata profile store

id
required
string
must match: ^[0-9a-zA-Z_]+$
Identifier for the metadata profile store as part of the uri

creator
required
string
Creator as person or institution

required
array<object>
non-empty
lang
required
string
must match: ^[a-z]+$
Language of the value

value
required
string
Language of the value

mdOutDir
string
Folder where the markdown output is written to.

Default value:"./docs"
required
array<string>
non-empty
Items:
string
non-empty
Name of the profile json files

Additional properties are allowed.

Object specifications for metadata profiles and metadata values 0.1.0

Operations

PUB iqb_data_structures

Examples

Schemas