Metadata 23.3

MediaHaven has a wide variety of metadata fields. This table list various information about these fields.

Legend

  • Key / Sub Key: The name of the field as it appears the metadata XML and JSON

  • Format: extra information about the format of the value, seeĀ Metadata Concepts for more information about the used terms

  • Read-only: This field cannot be modified in the user interface or API calls

  • Search: When performing a search query APIs you must use the flattened key, for example +Title:"Breaking News!" +KeywordsKeyword:PoliticsĀ Ā 

  • Searchable: In theĀ MediaHaven REST API you can search and sort on this field

Descriptive Fields

Descriptive fields are modifiable fields that describe files forĀ purposes such as discovery.

Key

Sub Key

Description

Format

Read-only

Search

Key

Sub Key

Description

Format

Read-only

Search

Title

Ā 

The title of the file

Ā 

Ā 

Description

Ā 

Description about the file

Ā 

Ā 

CreationDate

Ā 

The date and time the file was originally created

yyyy:MM:dd'T'HH:mm:ss.uuuuuuZ

Ā 

RightsOwner

Ā 

The name of the (copyright) owner of the file

Ā 

Ā 

Ā 

Rights

Ā 

A description about how the file can or can not be disseminated.

Ā 

Ā 

Ā 

Keywords

Ā 

Series of keywords about the file

ListField

Ā 

Ā 

Keywords

Keyword

Sub field ofĀ Keywords containing an individual keyword

Ā 

Ā 

Categories

Ā 

Series of categories about the file

ListField

Ā 

Ā 

Categories

Category

Sub field ofĀ CategoriesĀ containing an individual category

Ā 

Ā 

Publisher

Ā 

Publisher of the file

Ā 

Ā 

Ā 

Authors

Ā 

A list of various authors of the file

MulitItemField

Ā 

Ā 

AuthorsAuthor

Ā 

Sub field ofĀ Authors containing an individual author

Ā 

Ā 

Publications

Ā 

List of locations where the file is published

ListField

Ā 

Ā 

Publications

Comment

Sub field ofĀ Publications describing a comment

Ā 

Ā 

Ā 

OriginalFilename

Ā 

The name of the file as it was ingested into MediaHaven

Ā 

Ā 

OriginalPath

Ā 

The relative path of the file to the watchfolder or archive was ingested into MediaHaven

Ā 

Ā 

Ā 

UploadedBy

Ā 

The name of the user that uploaded the file

Ā 

Ā 

KeyframeStart



By default theĀ the fieldĀ PathToKeyframe refers to the closest keyframe before to time provided by the fieldĀ FragmentStart. WhenĀ KeyframeStart is defined it overrides this time.

frames (using aĀ fictitious 25 fps)

Ā 

LimitedCategories

Key

Sub Key
#1

Sub Key #2

Description

Format

Read-only

Search

Key

Sub Key
#1

Sub Key #2

Description

Format

Read-only

Search

LimitedCategories

Ā 

Ā 

List of categories linked with the record

ComplexListField

Ā 

Ā 

LimitedCategories

Category

Ā 

A single category which corresponds with a concept in the thesaurus

ThesaurusField

Ā 

Ā 

LimitedCategories

Category

Uri

ThesaurusUriField

Ā 

LimitedCategories

Category

Nl

Dutch label of the concept

ThesaurusLabelField

Ā 

LimitedCategories

Category

En

English label of the concept

ThesaurusLabelField

Ā 

LimitedCategories

Category

Fr

French label of the concept

ThesaurusLabelField

Ā 

LimitedCategories

Category

De

German label of the concept

ThesaurusLabelField

Ā 

Position

Key

Sub Key

Description

Format / Example

Read-only

Search

Key

Sub Key

Description

Format / Example

Read-only

Search

Position

Ā 

Number of edit units to skip at the start of the source video codec before the logical of start of the essence

Ā 

Ā 

Ā 

Position

Location

latitude,longitude

51.001139,4.51515

Ā 

Position

Address

  • The translation of the Descriptive.Position.Location into a human address readable using the Google Geocoding API

  • Same meaning as the obsolete field Descriptive.Address.Formatted

LeuvensesteenwegĀ 582,Ā 2812Ā Mechelen,Ā BelgiĆ«

Ā 

Ā 

Position

Country

The country part of the translated Descriptive.Position.Address (auto-generated)

Belgiƫ

Ā 

Position

Area

The area part of the translated Descriptive.Position.Address (auto-generated)

Vlaanderen

Ā 

Position

SubArea

The sub area part of the translated Descriptive.Position.Address (auto-generated)

Antwerpen

Ā 

Position

Postal

The postal code part of the translated Descriptive.Position.Address (auto-generated)

2812

Ā 

Position

Locality

The locality / city / council part of the translated Descriptive.Position.Address (auto-generated)

Mechelen

Ā 

Position

SubLocality

The sub locality / city / council part of the translated Descriptive.Position.Address (auto-generated)

Muizen

Ā 

Position

Street

The street part of the translated Descriptive.Position.Address (auto-generated)

Leuvensesteenweg

Ā 

Position

Number

The house number part of the translated Descriptive.Position.Address (auto-generated)

582

Ā 

Administrative Fields

Administrative Fields are human readable read-only fields which are usedĀ for managing and preserving files in MediaHaven.

Key

Description

Format

Read-only

Search

Key

Description

Format

Read-only

Search

OrganisationName

The name of the organisation to which the file belongs

Ā 

LastModifiedDate

The date and time when the file was last modified by any user, including by the system under the hood

yyyy:MM:dd'T'HH:mm:ss.uuuuuuZ

UserLastModifiedDate

The date and time when the file was last edited by non system user. System users are used by process and customer support users.

yyyy:MM:dd'T'HH:mm:ss.uuuuuuZ

ExternalId

The ID of the file in an external platform. This field is only for advanced installations.

Ā 

ArchiveDate

The date and time the file was ingested

yyyy:MM:dd'T'HH:mm:ss.uuuuuuZ

Type

The type of the file (e.g. image, document, page, image, layer, newspaperpage, article, video, videofragment, audio, audiofragment, set, collection, newspaper, metadataonly)

Ā 

DepartmentName

The name of the department that published the file

Ā 

Workflow

Describes through which workflow a file was ingestedĀ (if applicable)

Ā 

IngestTape

Describes on which ingest tape the file was provided (if applicable)

Ā 

IsSynchronized

Indicates whether or not this file or fragment has been synchronized from another MediaHaven.

0 or 1

ExternalUrl

When this file has been sychronized from another MediaHaven, this URL refers to file in the web site of the original MediaHaven.

URL

Ā 

IsOriginal

Indicates if the file is an original file

0 or 1

IsPreservation

Indicates if the file is valid for preservation means

0 or 1

IsAccess

Indicates if the file is valid for access means

0 or 1

RecordType

The type of the record.Ā 

Ā 

RecordStatus

The status of the record (e.g. but not limited to New or Published)

Ā 

OrganisationExternalId

External id of the organisation to which the file belongs.

Ā 

Ā 

OrganisationLongName

The full name of an organisation including white space and punctuationĀ 

Ā 

PublicationDate

The date and time the file was published

yyyy:MM:dd'T'HH:mm:ss.uuuuuuZ

DeleteStatus

Indicates if the record is deleted, and if so whether itā€™s been deleted logically or permanently.

  • NotDeleted

  • LogicallyDeleted

  • PermanentlyDeleted

LogicalDeletionDate

The time the record was logically deleted.

yyyy:MM:dd'T'HH:mm:ss.uuuuuuZ

RejectionDate

The date and time the record was rejected.

yyyy:MM:dd'T'HH:mm:ss.uuuuuuZ

ChildOrderFields

Key

Sub Key
#1

Sub Key #2

Description

Format

Read-only

Search

Key

Sub Key
#1

Sub Key #2

Description

Format

Read-only

Search

ChildOrderFields

Ā 

Ā 

The sort order the children of the record should be retrieved in.

ComplexListField

Ā 

ChildOrderFields

Field

Ā 

A single sort field.

MapField

Ā 

ChildOrderFields

Field

DottedKey

The dotted key of a sortable field definition.

SimpleField

Ā 

ChildOrderFields

Field

Direction

The direction to sort the fields in.

Possible values are:

  • Asc

  • Desc

EnumField

Ā 

Technical Fields

Technical fields are predominantly read-only fields whose values are inherent to data file itself. (Re)-ingesting the file, possibly in a different MediaHaven, will result in exactly the same values.

Common

Key

Description

Format

Read-only

Search

Since

Key

Description

Format

Read-only

Search

Since

OriginalExtension

The extension of the file as it was ingested into MediaHaven

Ā 

Ā 

FileSize

The size of the file in bytes

Ā 

Ā 

Md5

The MD5 checksum of the file

Ā 

Ā 

MimeType

The mime type of the file, e.g. image/jpg

Ā 

Ā 

PronomId

The Pronom ID is a file identification mechanism developed by the National ArchivesĀ 

Ā 

Ā 

Width

The width of the file

pixels

Ā 

Height

The height of the file

pixels

Ā 

ImageSize

Width times height, e.g 1920x1080

pixels times pixels

Ā 

ImageQuality

The quality of the image

  • high

    • image: 1920x1200

    • video: 1280x720

  • medium

    • image: 1024x768

    • video:Ā 720x540

  • low

Ā 

ImageOrientation

The orientation of the image

  • panorama (aspect >= 2)

  • landscape (2 > aspect >= 1.1)

  • square (1.1 >= aspect > 0.9)

  • portrait (0.9 >= aspect > 0.5)

  • strip (aspect < 0.5)

Ā 

Exif

Contains all EXIF metadata extracted from the file, see Metadata Harvest & Mining for a non exhaustive list of extracted properties

MapField

Ā 

21.3

Sha256

The SHA256 checksum of the file. Not filled in by default.

Ā 

23.1

Time codes

Key

Description

Format

Read-only

Search

Key

Description

Format

Read-only

Search

DurationTimeCode

The duration of the media file

HH:mm:ss.SSS

Ā 

StartTimeCode

The start time of the media file

HH:mm:ss.SSS

Ā 

EndTimeCode

The end time of the media file

HH:mm:ss.SSS

Ā 

DurationFrames

The duration of the media file, expressed in frames against a fictitious 25 frames per second, e.g.Ā 0000000025

frames
(using aĀ fictitious 25 fps)

Ā 

StartFrames

The start time of the media file, expressed in frames against a fictitious 25 frames per second, e.g.Ā 0000000025

frames
(using aĀ fictitious 25 fps)

Ā 

EndFrames

The end time of the media file, expressed in frames against a fictitious 25 frames per second, e.g.Ā 0000000025

frames
(using aĀ fictitious 25 fps)

Ā 

VideoĀ 

Key

Description

Format

Read-only

Search

Key

Description

Format

Read-only

Search

VideoCodec

Description about the video encoding of the file

Ā 

Ā 

VideoFps

Frames per second of the video in the file

frames per second (fps)

Ā 

VideoBitRate

Average bit rate of the video in the file

bits per second (bps)

Ā 

AudioCodec

Description about the audio encoding of the file

Ā 

Ā 

AudioChannels

Total number of audio channels in the file, if the file has multiple audio tracks, this is the cumulative sum over all tracks

Ā 

Ā 

AudioSampleRate

Sample rate of the first audio track in the file

Hz

Ā 

AudioBitRate

Total average bitrate of all audio tracksĀ 

bits per second (bps)

Ā 

AudioTracks

The amount of audio tracks in the file

Ā 

Ā 

BitRate

Total average bit rate of the container (includes video and audio)

bits per second (bps)

Ā 

MXF Video

Key

Description

Format

Read-only

Search

Key

Description

Format

Read-only

Search

Origin

Number of edit units to skip at the start of the source video codec before the logical of start of the essence

frames

Ā 

EssenceOffset

File offset to the first partition containing essence

bytes

Ā 

EditUnitByteSize

  • > 0: Constant Bit Rate (CBR) MXF: Each edit unit has this fixed size

  • 0: Variable Bit Rate (VBR) MXF: Edit units have a variable size

  • -1: Unrecognized edit unit structure

bytes

Ā 

RunIn

File offset to the first KLV in the file, typicallyĀ 0

bytes

Ā 

FramesPerEditUnit

Number of frames per edit unit

frames

Ā 

EditRate

Number of edit units per second, ifĀ FramesPerEditUnit isĀ 1 this equals theĀ VideoFps

fraction

Ā 

IndexEditRate

Advanced MXF feature, stored for future usage

fraction

Ā 

Internal Fields

Internal fields are read-only metadata fields proper to MediaHaven and often not in a human-readable format opposed to the administrative fields.

Key

Description

Remark

Read-only

Search

Since

Key

Description

Remark

Read-only

Search

Since

RecordId

Successor of the MediaObjectId field containing exactly the same value with MediaObjectId remaining in place for backwards compatibility.

64 characters

Ā 

MediaObjectId

The unique identifier of the file

64 characters

Ā 

FragmentId

The unique identifier of the fragment of the file

96 characters

Ā 

OriginalStatus

Status of the validation and ingest of the file

  • in_progress: file is being processed

  • completed: file is successfully stored on storage

  • failed: ingest failed and the file is not succesfully stored on storage

Ā 

BrowseStatus

Status of the creation of the preview of the file

  • in_progress: browse is being generated

  • completed: browse is successfully created

  • no_browse: no browse is created for this file type

  • cancelled: ingest failed before a browse was created

  • failed: browse could not be created

Ā 

ArchiveStatus

The possible values are documented here: Ingest Monitoring

Ā 

Ā 

OrganisationId

The ID of the organisation to which the file belongs to. The administrative field OrganisationName provides the human readable name.



Ā 

IngestSpaceId

The ID of the ingest space the file belongs or belonged to

UUID

Ā 

IsInIngestSpace

Whether the file still belongs to an ingest space

0 or 1

Ā 

UploadedById

The user ID of the user that uploaded the file, the administrative fieldĀ UploadedBy provides the human readable name.

UUID

Ā 

DepartmentId

uuid of the department the file was published with, the administrative fieldĀ DepartmentNameĀ provides the human readable name.

UUID

Ā 

IsFragment

Indicates whether or not the file is the main fragment or non-main fragment (i.e. page of a document, videofragment of a video)

0 or 1

Ā 

Ā 

HasKeyframes

Indicates whether or not the the file has a series of keyframes (applicable to documents, multi-page images, video and audio)

0 or 1

Ā 

Ā 

ContainsGeoData

Indicates whether or not the file has geolocation data associated to it

0 or 1

Ā 

Profiles

A list of profiles linked to this record, sorted by record type. Note that Mediahaven 1.0 profiles will not be added to this field.

MulitItemField

Ā 

Profiles.All

Profiles that can be used for records of any record type.

Ā 

Ā 

ExternalSourceUrl

Source URL of the file. Only filled out when POST ing the record with the fileUrl parameter.

URL

Ā 

22.4

OffsetInDatabase

Offset of the record in the database. Records are reindexed in this order.

LongField

23.1

IndexName

Name of the index in which the record is stored.

Ā 

Ā 

23.1

Previews

Key

Description

Remark

Read-only

Key

Description

Remark

Read-only

PathToKeyframe

Public accessible URI to the high resolution keyframe of the record.

URI

PathToKeyframeThumb

Public accessible URI to the low resolution keyframe of the record.

URI

PathToPreview

Public accessible URI to the access representation file.

URI

PathToVideo

Public accessible URI to the browse mp4 for videos. Obsolete, use PathToPreview instead.

URI

PathToOriginal

Public accessible URI to the original representation file. By default this is not available because the original storage is only made public upon request ā†’ Direct Downloads.

URI

BrowsesĀ 

Key

Sub Key #1

Sub Key
#2

Description

Remark

Read-only

Key

Sub Key #1

Sub Key
#2

Description

Remark

Read-only

Browses

Ā 

Ā 

List of browse formats generated for the file

ComplexField

Browses

Browse

Ā 

Description of a single browse format of the file

MapField

Browses

Browse

Label

Unique label of this browse format

Ā 

Browses

Browse

Container

Extension of the container of this browse, e.g. jpg, mp4

Ā 

Browses

Browse

BaseUrl

URL to the path containing the files associated with this browse format

Ā 

Browses

Browse

PathToKeyframe

Relative path to the main still image of the file. Prefix withĀ BaseUrl to obtain the complete URL.

Ā 

Browses

Browse

PathToKeyframeThumb

Relative path to the main still image of the file (thumb version). Prefix withĀ BaseUrl to obtain the complete URL.

Ā 

Browses

Browse

PathToVideo

Relative path to the video preview of the file. Prefix withĀ BaseUrl to obtain the complete URL.

Ā 

Browses

Browse

FileSize

File size of the PathToVideoĀ for audio / video or PathToKeyframeĀ for other content.

bytes

Browses

Browse

Width

Width of the preview (PathToKeyframe)

pixels

Browses

Browse

Height

Height of the previewĀ (PathToKeyframe)

pixels

Browses

Browse

...

All keys available under the itemĀ #Video on this same page

Ā 

DistributionsĀ 

Key

Sub Key

Description

Remark

Read-only

Search

Key

Sub Key

Description

Remark

Read-only

Search

Distributions



List of distribution channels where the file has been distributed to

ListField



Distributions

Distribution

Provides information about a single channel in the form of <protocol>:<ID>, e.g. jwplayer:bZZVWxol

protocol:id

WorkflowsĀ 

Key

Sub Key

SubĀ  Key #2

Description

Remark

Read-only

Search

Key

Sub Key

SubĀ  Key #2

Description

Remark

Read-only

Search

Tasks

Ā 

Ā 

List of tasks active for this record

ComplexField

Ā 

Tasks

Task

Ā 

Provides information about a single task

MapField

Ā 

Tasks

Task

Id

Unique ID of this task

SimpleField

Ā 

Tasks

Task

TypeName

Type of task (human readable)

SimpleField

Tasks

Task

TypeId

Type of task

SimpleField

Tasks

Task

ProcessName

Name of the process this task belongs to

SimpleField

Tasks

Task

ProcessId

The ID of the process this task belongs to

SimpleField

Tasks

Task

AssigneeUserId

ID of the assigned user

SimpleField

Tasks

Task

AssigneeUserLogin

Login of the assigned user

SimpleField

Tasks

Task

AssigneeFunction

Function necessary to complete this task

SimpleField

Tasks

Task

CreationDate

Date on which this task was created

DateField

Tasks

Task

DueDate

This task should be completed before this date

DateField

Structural FieldsĀ 

Structural fieldsĀ provide how compound files such as collections are put together or how files are related between each other. ThreeĀ categories exist: Fragments, Ensembles and Relations.

Record Tree

Key

Sub Key

Description

Remark

Read-only

Search

Since

Key

Sub Key

Description

Remark

Read-only

Search

Since

ReferenceCodes

Ā 

Contains the full line of ancestors. More info Record Tree

ComplexField

Ā 

ReferenceCodes

Record

Ā 

SimpleField

Ā 

ReferenceTitles

Ā 

Contains the titles of the full line of ancestors.

ComplexField

Ā 

ReferenceTitles

Record

Ā 

SimpleField

Ā 

ParentRecordId

Ā 

If the record has a parent record, this value contains the RecordId of that parent.

SimpleField

Ā 

HasChildren

Ā 

If record has or had children in at least one point in time this will field be forever true

BooleanField

Ā 

OriginalRecordId

Ā 

Refers to the original representation, see Record Tree Glossary | Terms: Representation Forms.

SimpleField

Ā 

22.4

PreviewRecordId

Ā 

  • For data objects and original representations, is refers to the primary access representation. See Record Tree Glossary.

  • If filled out, the paths PathToPreview PathToKeyframe PathToKeyframeThumb will refer to the previews of the referred other record.

SimpleField

Ā 

Ā 

ChildOrder

Ā 

Sort order for children of intellectual objects

LongField

Starts from 1

Ā 

Ā 

23.3

Fragments

Key

Sub Key

Description

Remark

Read-only

Search

Key

Sub Key

Description

Remark

Read-only

Search

Fragments

Ā 

Series of fragments belonging to this file. The main fragment which corresponds to the file itself (i.e. the entire video) is non contained in this series, hence this list is empty if the file contains no pure (= non main) fragments.

ListField

Ā 

Fragments

Fragment

Sub field ofĀ Fragments giving theĀ FragmentId of each fragment this file contains

FragmentId

Ā 

MainFragment

Ā 

For a pure fragment, this refers theĀ FragmentId of main fragment. For the main fragment this field is empty.

SimpleField

Ā 

FragmentStartFrames

Ā 

The start time of a fragment, relative to the start of the media file, expressed in frames against a fictitious 25 frames per second

frames
(using aĀ fictitious 25 fps)

Ā 

FragmentEndFrames

Ā 

The end time of a fragment, relative to the start of the media file, expressed in frames against a fictitious 25 frames per second

frames
(using aĀ fictitious 25 fps)

Ā 

FragmentDurationFrames

Ā 

The duration of a fragment, expressed in frames against a fictitious 25 frames per second

frames
(using aĀ fictitious 25 fps)

Ā 

FragmentStartTimeCode

Ā 

The start time of a fragment, relative to the start of the media file

HH:mm:ss.SSS

Ā 

Ā 

FragmentEndTimeCode

Ā 

The end time of a fragment, relative to the start of the media file

HH:mm:ss.SSS

Ā 

Ā 

FragmentDurationTimeCode

Ā 

The duration of a fragment

HH:mm:ss.SSS

Ā 

Versioning

Key

Sub Key

Description

Remark

Read-only

Search

Key

Sub Key

Description

Remark

Read-only

Search

Versioning



Provides structural information about the chain versions of the same logical file. Each record in the chain is a separate record itself with its own MediaObjectId / FragmentId. All records in the chain have the same Versioning > Id.

MapField



Versioning

Status

Untracked for records without versioning, otherwise possible values areĀ Draft, Head, Rejected, Tail.

EnumField

Versioning

Id

Has the same value for an entire versioning chain; its value is the MediaObjectId of the first record in the chain (with Version = 1).

SimpleField

Versioning

Version

Positional index in the chain of versions, starting from Version 1.

FramesField

Ensembles

Key

Sub Key

Description

Remark

Read-only

Search

Key

Sub Key

Description

Remark

Read-only

Search

Collections

Ā 

Series of collections the file belongs to

ListField

Ā 

Collections

Collection

Sub field ofĀ Collections providing the ID of an individual the collection the file belongs to

Ā 

Sets

Ā 

Series of sets the file belongs to

ListField

Ā 

Sets

Set

Sub field ofĀ SetsĀ providing the ID of an individual set the file belongs to

Ā 

Newspapers

Ā 

Series of newspapers the file belongs to

ListField

Ā 

Newspapers

Newspaper

Sub field of Newspapers providing the ID of an individual newspaper the file belongs to

Ā 

Relations

Key

Sub Key

Description

Remark

Read-only

Searchable

Key

Sub Key

Description

Remark

Read-only

Searchable

Relations

Ā 

Series of files related with this file. Depending on your installation different sub fields ofĀ Relations might be defined.

MultiItemField

Ā 

Ā 

Relations

PreviousVersion

Sub field ofĀ Relations providing theĀ FragmentId of an individual file which is the previous version of this file

FragmentId

Ā 

Relations

NextVersion

Sub field ofĀ Relations providing theĀ FragmentId of an individual file which is the next version of this file

FragmentId

Ā 

Relations

Contains

Sub field ofĀ Relations providing theĀ FragmentId of an individual file which this file contains

FragmentId

Ā 

Relations

ContainedBy

Sub field ofĀ Relations providing theĀ FragmentId of an individual file that contains this file

FragmentId

Ā 

Relations

Associated

Sub field ofĀ Relations providing theĀ FragmentId of an individual file which is associated with this file

FragmentId

Ā 

Relations

IsSuggestedFor

Points to a record for which a suggestion is made

FragmentId

Ā 

Relations

HasAsSuggestion

Points to a suggestion which is made for this record

FragmentId

Ā 

Field Definition

New since 21.3

Key

Sub

Key

1

Sub

Key

2

Description

Remark

Read-only

Search-

able

Key

Sub

Key

1

Sub

Key

2

Description

Remark

Read-only

Search-

able

FieldDefinition

Ā 

Ā 

Contains a link to a particular field definition described by its dotted key and its long translations

ComplexMapField

Ā 

FieldDefinition

DottedKey

Ā 

The dotted key for the field definition, for example Descriptive.LimitedCategories.Category

SimpleField

FieldDefinition

LongTranslations

Ā 

The label of the field definition in various languages

MapField

Ā 

FieldDefinition

LongTranslations

Nl

Dutch label

SimpleField

Ā 

FieldDefinition

LongTranslations

En

English label

SimpleField

Ā 

FieldDefinition

LongTranslations

Fr

French label

SimpleField

Ā 

Rights Management FieldsĀ 

Rights management fields provide information about who can access, edit or export files.

Key

Sub Key

Description

Remark

Read-only

Search

Key

Sub Key

Description

Remark

Read-only

Search

Permissions

Ā 

The different permissions associated with the file

MultiItemField

Ā 

Ā 

Permissions

Read

Sub field ofĀ Permissions providing ID of a user group with read rights

UUID

Ā 

Permissions

Write

Sub field ofĀ Permissions providing ID of a user group with write rights

UUID

Ā 

Permissions

Export

Sub field ofĀ Permissions providing ID of the user groups with export rights

UUID

Ā 

Zone

Ā 

One of the Zones linked with the record

Ā 

Ā 

Zone

Id

Id of the Zone

UUID

Zone

Name

Name of the Zone

Ā 

ExpiryDate

Ā 

The date the file will expire (at this date the file will be assigned new rights). This field is only for advanced installations.

yyyy:MM:dd'T'HH:mm:ss.uuuuuuZ

Ā 

ExpiryStatus

Ā 

Whether or not the file is expired. This field is only for advanced installations.

Ā 

Ā 

RecordPhase

Ā 

The phase of the record.

  • Concept

  • Published

  • Archived

Record Information

This new family since 22.2 provides additional information about helper records such as UserSuggestion .

Key

Sub Key #1

Sub Key #2

Description

Remark

Read-only

Search

Key

Sub Key #1

Sub Key #2

Description

Remark

Read-only

Search

UserContact

Ā 

Ā 

The different permissions associated with the file

MapField

Ā 

Ā 

UserContact

FirstName

Ā 

The first name of the requested new user

SimpleField

Ā 

Ā 

UserContact

LastName

Ā 

The last name of the requested new user

SimpleField

Ā 

Ā 

UserContact

Email

Ā 

The email of the requested new user

SimpleField

Ā 

UserContact

PasswordHash

Ā 

The password hash of the user, because it is a hidden field, they actual value will never be returned or indexed.

HiddenField

Ā 

Ā 

PreferredLabels

Ā 

Ā 

List of preferred labels of a thesaurus suggestion

ComplexListField

Ā 

Ā 

PreferredLabels

PreferredLabel

Ā 

A single preferred label

MapField

Ā 

Ā 

PreferredLabels

PreferredLabel

Lang

Language of the preferred label

SimpleField

Ā 

Ā 

PreferredLabels

PreferredLabel

Label

The preferred label itself

SimpleField

Ā 

Ā 

AlternativeLabels

Ā 

Ā 

List of alternative labels of a thesaurus suggestion

ComplexListField

Ā 

Ā 

AlternativeLabels

AlternativeLabel

Ā 

A single alternative label

MapField

Ā 

Ā 

AlternativeLabels

AlternativeLabel

Lang

Language of the alternative label

SimpleField

Ā 

Ā 

AlternativeLabels

AlternativeLabel

Label

The alternative label itself

SimpleField

Ā 

Ā 

Changelog

Changes versusĀ Metadata 23.2

  • New field Structural.ChildOrder

Ā