Classification Metadata Sidecar
- Bart Quintens
- Alexis Rombaut
- An De Moor
This feature is available from 25.2
Introduction
This feature allows you to request a specific sidecar XSD for a classification. The generated XSD will have additional fields under the family Dynamic based upon the linked https://mediahaven.atlassian.net/wiki/spaces/CS/pages/3273949212. This XSD can then be used to validate your XML before ingesting.
XSD
The classification XSD has the same purpose as the Metadata Sidecar with namespace “mhs” but contains also a specification for the dynamic fields by referring to another XSD with namespace “mhd”. The namespace “mhd” has the same purpose as the namespace “mh” which contains the definition for each standard metadata field, whereas the “mhd” contains the definition for each applicable dynamic metadata field and all fields of type enum. The enum fields are restricted in this XSD to there allowed values.
Examples
Requesting
There are 2 ways to request the XSD.
Classification is publicly accessible
Requesting the XSD can be done by sending a request to
https://<environment>/schemas/<schema version>/classifications/<classification or versioning id>/version/<version>/mhs.xsdhttps://<environment>/schemas/<schema version>/classifications/<classification or versioning id>/version/<version>/record-type/<record type>/mhs.xsd
Property | Description | Example |
|---|---|---|
Schema version | The schema version corresponds with Metadata Sidecar Versions |
|
Classification or versioning ID | Classification or versioning ID of the record for which you want to request the XSD |
|
Version | Version is 1 if the classification is not versioned or different if your classification has multiple versions | 1 |
Record type | The record type is an optional property and can be added only to get the fields applicable for the specified record type. | Media |
Variant | Indicates whether to return the mhs or mhd variant. |
|
Classification is not publicly accessible
In this case, you can request the XSD via the API under classifications/<classification id>/schema. See the rest of the API documentation for additional properties and documentation.