model
The vdf-model
schema defines the content model of
VDF model documents. All VDF payload documents include a reference to a
VDF model document that defines the content and structure of the payload
document.
A VDF model serves two purposes:
-
It defines allowed content and structure for clients constructing a VDF payload document that is to be
POST
ed to the Content Engine web service. -
It provides a key that can be used when parsing a VDF payload document exposed by the Content Engine web service.
VDF model documents (unlike VDF payload documents) are always supplied by the Content Engine - your client should never need to create or modify a model document. This documentation is therefore only intended to help you interpret a VDF model. When a client retrieves a VDF payload document from the Content Engine, it can use the associated VDF model to help parse and/or display the payload correctly. When creating or modifying a payload document, the associated model document can be used as a guide to ensure that the payload document is correctly structured.
Namespace URI
The namespace URI of the model
schema is http://www.vizrt.com/types
.
Root Element
The root of a
model
file must be a
model
element.