Schema Reference
one honest source for entity ids, classifications, and field shapes
Schema Reference
Entities
| entity | title | contentDefinitionId | classification | searchable |
|---|---|---|---|---|
adContentTypes | Ad Content Types | 1486bcb7-1668-41d0-b3be-fd273d56d808 | default-crud | no |
annotation | Annotation | 7044ae27-1fd6-4de5-b5c3-b5ca6c152d25 | default-readonly | yes |
anonymousUpload | - | b7c4f2a1-9e3d-4b85-a6c2-0d1e7f8a3b94 | default-crud | no |
asset | Asset | 3ff29f61-bd0b-4c17-b855-49db5a292aeb | default-readonly | yes |
assetDownloadQueue | - | 8f7f6d41-f32a-46d4-a1b4-09b8b507dd01 | default-readonly | yes |
assetView | Asset Views | 7f4a8c2b-d1e3-4f5a-9b6c-8d0e2f1a0b3c | default-crud | no |
collection | Collection | 20352932-05d2-4a7a-8821-06fcf4438ced | default-readonly | yes |
contentComment | ContentComment | 70bd0dba-0d79-419b-a290-a329ee5cd266 | default-readonly | yes |
contentDefinition | Content Definition | 2ec6e264-9171-45a4-8e00-7f5fd7a4dfdb | default-crud | no |
contentGroup | Content Group | 615d1d21-f602-4c24-a4d8-3e1dda6666d4 | default-readonly | yes |
contentRating | Content Rating | dd72aac1-a5a2-4b68-a59c-9f57e5858517 | default-crud | no |
contentVector | Content Vector | e3a1c2d4-f5b6-7890-abcd-ef1234567890 | default-crud | no |
cors | Cors | 6921f6d2-0e1a-4ac3-b746-46b46bc95f72 | default-crud | no |
country | Country | ed1edc64-21a5-413e-8cf6-a21285d51e7f | default-crud | no |
currency | Currency | 944589ee-7074-4ad8-83f1-79e590523749 | default-crud | no |
dayOfWeek | Day Of Week | fc8042c1-1ade-400d-b0aa-02937e658ae6 | default-crud | no |
dynamicContent | Dynamic Content | 1738561d-64c6-451a-a6f8-6f29e5e9166e | default-crud | no |
episode | Episode | 03c22d5f-b5a9-4c31-b46f-ece15be01d25 | default-crud | no |
event | Event | 412a30e3-73ee-4eae-b739-e1fc87601c7d | default-crud | no |
eventDefaults | Event Defaults | 22b1f8cf-ce0a-404b-8cef-eb3202e5a36a | default-crud | no |
eventType | Event Type | 0ee492a3-7875-4288-8690-f9895a44cb43 | default-crud | no |
featuredGroup | Featured Group | a33d1db2-b3ec-478b-8b14-48c813e7153e | default-crud | no |
featuredGroupType | Featured Group Type | b6f4db5c-3de0-4ba5-b0ab-d116bedc547a | default-crud | no |
genre | Genre | dbbace1f-ddb1-462b-9cae-c9be7d5990ac | default-crud | no |
hero | Hero | 5fdb58f8-35cd-4759-aadd-835b9f37eefa | default-crud | no |
history | History | 0957c759-a24f-4403-a4e6-d8ba371164e6 | default-readonly | yes |
journal | Journal | 5cdfed06-75eb-4e43-9152-bdfc0a0e44ef | default-readonly | yes |
label | Label | fc710473-d014-4b2a-b812-c98255e32046 | default-readonly | yes |
language | Language | e4b10c04-1878-4830-a115-e42d52705059 | default-crud | no |
liveChannel | - | bf8ac754-5b8b-4330-b1aa-76f15fb7f673 | default-readonly | yes |
liveInput | - | 5ce6e254-01e9-44b8-9f20-4691140db3ce | default-readonly | yes |
liveOutputProfile | - | 9861e91b-cc08-475f-95c6-dcf7adbbe9b0 | default-readonly | yes |
liveOutputProfileGroup | - | 53c99474-e71f-4598-8e55-2cfa5850b90d | default-readonly | yes |
liveSchedule | - | ccfc19a7-9736-4fd1-bf83-71b1fb3ce9f0 | default-readonly | yes |
mediaAttribute | Media Attribute | ada6d0f1-98ba-4248-ba14-8386fa14e497 | default-crud | no |
mediaAttributeType | Media Attribute Type | 05ce71f9-bd91-4af4-a432-17a065fd5b9b | default-crud | no |
mediaGroup | Media Group | 671b7f0c-90af-4ef7-b8f9-8d16d495e11c | default-crud | no |
mediaGroupMenuItem | Media Group Menu Item | 6940bf43-22ed-4ddc-ba7d-c2424ac891d0 | default-crud | no |
mediaTag | Media Tag | 3191ccd6-19d0-4b5a-af38-94d39555a7de | default-crud | no |
newsStory | News Story | f696121d-c6b9-4bf1-8cad-baacc52ed363 | default-readonly | yes |
organization | Organization | 0d747415-f92b-4aa2-bb38-ab11d3af2b63 | default-crud | no |
performer | Performer | 33cec5ca-6170-4237-842b-78bf1ef17932 | default-crud | no |
performerType | Performer Type | c1dd841c-7de9-4e10-8564-02838d39795e | default-crud | no |
person | Person | 24f45337-988a-4ca6-b2d7-d06d865e42c5 | default-readonly | yes |
playlist | Playlist | d77bf165-33e7-4002-9c58-3c9874acf187 | default-crud | no |
productPrice | Product Price | 8c8bd6e3-bad4-4f63-ac61-0c45b40b1a02 | default-crud | no |
role | Role | 0c32db1f-35ab-41ce-b6b6-5d87e8ae478b | default-crud | no |
savedSearch | Saved Search | e8002404-0434-4917-98df-1a3b5505c0d3 | default-crud | no |
season | Season | 58922a6f-6a9e-41d6-95c4-4d27f932b34e | default-crud | no |
securityGroup | Security Group | 5a91bebb-05c5-4e11-ab8d-48f5a6dd93c0 | default-crud | no |
series | Series | 9c1713ce-006c-4dc7-afb6-028df1fb3bf3 | default-crud | no |
share | Share | 94f3eb54-9c9a-4d7f-a24b-d2bba36916d5 | default-readonly | yes |
shareContent | Share Content | 289f416a-1fe2-4c9a-95ff-2896c6553021 | default-readonly | yes |
siteConfig | Site Config | f6e753fc-5150-4328-b4e8-ad11f8fd794a | default-crud | no |
state | State | 066fa41a-ec24-486c-81fd-a43085064870 | default-crud | no |
statistic | Statistic | ba50c2a4-ff98-49ba-87c5-34e9c0c12119 | default-readonly | yes |
tag | Tag | c806783c-f127-48ae-90c9-32175f4e1fff | default-readonly | yes |
timeZone | Time Zone | 6ffc9376-af95-4f70-864e-1b00b8f8a283 | default-crud | no |
user | User | b42cb50a-1664-4b68-a8f8-2272b9b13e7c | default-readonly | yes |
userBehaviorEvent | User Behavior Event | 8f3c4d5e-6a7b-4c9d-8e1f-2a3b4c5d6e7f | default-crud | no |
userBehaviorProfile | User Behavior Profile | 9a4b5c6d-7e8f-4a1b-9c2d-3e4f5a6b7c8d | default-crud | no |
userContentGroup | User Content Group | babd166f-3b5f-426e-a594-bc07ac20dbc8 | default-readonly | yes |
userStatus | User Status | 7cd8e9e6-4bd4-471b-906a-965b2ab0e9aa | default-crud | no |
venue | Venue | 7684c940-6532-44f9-bc7f-6d7d7da72c2f | default-crud | no |
video | Video | 22470571-8d03-4b04-b8dc-4f7e91aa57d4 | default-crud | no |
videoType | Video Type | 9d84b2fd-fee0-47d8-9036-f9726c007927 | default-crud | no |
workflowStatus | - | 1a57fecb-ecb7-4cc3-a914-6ce5dc9d60b1 | default-readonly | yes |
In-scope entity fields
asset - Asset
asset - AssetThe Asset entity - a single piece of content (an uploaded file, a folder, or a storage bucket) and the central searchable object in the platform. Its stored metadata is captured in the asset manifest.
| field | type | searchable | writable | description |
|---|---|---|---|---|
assetStatus | enum AssetStatus | no | yes | Lifecycle status of the asset; one of Available, Renaming, Copying, Restoring, Registering, Uploading, Archiving, Archived, PendingArchive, PendingRestore, Restored, Deleting, Moving, SlugReplaced, Updating, Error, Assembling, Clipping, Placeholder, Creating, Replacing. A fully ingested, ready asset is Available. |
assetType | enum AssetType | no | yes | What kind of node this is; one of Folder, File, Bucket. In the sample manifests an uploaded media file (mp4/mxf/mp3/jpg) has assetType 2 (File); folders and storage buckets use the other values. |
assetTypeDisplay | string | yes | no | The assetType as a human-readable string (e.g. "File" for an uploaded mp4, mxf, mp3 or jpg). |
assignedPerson | object | yes | no | The person (e.g. owner or assigned talent) associated with the asset, as an embedded object. |
audioBitRateDisplay | string | yes | no | Human-readable audio bit rate of the asset's audio track (e.g. "125 KBps" for the AAC audio in the mp4 sample, "1 MBps" for the PCM audio in the mxf). Empty for assets with no audio such as a jpg. |
audioDuration | string | yes | no | Length of the audio track as an SMPTE timecode HH-MM-SS;FF (e.g. "00:00:11;17"). Present only for assets that contain audio. |
audioDurationDisplay | string | yes | no | Human-readable audio duration (e.g. "11 sec"). Present only for assets that contain audio. |
author | string | yes | no | Free-text author or creator credit for the asset. |
availability | object | yes | no | Publishing-availability window for the asset (start/end and related rules), as an embedded object. |
canSimilarSearch | boolean | yes | no | Whether the asset has vector embeddings enabling find-similar search. |
collections | list | no | yes | GUIDs of the collections this asset belongs to. |
contentLength | int64 | no | yes | Size of the original uploaded file in bytes (e.g. 10431775 for the ~10 MB mp4 sample, 118112876 for the ~113 MB mxf). |
contentLengthDisplay | string | yes | no | Human-readable file size (e.g. "9.9 MB" for the mp4 sample, "112.6 MB" for the mxf). |
createdDate | date-time | no | yes | UTC timestamp when the asset was created/ingested (e.g. "2026-05-19T07:10:22.192Z"). |
createdUserId | guid | no | yes | GUID of the user who created the asset. |
createdUserName | - | no | yes | Display name of the user who created the asset (string). |
dashVideoFullUrl | string | yes | no | Fully-qualified (absolute/CDN) URL of the MPEG-DASH stream for the asset's video. |
dashVideoUrl | string | yes | no | Storage-relative URL of the MPEG-DASH stream for the asset's video. |
dashWithAdsVideoFullUrl | string | yes | no | Fully-qualified URL of the MPEG-DASH stream with server-side ad insertion. |
dashWithAdsVideoUrl | string | yes | no | Storage-relative URL of the MPEG-DASH stream with server-side ad insertion. |
dislikedCount | int64 | no | yes | Number of users who have disliked the asset. |
displayDate | date-time | no | yes | Editorial display date for the asset (UTC), used for sorting/presentation rather than the ingest time. |
displayName | - | no | yes | Human-friendly display name of the asset (string). |
displayPath | string | yes | no | Human-readable folder path of the asset within its bucket. |
embedCode | string | yes | no | HTML embed snippet for sharing the asset in an external page. |
favoriteCount | int64 | no | yes | Number of users who have favorited the asset. |
fileExtension | string | yes | no | Original file extension without the dot (e.g. "mp4", "mxf", "mp3", "jpg"). |
fullUrl | string | yes | no | Fully-qualified (absolute/CDN) URL to the original asset content. |
geoData | object | yes | no | Geographic metadata (e.g. capture location read from image EXIF) as an embedded object. |
hasFaces | boolean | yes | no | Whether face detection found one or more faces in the asset. |
hasLabels | boolean | yes | no | Whether AI/auto labels have been applied to the asset. |
hasRelatedAssets | boolean | yes | no | Whether the asset has related/derived assets such as proxies or sidecar metadata (the samples carry relatedVideos, relatedImages and relatedAudio). |
hasSubtitles | boolean | yes | no | Whether the asset has subtitle/caption tracks. |
hasTextAndPhrases | boolean | yes | no | Whether speech-to-text transcription (text and phrases) exists for the asset. |
hlsVideoFullUrl | string | yes | no | Fully-qualified (absolute/CDN) URL of the HLS stream for the asset's video. |
hlsVideoUrl | string | yes | no | Storage-relative URL of the HLS stream for the asset's video. |
hlsWithAdsVideoFullUrl | string | yes | no | Fully-qualified URL of the HLS stream with server-side ad insertion. |
hlsWithAdsVideoUrl | string | yes | no | Storage-relative URL of the HLS stream with server-side ad insertion. |
id | guid | no | yes | GUID uniquely identifying the asset; matches the manifest assetId (e.g. "db30531d-dda7-4d1a-bf7b-30d691058806" for the mp4 sample). |
indexedDate | date-time | yes | no | UTC timestamp when the asset was last (re)indexed for search. |
inheritSecurity | - | no | yes | Whether the asset inherits its permissions from its parent folder or bucket (boolean). |
isDeepSearch | boolean | yes | no | Whether deep (content-level) search is enabled for the asset. |
isPublicUrl | boolean | yes | no | Whether the asset is served from a public, unauthenticated URL. |
languageId | guid | no | yes | GUID of the asset's primary language (e.g. the English language record in the samples). |
lastMessage | - | no | yes | Most recent processing/status message for the asset (string). |
lastModifiedDate | date-time | no | yes | UTC timestamp of the asset's most recent modification. |
lastModifiedUserId | guid | no | yes | GUID of the user who last modified the asset. |
lastModifiedUserName | - | no | yes | Display name of the user who last modified the asset (string). |
likedCount | int64 | no | yes | Number of users who have liked the asset. |
manifestBucketName | - | no | yes | Name of the storage bucket holding the asset's metadata manifest (string). |
manifestObjectKey | - | no | yes | Object key (path) of the asset's metadata manifest within the manifest bucket (string). |
mobiusLabsAanaSubmitDate | date-time | yes | no | UTC timestamp when the asset was submitted to Mobius Labs AANA for AI auto-tagging. |
name | - | no | yes | Name of the asset, typically derived from the original file name without its extension (string; the mp4 sample's source object key was "Content/Adam/test 6.mp4"). |
nameLower | string | yes | no | Lower-cased copy of the asset name, used for case-insensitive search and sorting. |
parentId | guid | no | yes | GUID of the asset's parent folder or bucket. |
parents | array | yes | no | Ordered ancestor folders/buckets up to the root, as embedded objects. |
persons | array | yes | no | People (talent, performers, detected faces) associated with the asset. |
playerFullUrl | string | yes | no | Fully-qualified URL of the hosted player page for the asset. |
playerUrl | string | yes | no | Storage-relative URL of the hosted player page for the asset. |
processingStage | int32 | no | yes | Numeric code for the asset's current ingest/processing stage. |
publicExpirationDate | date-time | no | yes | UTC timestamp after which the asset's public URL stops working. |
relatedAudio | array | yes | no | Derived audio renditions of the asset (e.g. the generated MP3 audio proxy in the mp4 and mxf samples). |
relatedContent | list | no | yes | GUIDs of other assets manually related to this one. |
relatedVideos | array | yes | no | Derived video renditions of the asset (e.g. the MP4 proxy transcode and original source video in the samples). |
renderedImages | array | yes | no | Generated still images for the asset (e.g. the preview and thumbnail screenshots in the samples). |
securityGroups | list | no | yes | GUIDs of the security groups granted access to the asset. |
securityUsers | list | no | yes | GUIDs of the individual users granted access to the asset. |
storageClass | enum StorageClass | no | yes | S3 storage tier of the original file; one of Standard, ReducedRedundancy, Glacier, StandardInfrequentAccess, OneZoneInfrequentAccess, IntelligentTiering, DeepArchive, GlacierInstantRetrieval, Outposts. In the samples the freshly-uploaded mp4 is Standard while the archived mxf/mp3/jpg use IntelligentTiering. |
subtitleUrls | array | yes | no | URLs of the asset's subtitle/caption files. |
tags | list | no | yes | GUIDs of the media tags applied to the asset. |
textCaptions | array | yes | no | Time-coded caption/transcript segments for the asset. |
thumbnailTrackFullUrl | string | yes | no | Fully-qualified URL of the thumbnail (sprite) track used for scrub-bar previews. |
thumbnailTrackUrl | string | yes | no | Storage-relative URL of the thumbnail (sprite) track used for scrub-bar previews. |
topLevelFolder | boolean | yes | no | Whether the asset is a top-level folder directly under its bucket. |
twitterSite | string | yes | no | Twitter handle used in the asset's social/Open-Graph share card. |
url | - | no | yes | Storage location of the original asset content in bucket::objectKey form (string; built from the manifest originalBucketName and originalObjectKey). |
vectorChunkCount | int32 | no | yes | Number of vector-embedding chunks generated for the asset; drives similar/semantic search. |
versionNumber | int32 | no | yes | Monotonic version counter incremented each time the asset is updated. |
videoBitRateDisplay | string | yes | no | Human-readable video bit rate of the asset's video track (e.g. "7 MBps" for the AVC mp4 sample, "33 MBps" for the MPEG mxf). Empty for non-video assets such as a jpg or mp3. |
videoDimensions | string | yes | no | Pixel dimensions of the video as WIDTHxHEIGHT (e.g. "1920x1080" for the HD samples). |
videoDuration | string | yes | no | Length of the video track as an SMPTE timecode HH-MM-SS;FF (e.g. "00:00:11;12"). Present only for video assets. |
videoDurationDisplay | string | yes | no | Human-readable video duration (e.g. "11 sec" for the mp4 sample, "40 sec" for the mxf). Present only for video assets. |
videoTimeCode | string | yes | no | Starting timecode of the first video frame (e.g. "00:00:54.767" from the mxf sample's timeCodeFirstFrame). |
event - Event
event - EventThe Event entity.
| field | type | searchable | writable | description |
|---|---|---|---|---|
disabled | boolean | yes | yes | Is Disabled (boolean). |
endDatetime | time | yes | yes | End Date/Time (time). |
eventDate | time | yes | yes | Event Date (time). |
eventStatus | guid | yes | yes | Status (guid). |
eventType | guid | yes | yes | Event Type (guid). |
externalUrl | Short Text | yes | yes | External URL (Short Text). |
featuredGroups | guid | yes | yes | Featured Groups (guid). |
genres | guid | yes | yes | Genres (guid). |
groupSequence | int64 | yes | yes | Group Sequence (int64). |
hero | guid | yes | yes | Hero (guid). |
intelligentProgram | guid | yes | yes | Intelligent Program (guid). |
languages | guid | yes | yes | Languages (guid). |
liveChannel | guid | yes | yes | Live Channel (guid). |
logoImage | guid | yes | yes | Logo Image (guid). |
longDescription | Long Text | yes | yes | Long Description (Long Text). |
mediaAttributes | guid | yes | yes | Media Attributes (guid). |
name | Short Text | yes | yes | Name (Short Text). |
overrideSeriesDetails | boolean | yes | yes | Override Series Details (boolean). |
performers | guid | yes | yes | Performers (guid). |
primaryPerformer | guid | yes | yes | Primary Performer (guid). |
products | guid | yes | yes | Products (guid). |
recommendationSimilarItems | guid | yes | yes | Recommendation Similar Items (guid). |
relatedMediaItems | guid | yes | yes | Related Media Items (guid). |
series | guid | yes | yes | Series (guid). |
shortDescription | Short Text | yes | yes | Short Description (Short Text). |
slug | Short Text | yes | yes | Slug (Short Text). |
startDatetime | time | yes | yes | Start Date/Time (time). |
statusMessage | Short Text | yes | yes | Status Message (Short Text). |
thumbnailImage | guid | yes | yes | Thumbnail Image (guid). |
venue | guid | yes | yes | Venue (guid). |
eventType - Event Type
eventType - Event TypeThe Event Type entity.
| field | type | searchable | writable | description |
|---|---|---|---|---|
name | Short Text | yes | yes | Name (Short Text). |
sortOrder | int64 | yes | yes | Sort Order (int64). |
venue - Venue
venue - VenueThe Venue entity.
| field | type | searchable | writable | description |
|---|---|---|---|---|
address | Short Text | yes | yes | Address (Short Text). |
city | Short Text | yes | yes | City (Short Text). |
country | guid | yes | yes | Country (guid). |
disabled | boolean | yes | yes | Disabled (boolean). |
heroImage | guid | yes | yes | Hero Image (guid). |
name | Short Text | yes | yes | Name (Short Text). |
slug | Short Text | yes | yes | Slug (Short Text). |
stateId | guid | yes | yes | State (guid). |
stateName | Short Text | yes | yes | State Name (Short Text). |
thumbnailImage | guid | yes | yes | Thumbnail Image (guid). |
Updated about 2 months ago
Did this page help you?
