Data: ns2
- Namespace: http://opencase.extend.com/cm
The data in this namespace is divided into elements and types. Types define the structure of the data. Elements define specific instances of the types, and are therefore more relevant to REST endpoints, which generally consume and/or produce elements.
The following elements are members of this namespace:
The following types are members of this namespace:
- AbstractCDSISURLSignerSettings
- AbstractEidrIdentifier
- AbstractPhysicalAssetVideo
- AbstractType
- AdInsertionPoint
- AdSlotSet
- Advisory
- Affiliate
- AssetFormat
- AssetSchedule
- AudioLanguage
- BindProfile
- BulkEditableField
- BulkEditOperation
- BulkEditOperationType
- Bundle
- BundleClassification
- BundleFolder
- BundleFolderType
- BundleItem
- BundleReference
- BundleSearchFilter
- BundleSort
- BundleSortField
- BundleType
- BundleTypeDTO
- BundleTypeItem
- bundleValidation
- bundleValidations
- CatalogAttribute
- Category
- CDSISURLSignerSettingsPublicKey
- CDSISURLSignerSettingsSymmetric
- Charge
- ChargeType
- ClassificationAttribute
- ClassificationNodeAttribute
- ClassificationReference
- ClassificationType
- ClickThrough
- CommonEntities
- CommonEntity
- CommonEntityExtraInfo
- CommonEntitySort
- CommonEntitySortField
- CommonEntityType
- Component
- ComponentSort
- ComponentSortField
- ComponentSourceXml
- ComponentType
- ComponentUpdateRule
- ContentManagerGenericPlugin
- Currency
- CustomAttribute
- CustomAttributeClob
- CustomAttributeDate
- CustomAttributeDbl
- CustomAttributeInt
- CustomAttributeMultipleValueDbl
- CustomAttributeMultipleValueInt
- CustomAttributeMultipleValueStr
- CustomAttributeStr
- Domain
- DrmProfile
- DrmTermsSet
- DrmType
- DrmTypeDomain
- DrmTypeInteroperableDomain
- EidrAlternativeIdentifier
- EidrAlternativeIdentifierType
- EidrCollectionIdentifier
- EidrIdentifier
- EidrProgramIdentifier
- EntitlementCheck
- EntitlementCheckMapping
- EntitlementProfile
- EvaluationType
- generationType
- Genre
- HierarchicalCategory
- Identifier
- ImageProfile
- ImageType
- IsanDocument
- IsanGame
- IsanVideo
- LicenseRequestInfo
- LicensingWindow
- Locale
- Metadata
- MetadataAlbum
- MetadataApp
- MetadataAudio
- MetadataAvailabilityWindow
- MetadataCatalog
- MetadataChapter
- MetadataClassification
- MetadataClassificationNode
- MetadataDocument
- MetadataDvd
- MetadataImage
- MetadataShow
- MetadataStation
- MetadataVideo
- MetadataVideoCommon
- OfferType
- OfferTypeEnum
- OfferWindow
- OfferWindowOptions
- OfferWindowValue
- opencase
- OriginMapping
- ParentReference
- Person
- PhysicalAsset
- PhysicalAssetApp
- PhysicalAssetAudio
- PhysicalAssetDocument
- PhysicalAssetImage
- PhysicalAssetManifest
- PhysicalAssetSubtitle
- PhysicalAssetVideo
- PlayReadyDomain
- PlayReadyDownload
- PlayReadyStreaming
- Policy
- PriceCategory
- Product
- ProductLifecycleMetadata
- ProductResolutionPlugin
- ProgramIdentifier
- Provider
- Rating
- RatingFilterData
- RenderHint
- ResourceKey
- ResourceLabel
- RestrictTo
- Schedule
- SearchBundleResult
- SearchCommonEntityResult
- SearchComponentResult
- SearchProductResult
- StationIdentifier
- Studio
- Style
- SubscriptionCode
- SubscriptionPolicy
- SubtitleLanguage
- Talent
- TalentRole
- TargetDevice
- TribuneMediaServiceProgramIdentifier
- TribuneMediaServiceStationIdentifier
- TypeDiscriminator
- UrlSigner
- UrlSignerConfiguration
- URLSignerSettings
- WidevineDrmTerms
- WmrmDrmTerms
- XlsParserConfig
Element entityChangeQueueData
- Type: entityChangeQueueData
This class is used to represent XML placed into data field of an entity change queue item. An entity change queue plug-in maymarshall/unmarshall data XML to retrieve/save extra data about entity change queue item. This is useful if an entity change queue plug-ininvokes a long running process. Saving a bookmark intermittently during process provides plug-in with ability to start processing again fromthe bookmark in the event of a failure.
Example XML
<?xml version="1.0" encoding="UTF-8"?><entityChangeQueueData xmlns="http://opencase.extend.com/cm"> <lastComponentPk>...</lastComponentPk></entityChangeQueueData>
Element locale
- Type: localeJaxbWrapper
Example XML
<?xml version="1.0" encoding="UTF-8"?><locale xmlns="http://opencase.extend.com/cm"> <localePk>...</localePk> <language>...</language> <country>...</country> <uuid>...</uuid></locale>
Element PhysicalAssetImage
Example XML
<?xml version="1.0" encoding="UTF-8"?><PhysicalAssetImage xmlns="http://opencase.extend.com/cm"> <height>...</height> <width>...</width> <displayAspectRatio>...</displayAspectRatio> <encodingType>...</encodingType> <tier>...</tier> <locale> <localePk>...</localePk> <language>...</language> <country>...</country> <uuid>...</uuid> </locale> <imageTypes> <imageType> <imageKey>...</imageKey> <name>...</name> <isStbViewRequired>...</isStbViewRequired> <commonEntityPk>...</commonEntityPk> <uuid>...</uuid> <applyToAllLocales>...</applyToAllLocales> <locales> <localePk>...</localePk> <language>...</language> <country>...</country> <uuid>...</uuid> </locales> <locales> <!--...--> </locales> <!--...more "locales" elements...--> <externalID>...</externalID> <customAttributes> <customAttribute> <customAttributePk>...</customAttributePk> <discriminator>...</discriminator> <customAttributeTypeName>...</customAttributeTypeName> <uuid>...</uuid> <customAttributeTypeIdentifier>...</customAttributeTypeIdentifier> </customAttribute> <customAttribute> <!--...--> </customAttribute> <!--...more "customAttribute" elements...--> </customAttributes> <resourceKey> <resourceKeyPk>...</resourceKeyPk> <key>...</key> <resourceLabels> <resourceLabel> <resourceLabelPk>...</resourceLabelPk> <label>...</label> <language>...</language> </resourceLabel> <resourceLabel> <!--...--> </resourceLabel> <!--...more "resourceLabel" elements...--> </resourceLabels> </resourceKey> <orderNumber>...</orderNumber> <extraInfos> <extraInfo> <extraInfoPK>...</extraInfoPK> <content>...</content> <uuid>...</uuid> </extraInfo> <extraInfo> <!--...--> </extraInfo> <!--...more "extraInfo" elements...--> </extraInfos> </imageType> <imageType> <!--...--> </imageType> <!--...more "imageType" elements...--> </imageTypes> <url>...</url> <cdnURL>...</cdnURL> <publicUrl>...</publicUrl> <publicCdnUrl>...</publicCdnUrl> <tokenizedUrl>...</tokenizedUrl> <checkSum>...</checkSum> <fileSize>...</fileSize> <mimeType>...</mimeType> <pcFileName>...</pcFileName> <deviceGroup>...</deviceGroup> <isEncrypted>...</isEncrypted> <encryptionData>...</encryptionData> <encryptionImplementationTechnology>...</encryptionImplementationTechnology> <licenseRequestData>...</licenseRequestData> <contentID>...</contentID> <mosContentID>...</mosContentID> <isSourceAsset>...</isSourceAsset> <contentFileUUID>...</contentFileUUID> <originBaseURL>...</originBaseURL> <originResourceURL>...</originResourceURL> <deleteURL>...</deleteURL> <keySetID>...</keySetID> <isSignedByOriginMapping>...</isSignedByOriginMapping> <urlSignerConfiguration> <urlSignerConfigurationPk>...</urlSignerConfigurationPk> <name>...</name> <uuid>...</uuid> <urlSigner> <urlSignerPk>...</urlSignerPk> <description>...</description> <name>...</name> <urlSignerSettingsClass>...</urlSignerSettingsClass> <urlSignerClass>...</urlSignerClass> <uuid xmlns="">...</uuid> </urlSigner> <isActive>...</isActive> <isEnabled>...</isEnabled> <lastModified>...</lastModified> <urlSignerSettingsObject /> </urlSignerConfiguration> <targetDevices> <targetDevice> <name>...</name> <manufacturer>...</manufacturer> <type>...</type> <os>...</os> <minOSVersion>...</minOSVersion> <maxOSVersion>...</maxOSVersion> <commonEntityPk>...</commonEntityPk> <uuid>...</uuid> <applyToAllLocales>...</applyToAllLocales> <locales> <localePk>...</localePk> <language>...</language> <country>...</country> <uuid>...</uuid> </locales> <locales> <!--...--> </locales> <!--...more "locales" elements...--> <externalID>...</externalID> <customAttributes> <customAttribute> <customAttributePk>...</customAttributePk> <discriminator>...</discriminator> <customAttributeTypeName>...</customAttributeTypeName> <uuid>...</uuid> <customAttributeTypeIdentifier>...</customAttributeTypeIdentifier> </customAttribute> <customAttribute> <!--...--> </customAttribute> <!--...more "customAttribute" elements...--> </customAttributes> <resourceKey> <resourceKeyPk>...</resourceKeyPk> <key>...</key> <resourceLabels> <resourceLabel> <resourceLabelPk>...</resourceLabelPk> <label>...</label> <language>...</language> </resourceLabel> <resourceLabel> <!--...--> </resourceLabel> <!--...more "resourceLabel" elements...--> </resourceLabels> </resourceKey> <orderNumber>...</orderNumber> <extraInfos> <extraInfo> <extraInfoPK>...</extraInfoPK> <content>...</content> <uuid>...</uuid> </extraInfo> <extraInfo> <!--...--> </extraInfo> <!--...more "extraInfo" elements...--> </extraInfos> </targetDevice> <targetDevice> <!--...--> </targetDevice> <!--...more "targetDevice" elements...--> </targetDevices> <assetFormats> <assetFormat> <name>...</name> <commonEntityPk>...</commonEntityPk> <uuid>...</uuid> <applyToAllLocales>...</applyToAllLocales> <locales> <localePk>...</localePk> <language>...</language> <country>...</country> <uuid>...</uuid> </locales> <locales> <!--...--> </locales> <!--...more "locales" elements...--> <externalID>...</externalID> <customAttributes> <customAttribute> <customAttributePk>...</customAttributePk> <discriminator>...</discriminator> <customAttributeTypeName>...</customAttributeTypeName> <uuid>...</uuid> <customAttributeTypeIdentifier>...</customAttributeTypeIdentifier> </customAttribute> <customAttribute> <!--...--> </customAttribute> <!--...more "customAttribute" elements...--> </customAttributes> <resourceKey> <resourceKeyPk>...</resourceKeyPk> <key>...</key> <resourceLabels> <resourceLabel> <resourceLabelPk>...</resourceLabelPk> <label>...</label> <language>...</language> </resourceLabel> <resourceLabel> <!--...--> </resourceLabel> <!--...more "resourceLabel" elements...--> </resourceLabels> </resourceKey> <orderNumber>...</orderNumber> <extraInfos> <extraInfo> <extraInfoPK>...</extraInfoPK> <content>...</content> <uuid>...</uuid> </extraInfo> <extraInfo> <!--...--> </extraInfo> <!--...more "extraInfo" elements...--> </extraInfos> </assetFormat> <assetFormat> <!--...--> </assetFormat> <!--...more "assetFormat" elements...--> </assetFormats> <ratings> <rating> <ratingName>...</ratingName> <ratingBody>...</ratingBody> <reason>...</reason> <commonEntityPk>...</commonEntityPk> <uuid>...</uuid> <applyToAllLocales>...</applyToAllLocales> <locales> <localePk>...</localePk> <language>...</language> <country>...</country> <uuid>...</uuid> </locales> <locales> <!--...--> </locales> <!--...more "locales" elements...--> <externalID>...</externalID> <customAttributes> <customAttribute> <customAttributePk>...</customAttributePk> <discriminator>...</discriminator> <customAttributeTypeName>...</customAttributeTypeName> <uuid>...</uuid> <customAttributeTypeIdentifier>...</customAttributeTypeIdentifier> </customAttribute> <customAttribute> <!--...--> </customAttribute> <!--...more "customAttribute" elements...--> </customAttributes> <resourceKey> <resourceKeyPk>...</resourceKeyPk> <key>...</key> <resourceLabels> <resourceLabel> <resourceLabelPk>...</resourceLabelPk> <label>...</label> <language>...</language> </resourceLabel> <resourceLabel> <!--...--> </resourceLabel> <!--...more "resourceLabel" elements...--> </resourceLabels> </resourceKey> <orderNumber>...</orderNumber> <extraInfos> <extraInfo> <extraInfoPK>...</extraInfoPK> <content>...</content> <uuid>...</uuid> </extraInfo> <extraInfo> <!--...--> </extraInfo> <!--...more "extraInfo" elements...--> </extraInfos> </rating> <rating> <!--...--> </rating> <!--...more "rating" elements...--> </ratings> <assetClassification>...</assetClassification> <providers> <provider> <providerName>...</providerName> <commonEntityPk>...</commonEntityPk> <uuid>...</uuid> <applyToAllLocales>...</applyToAllLocales> <locales> <localePk>...</localePk> <language>...</language> <country>...</country> <uuid>...</uuid> </locales> <locales> <!--...--> </locales> <!--...more "locales" elements...--> <externalID>...</externalID> <customAttributes> <customAttribute> <customAttributePk>...</customAttributePk> <discriminator>...</discriminator> <customAttributeTypeName>...</customAttributeTypeName> <uuid>...</uuid> <customAttributeTypeIdentifier>...</customAttributeTypeIdentifier> </customAttribute> <customAttribute> <!--...--> </customAttribute> <!--...more "customAttribute" elements...--> </customAttributes> <resourceKey> <resourceKeyPk>...</resourceKeyPk> <key>...</key> <resourceLabels> <resourceLabel> <resourceLabelPk>...</resourceLabelPk> <label>...</label> <language>...</language> </resourceLabel> <resourceLabel> <!--...--> </resourceLabel> <!--...more "resourceLabel" elements...--> </resourceLabels> </resourceKey> <orderNumber>...</orderNumber> <extraInfos> <extraInfo> <extraInfoPK>...</extraInfoPK> <content>...</content> <uuid>...</uuid> </extraInfo> <extraInfo> <!--...--> </extraInfo> <!--...more "extraInfo" elements...--> </extraInfos> </provider> <provider> <!--...--> </provider> <!--...more "provider" elements...--> </providers> <componentPk>...</componentPk> <name>...</name> <altCode>...</altCode> <externalID>...</externalID> <externalVersion>...</externalVersion> <assetID>...</assetID> <createDate>...</createDate> <lastModified>...</lastModified> <uuid>...</uuid> <ciid>...</ciid> <versionNumber>...</versionNumber> <sourceAssetID>...</sourceAssetID> <generationType>...</generationType> <customAttributes> <customAttribute> <customAttributePk>...</customAttributePk> <discriminator>...</discriminator> <customAttributeTypeName>...</customAttributeTypeName> <uuid>...</uuid> <customAttributeTypeIdentifier>...</customAttributeTypeIdentifier> </customAttribute> <customAttribute> <!--...--> </customAttribute> <!--...more "customAttribute" elements...--> </customAttributes> <componentSourceXml> <sourceXml>...</sourceXml> </componentSourceXml> <autoSnapshotAllowed>...</autoSnapshotAllowed> <restrictionKey>...</restrictionKey> <schedules> <schedule> <startDate>...</startDate> <endDate>...</endDate> </schedule> <schedule> <!--...--> </schedule> <!--...more "schedule" elements...--> </schedules> <parentReferences> <parentReference> <uuid>...</uuid> <externalID>...</externalID> <orderNumber>...</orderNumber> <subOrderNumber>...</subOrderNumber> <startDate>...</startDate> <endDate>...</endDate> <ciid>...</ciid> </parentReference> <parentReference> <!--...--> </parentReference> <!--...more "parentReference" elements...--> </parentReferences></PhysicalAssetImage>
Element product
- Type: feedProduct
Example XML
<?xml version="1.0" encoding="UTF-8"?><product xmlns="http://opencase.extend.com/cm"> <productPk>...</productPk> <name>...</name> <uuid>...</uuid> <offerWindowStartDate>...</offerWindowStartDate> <offerWindowEndDate>...</offerWindowEndDate> <isSubscriptionPollOn>...</isSubscriptionPollOn> <offerType>...</offerType> <targetDevices> <targetDevices>...</targetDevices> <targetDevices>...</targetDevices> <!--...more "targetDevices" elements...--> </targetDevices> <assetFormats> <assetFormats>...</assetFormats> <assetFormats>...</assetFormats> <!--...more "assetFormats" elements...--> </assetFormats> <lastModified>...</lastModified> <createDate>...</createDate> <productOverrideCharge>...</productOverrideCharge></product>
Element productOverrideCharge
- Type: feedCharge
This class is used to convert charge information into a feed.
Example XML
<?xml version="1.0" encoding="UTF-8"?><productOverrideCharge xmlns="http://opencase.extend.com/cm"> <chargePk xmlns="">...</chargePk> <type>...</type> <amount>...</amount> <repeatCount>...</repeatCount> <currencySymbol>...</currencySymbol> <currencyFormat>...</currencyFormat> <chargeDisplay>...</chargeDisplay> <isoLocale>...</isoLocale></productOverrideCharge>
Type AbstractCDSISURLSignerSettings
- Extends: URLSignerSettings
The base settings for all types of CDSIS URL signing. These settings are common across all three types of signing.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
keyIdOwner (int) | 1/1 | This attribute value ID number for the owner of the encryption key. Valid entry is 1 if the key is defined in the Service Rule XML file. Valid entries are from 1 to 32 if the key is defined in the URL Signing page or by using the url signature command. |
keyIdNumber (int) | 1/1 | This attribute value is the encryption key ID number. Valid entry is 1 if the key is defined in the Service Rule XML file. Valid entries are from 1 to 16 if the key is defined in the URL Signing page or by using the Service Rules XML. |
expiryDelaySeconds (int) | 1/1 | Gets the number of seconds that pass before the signed URL expires. |
includeClientIP (boolean) | 1/1 | Specifies whether the client IP address paramter is included in the signed URL. |
Type AbstractEidrIdentifier
- Extends: Identifier
Abstract entity class that inherited by EidrIdentifier.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
identifier (string) | 0/1 | Getter for identifier filed. |
alternativeIdentifiersList/alternativeIdentifiers (EidrAlternativeIdentifier) | 0/unbounded | Getter for alternativeIdentifier field. |
Type AbstractPhysicalAssetVideo
- Extends: PhysicalAsset
Abstract base class implementing common fields and behavior for components representing physical video assets
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
videoBitRateType (string) | 0/1 | Gets the video bit rate type. Typically a value to indicate whether the video bitrate is variable or constant. |
videoCodecType (string) | 0/1 | Gets the video codec type. Typically a fourCC code. |
videoCodecName (string) | 0/1 | Gets the video codec name. |
frameCount (int) | 0/1 | Gets the frame count |
displayAspectRatio (string) | 0/1 | Gets the aspect ratio of the video |
videoBitRate (int) | 0/1 | Gets the video bit rate (Typically in Kbps) |
frameHeight (int) | 0/1 | Gets the frame height in pixels |
frameWidth (int) | 0/1 | Gets the frame width in pixels |
audioCodec (string) | 0/1 | Gets identifier for the audio codec |
audioSampleRate (int) | 0/1 | Gets the audio sample rate |
audioBitRate (int) | 0/1 | Gets the audio bit rate |
audioBitRateType (string) | 0/1 | Gets the audio bit rate type Typically a value to indicate whether the video bitrate is variable or constant. |
audioChannelCount (int) | 0/1 | Gets the number of audio channels |
frameRate (string) | 0/1 | Gets the video frame rate |
pixelAspect (string) | 0/1 | Gets the pixel aspect |
wrapperFormat (string) | 0/1 | Gets a string identifying the video container format eg. MP4, AVI |
isProgressive (boolean) | 0/1 | Gets a boolean indicating whether the video is a progressive download |
duration (string) | 0/1 | Gets the duration of the video content |
publishURL (string) | 0/1 | Gets the publish URL for the physical asset video The publish URL is typically a URL that will be sent to client devices and redirected to the release URL, which points at the actuallocation the content is accessible. If an origin mapping is defined for this physical asset video the publish URL will be constructedbased on the mapping to the origin base URL. |
subtitleLanguages/subtitleLanguage (SubtitleLanguage) | 0/unbounded | Gets the subtitle languages associated with this physical asset video entity |
audioLanguages/audioLanguage (AudioLanguage) | 0/unbounded | Gets the audio languages associated with this physical asset video entity |
closedCaptioning (boolean) | 0/1 | Gets the boolean indicator whether the video has closed caption of not
|
resolution (string) | 0/1 | Gets the resolution of the video, the limit for the res
|
reverseEPGExpiry (dateTime) | 0/1 | Gets the reverse EPG expiry date. A TSTV related attribute that describes when reverse EPG capability expires for a recorded program. |
catchupTVStart (dateTime) | 0/1 | Get the catch up start date. A TSTV related attribute that describes when catch up tv capability is first allowed for a recorded program. |
catchupTVExpiry (dateTime) | 0/1 | Get the catch up expiry date. A TSTV related attribute that describes when catch up tv capability expires for a recorded program. |
sourceLocation (string) | 0/1 | Gets sourceLocation field (max length = 255) A TSTV related attribute that describes where the recording occurred in the recording infrastructure. Also referred to as SRDN (ServiceRouting Domain Name) within the TimeShift TV (TSTV) nomenclature. |
sourceStationID (string) | 0/1 | Get the source station ID (max length = 255) A TSTV related attribute that describes the station on which recording occurred. |
sourceProgramID (string) | 0/1 | Gets the source program ID (max length = 255) A TSTV related attribute that describes the program that is represented by recording. |
sourceSeriesID (string) | 0/1 | Gets the source series ID (max length = 255) A TSTV related attribute that describes the series that the program representing recording is associated with. |
epgEventReference (string) | 0/1 | Gets the EPG event reference (max length = 255). A TSTV related attribute that identifies the broadcast event the Catch-Up asset represents. |
sourceDateTime (dateTime) | 0/1 | Gets sourceDateTime fieldA TSTV related attribute that describes when the start date and time of the recorded program. |
locatorID (string) | 0/1 | Gets the locator Id LOCATOR_ID is nvarchar and nonunique index in DB. For nvarchar the storage size, in bytes, is two times the actuallength of data entered + 2 bytes and SQL Server retains the 900-byte limit for the maximum total size of all index key columns there maxlength for LOCATOR_ID is 450. A TSTV related attribute. |
catchupTrickPlay (string) | 0/1 | Gets the trick play settings (max length = 255) A TSTV related attribute. |
deviceProfileID (string) | 0/1 | Gets device profile ID. A TSTV related attribute. |
Type AbstractType
Specifies type of a basic component.Can be one of:
COMPONENT_TYPE BUNDLE_TYPE BUNDLE_FOLDER_TYPE
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
typePk (int) | 0/1 | Gets the type data table primary key. |
name (string) | 0/1 | Gets the type name. |
typeDiscriminator (TypeDiscriminator) | 0/1 | Gets the type discriminator |
uuid (string) | 0/1 | Get UUID. |
Type AdInsertionPoint
- Extends: Component
The AdInsertionPoint entity contains data relating to advertising points to be inserted into an asset.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
timeslot (double) | 0/1 | Gets timeslot start property. |
timeslotEnd (double) | 0/1 | Gets timeslot end property. |
note (string) | 0/1 | Getter fot property note. |
Type AdSlotSet
AdSlotSet entity.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
adSlotSetPk (int) | 0/1 | Gets the primary key of the AdSlotSet. |
preRollCount (int) | 0/1 | Gets the AdSlotSet's preRollCount. |
midRollCount (int) | 0/1 | Gets the AdSlotSet's midRollCount. |
postRollCount (int) | 0/1 | Gets the AdSlotSet's postRollCount. |
uuid (string) | 0/1 | Returns the component UUID generated by VMS when the entity is created. |
Type Advisory
- Extends: CommonEntity
The Advisory entity contain a group of providing expert information.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
advisoryName (string) | 1/1 | Gets the advisory's name. |
Type Affiliate
Affiliate entity
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
affiliatePk (int) | 0/1 | Get Affiliate primary key |
name (string) | 1/1 | Get Affiliate name |
description (string) | 0/1 | Get Affiliate description |
uuid (string) | 1/1 | Get Affiliate Universally Unique ID Value, used to uniquely identify an entity in VMS |
contactName (string) | 0/1 | Get Affiliate contact name |
contactEmail (string) | 0/1 | Get Affiliate contact email |
contactPhone (string) | 0/1 | Get Affiliate contact phone |
accountManagerClass (string) | 0/1 | Get Java class name for account manager of the Affiliate |
accountManagerConfig (string) | 0/1 | Get configuration string for account manager class instance of the Affiliate |
isActive (boolean) | 1/1 | Get Affiliate active status. Inactive affiliates are not processed |
Type AssetFormat
- Extends: CommonEntity
The Asset Format entity will be added to the Content Manager model to allow PhysicalAssets to be classified to support Device Tailoring.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
name (string) | 1/1 | Gets the assetFormat's name. |
Type AssetSchedule
Object that represents asset schedule in scope of classification reference.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
startDate (string) | 0/1 | (no documentation provided) |
endDate (string) | 0/1 | (no documentation provided) |
orderNumber (int) | 0/1 | (no documentation provided) |
Type AudioLanguage
- Extends: CommonEntity
The Language entity holds string representation of language.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
language (string) | 1/1 | Gets name of language. |
Type BindProfile
BindProfile used in Workflow bind process, it controls how the new resources is attached to the specific bundle
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
bindProfilePk (int) | 1/1 | bindProfilePk getter |
name (string) | 1/1 | name getter |
description (string) | 0/1 | description getter |
uuid (string) | 0/1 | UUID getter |
supportsComponentUpdatePlugin (boolean) | 0/1 | SupportsComponentUpdatePlugin getter |
supportsUpdate (boolean) | 0/1 | SupportsUpdate getter |
bundleUpdateRule (bundleUpdateRule) | 0/1 | BundleUpdateRule getter |
componentUpdateRule (componentUpdateRule) | 0/1 | ComponentUpdateRule getter |
componentUpdatePluginRule (componentUpdatePluginRule) | 0/1 | ComponentUpdatePluginRule getter |
supportsComponentCreateAssociation (boolean) | 0/1 | (no documentation provided) |
componentCreateAssociationRule (componentCreateAssociationRule) | 0/1 | (no documentation provided) |
Type BulkEditableField
Stores the field name and type that will be used during the bulk edit operation.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
fieldName (string) | 1/1 | Gets the field name that will be used during the bulk edit operation. |
fieldType (string) | 0/1 | Gets the field type that will be used during the bulk edit operation. |
Type BulkEditOperation
Represents the type of bulk edit operation that will be applied to the selected field. The allowed operations are UPDATE_WITH_NEW_VALUE, REPLACE_WITH_NULL, and ADD_NEW_ITEM
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
fieldName (string) | 1/1 | Retrieves the name of the field that can be modified during bulk edit. |
newValue (anyType) | 0/1 | Retrives the new value that will be added during bulk edit. |
newValues (anyType) | 0/unbounded | Retrives the list of new values that will be added during bulk edit. Should be used only by web-services. |
bulkEditOperationType (BulkEditOperationType) | 0/1 | Retrieves the type of operation that will be applied to the field during bulk edit. |
isCustomAttributeOp (boolean) | 1/1 | Retrieves TRUE if the field name is a custom attribute, otherwise returns FALSE. |
commonEntityOp (boolean) | 1/1 | (no documentation provided) |
Type BulkEditOperationType
Possible Values
value | description |
---|---|
UPDATE_WITH_NEW_VALUE | Updates the existing entry with a new value. |
REPLACE_WITH_NULL | Updates the existing entry with a NULL value. |
ADD_NEW_ITEM | Adds a new value to the existing entry. |
Type Bundle
- Extends: Component
Bundles are customizable objects that conform to a template and that are created when components, and/or other bundles are combined into aunit.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
isActive (boolean) | 0/1 | Gets whether this Bundle is active or not. |
isPublishable (boolean) | 0/1 | Gets whether this is a publishable Bundle. |
isTimeshiftContent (boolean) | 0/1 | Gets whether this is a TSTV Bundle. |
bundleClassification (BundleClassification) | 1/1 | Gets the BundleClassification associated with this Bundle. |
bundleItems/bundleItem (BundleItem) | 0/unbounded | Gets a set of BundleItems associated with this Bundle. |
bundleRootChildren (BundleItem) | 0/unbounded | Gets a set of BundleItems associated with this Bundle that have no parent BundleItems. |
bundleType (BundleType) | 0/1 | Gets the BundleType associated with this Bundle. |
bindID (string) | 0/1 | Gets the Bundle's bind ID. |
subscriptionCodes/subscriptionCode (SubscriptionCode) | 0/unbounded | Gets a set of SubscriptionCodes associated with this Bundle. |
isComplete (boolean) | 0/1 | Gets whether this Bundle is complete or not. |
providers/provider (Provider) | 0/unbounded | Gets the Provider associated with this Bundle. NOTE: The number of providers per bundle is limited to one. |
shopID (string) | 0/1 | (no documentation provided) |
classificationReferences/classificationReference (ClassificationReference) | 0/unbounded | (no documentation provided) |
bundleReferences/bundleReference (BundleReference) | 0/unbounded | (no documentation provided) |
Type BundleClassification
Listing of bundle classification types.
Possible Values
value | description |
---|---|
SIMPLE | A simple bundle cannot stand alone and must be created in the context of another bundle. |
LOGICAL_ASSET | A logical asset bundle is a basic bundle that gorups components with different encoding or encryption versions of the same asset. |
COMPOUND_ENTITY | A component entity is a complex bundle the groups a set of Logical Asset bundles like Albums, DVDs, Box Sets, etc. |
CLASSIFICATION_NODE | A Classification bundle is a bundle that is defined by the VCM model. Implemented for uCMS integration. |
CATALOG | A Catalog bundle is a bundle that is defined by the VCM model. Implemented for uCMS integration. |
CLASSIFICATION | A Classification bundle is a bundle that is defined by the VCM model. Implemented for uCMS integration. |
Type BundleFolder
- Extends: Component
Class that implements the functionality of the bundle folder component's.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
bundleFolderType (BundleFolderType) | 0/1 | Gets the BundleFolderType associated with this BundleFolder. |
releaseUrl (string) | 0/1 | Gets the BundleFolder's releaseUrl. |
Type BundleFolderType
- Extends: AbstractType
Bundle folder type that represents bundle's folder with allowed types.
Type BundleItem
A general class that represents the Bundle Items.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
bundleItemPk (int) | 0/1 | Gets unique identification number of bundle item. |
bundleItems/bundleItem (BundleItem) | 0/unbounded | Gets the set of BundleItem. |
component (Component) | 0/1 | Gets component object for web service call.javax.persistence.FetchType#EAGER fetching due to web service call not able to determine actual sub type. |
uuid (string) | 0/1 | Gets universally unique identifier. |
orderNumber (int) | 0/1 | The order number position of the hierarchy in it't bundle. |
subOrderNumber (int) | 0/1 | The sub order number position of the bundle hierarchy. |
generationType (generationType) | 0/1 | Gets the generation type of bundle item. |
bundleTypeItem (BundleTypeItem) | 0/1 | Gets the type of the bundle item. |
startDate (dateTime) | 0/1 | Gets start date/time of the bundle item. Used for licensing. |
endDate (dateTime) | 0/1 | Gets end date/time of the bundle item. Used for licensing. |
Type BundleReference
Object shows relation between asset and bundles.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
bundleUuid (string) | 1/1 | (no documentation provided) |
assetId (string) | 1/1 | (no documentation provided) |
schedule (AssetSchedule) | 0/unbounded | (no documentation provided) |
bundleReferences/bundleReference (BundleReference) | 0/unbounded | (no documentation provided) |
Type BundleSearchFilter
This class is used as a search filter criteria for matching bundles to the specified parameters.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
lastModifiedStart (dateTime) | 0/1 | Returns the beginning date of the search range to find bundles. |
lastModifiedEnd (dateTime) | 0/1 | Returns the end date of the search range to find bundles. |
bundleIsActive (boolean) | 0/1 | Returns TRUE if the bundle is active or FALSE if the bundle is inactive. |
bundleTypePk (int) | 0/1 | Returns the primary key of the bundle type. |
commonEntityClassName (string) | 0/1 | (no documentation provided) |
customAttributeTypeName (string) | 0/1 | (no documentation provided) |
filterType (filterType) | 0/1 | (no documentation provided) |
commonEntityDiscriminator (string) | 0/1 | (no documentation provided) |
bundleClassificationsToExclude (BundleClassification) | 0/unbounded | (no documentation provided) |
Type BundleSort
The bundle fields that are available to sort by.
Possible Values
value | description |
---|---|
name | The name field used to sort bundles. |
altCode | The Alt code field used to sort bundles. |
lastModified | The last modified date field to sort bundles. |
isActive | The status field used to sort bundles. |
typeName | The bundle type name field used to sort bundles. |
status | The status field to sort bundles. |
Type BundleSortField
- Extends: SortField
This class is used to determine the format of bundle list based on the selected sort field.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
sortField (BundleSort) | 0/1 | Returns the sort field. |
Type BundleType
- Extends: AbstractType
BundleType entity. Is used to differentiate different Bundle types.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
bundleClassification (BundleClassification) | 0/1 | Gets the bundle type classification. |
Type BundleTypeDTO
Class is used to transfer BundleType to use on UI of different module.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
typePk (int) | 0/1 | (no documentation provided) |
name (string) | 0/1 | (no documentation provided) |
displayName (string) | 0/1 | (no documentation provided) |
labelResourceKey (string) | 0/1 | (no documentation provided) |
Type BundleTypeItem
BundleTypeItem describes where specific bundle item could be placed in specific bundle type.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
bundleType (BundleType) | 0/1 | Gets bundle type. |
bundleTypeItemPk (int) | 0/1 | Gets bundle type item (primary key of the class). |
isChildTypesAllowed (boolean) | 1/1 | Gets boolean indicating whether or not this BundleTypeItem could accept children Types. |
isAllowSearch (boolean) | 1/1 | Gets boolean indicating whether or not reusable components are allowed in this bundle location. Currently all components are reusable byother bundles but if this is set to false that behavior will not be allowed. This will cause the search controls to no longerappear in the UI and a restriction to check for existing usage will be enforced in the add methods. |
maxChildOccurences (int) | 1/1 | Gets the maximum number of child occurrences when child types are allowed. For example, if the maximum child occurrences is 1 then only 1instance of each child type will be allowed at a time. |
maxOccurs (int) | 1/1 | Gets the maximum number of elements that are are allowed at this node in the tree. |
minOccurs (int) | 1/1 | Gets the minimum number of elements that are are allowed at this node in the tree. |
orderNumber (int) | 1/1 | Gets the order to be show in the tree. |
parentBundleTypeItem (BundleTypeItem) | 0/1 | Gets parent bundle type item. |
type (AbstractType) | 0/1 | Gets the type of component. NOTICE: EAGER FETCHING DUE TO WEBSERVICE CALL NOT ABLE TO DETERMINE ACTUAL SUBTYPE |
uuid (string) | 0/1 | (no documentation provided) |
isAddSchedule (boolean) | 0/1 | (no documentation provided) |
Type bundleValidation
Stores data relating to the conversation with the VCM system.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
bundleValidationPk (int) | 0/1 | Gets the primary key for the BundleValidation record. This is a required field. |
bundleFk (int) | 0/1 | Get the bundle that is being used in the BundleValidation. This is a required field. |
createDate (dateTime) | 0/1 | Gets the date that the record is created. This is a required field. |
lastActiveDate (dateTime) | 0/1 | Gets the date that the record is last updated. This is a required field. |
eventType (bundleValidationType) | 0/1 | Get the event type that is flagging the bundle as invalid. |
validationMessage (string) | 0/1 | Gets the validation message which specifies why the bundle validation failed. |
uuid (string) | 0/1 | (no documentation provided) |
Type bundleValidations
Wrapper class used to store a list of BundleValidations. Its main purpose is to allow the Plugin Validation framework to validate andproduce a list of errors via XSL (which is in XML), which then gets serialized and is persisted to the database.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
bundleValidation (bundleValidation) | 1/unbounded | Gets a list of BundleValidations. |
Type CatalogAttribute
- Extends: Component
The CatalogAttribute component encapsulates the Catalog ID of the catalog.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
catalogId (string) | 0/1 | Gets the associated Catalog ID. |
Type Category
- Extends: CommonEntity
The Category entity, defines a classification of an asset.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
categoryName (string) | 1/1 | Gets the name of current category. |
separator (string) | 0/1 | Empty getter for separator value to hide separator tag in output XML representation. |
Type CDSISURLSignerSettingsPublicKey
- Extends: AbstractCDSISURLSignerSettings
Settings specific to the CDS Public Key URL Signer.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
privateKey (string) | 1/1 | Gets the private key being used in this URL Signer Configuration. |
Type CDSISURLSignerSettingsSymmetric
- Extends: AbstractCDSISURLSignerSettings
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
key (string) | 1/1 | (no documentation provided) |
Type Charge
Entity class used to store charge information.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
chargePk (int) | 0/1 | Gets the primary key of the Charge. |
currency (Currency) | 1/1 | Gets the Charge's currency. |
type (ChargeType) | 1/1 | Gets the ChargeType associated with this Charge. |
amount (double) | 1/1 | Gets the ChargeType's amount. |
repeatCount (int) | 0/1 | Gets the ChargeType's repeatCount. |
Type ChargeType
The ChargeType enumeration represents possible options for charge type.
Possible Values
value | description |
---|---|
NONE | Specifies that no charge should be made. |
ONETIME | Specifies that a charge should only be made one time. |
REPEATING | Specifies that a charge should repeat multiple times. |
Type ClassificationAttribute
- Extends: Component
The ClassificationAttribute is a container for classification schedules
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
startDate (dateTime) | 0/1 | Gets the Start Date. |
endDate (dateTime) | 0/1 | Gets the End Date. |
classificationKey (string) | 0/1 | (no documentation provided) |
isAdultContent (boolean) | 0/1 | (no documentation provided) |
classificationTypes/classificationType (ClassificationType) | 0/unbounded | Gets the ClassificationType associated with the ClassificationAttribute. The number of ClassificationTypes perClassificationAttribute is limited to one. |
restrictTos/restrictTo (RestrictTo) | 0/unbounded | (no documentation provided) |
clickThroughs/clickThrough (ClickThrough) | 0/unbounded | (no documentation provided) |
renderHints/renderHint (RenderHint) | 0/unbounded | (no documentation provided) |
fieldTrialBit (int) | 0/1 | Gets the Field Trial Bit integer value |
usageType (string) | 0/1 | Gets the usage type |
excludeFromRecommendations (boolean) | 1/1 | Flag for excluding from recommedations to support Merchandiser and VMS integration. Default value is false |
Type ClassificationNodeAttribute
- Extends: Component
The ClassificationNodeAttribute is a container for classification Attributes
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
startDate (dateTime) | 0/1 | (no documentation provided) |
endDate (dateTime) | 0/1 | (no documentation provided) |
nodeId (string) | 0/1 | (no documentation provided) |
Type ClassificationReference
Object shows relation between asset and classification.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
classificationUuid (string) | 1/1 | (no documentation provided) |
classificationCiid (string) | 0/1 | (no documentation provided) |
schedule (AssetSchedule) | 0/unbounded | (no documentation provided) |
Type ClassificationType
- Extends: CommonEntity
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
name (string) | 1/1 | (no documentation provided) |
type (string) | 1/1 | (no documentation provided) |
Type ClickThrough
- Extends: CommonEntity
The ClickThrough entity specify a category for an asset.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
name (string) | 1/1 | Gets the ClickThrough's name. |
type (string) | 1/1 | Gets the ClickThrough's type. |
Type CommonEntities
Represents all possible common entities that could be in input XML file for Multi Entity Ingestion.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
advisories/advisory (Advisory) | 0/unbounded | (no documentation provided) |
assetFormats/assetFormat (AssetFormat) | 0/unbounded | (no documentation provided) |
categories/category (Category) | 0/unbounded | (no documentation provided) |
genres/genre (Genre) | 0/unbounded | (no documentation provided) |
priceCategories/priceCategory (PriceCategory) | 0/unbounded | (no documentation provided) |
providers/provider (Provider) | 0/unbounded | (no documentation provided) |
ratings/rating (Rating) | 0/unbounded | (no documentation provided) |
styles/style (Style) | 0/unbounded | (no documentation provided) |
subtitleLanguages/subtitleLanguage (SubtitleLanguage) | 0/unbounded | (no documentation provided) |
talents/talent (Talent) | 0/unbounded | (no documentation provided) |
targetDevices/targetDevice (TargetDevice) | 0/unbounded | (no documentation provided) |
audioLanguages/audioLanguage (AudioLanguage) | 0/unbounded | (no documentation provided) |
classificationTypes/classificationType (ClassificationType) | 0/unbounded | (no documentation provided) |
restrictTos/restrictTo (RestrictTo) | 0/unbounded | (no documentation provided) |
clickThroughs/clickThrough (ClickThrough) | 0/unbounded | (no documentation provided) |
renderHints/renderHint (RenderHint) | 0/unbounded | (no documentation provided) |
imageTypes/imageType (ImageType) | 0/unbounded | (no documentation provided) |
offerTypes/offerType (OfferType) | 0/unbounded | (no documentation provided) |
studios/studio (Studio) | 0/unbounded | (no documentation provided) |
Type CommonEntity
This is a common abstract class used to support the classes under common entities package.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
commonEntityPk (int) | 0/1 | (no documentation provided) |
uuid (string) | 0/1 | (no documentation provided) |
applyToAllLocales (boolean) | 0/1 | (no documentation provided) |
locales (Locale) | 0/unbounded | (no documentation provided) |
externalID (string) | 0/1 | Gets the external identification that references to an external system application. |
customAttributes/customAttribute (CustomAttribute) | 0/unbounded | Gets the set of AbstractCustomAttribute associated to this common entity. This method includes also the AbstractCustomAttribute in delete state of custom attribute type |
resourceKey (ResourceKey) | 0/1 | (no documentation provided) |
orderNumber (int) | 0/1 | (no documentation provided) |
extraInfos/extraInfo (CommonEntityExtraInfo) | 0/unbounded | (no documentation provided) |
Type CommonEntityExtraInfo
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
extraInfoPK (int) | 0/1 | Gets additional info entity primary key. |
content (string) | 1/1 | Gets additional info content value. |
uuid (string) | 0/1 | Returns the component UUID generated by VMS when the entity is created. |
Type CommonEntitySort
The common entity fields that are available to sort by.
Possible Values
value | description |
---|---|
displayName | The name field used to sort common entities. |
commonEntityTypeName | The common entity type name field used to sort common entities. |
lastModified | The last modified date field to sort common entities. |
lockedFlag | The locked flag field to sort common entities. |
Type CommonEntitySortField
- Extends: SortField
This class is used to determine the format of common entity list based on the selected sort field.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
sortField (CommonEntitySort) | 0/1 | Returns the sort field. |
Type CommonEntityType
The CommonEntityType define a type of CommonEntity.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
commonEntityTypePk (int) | 0/1 | Gets primary key. |
name (string) | 0/1 | Gets the CommonEntityType's name. |
implementationClass (string) | 0/1 | Gets the implementation class. |
uuid (string) | 0/1 | (no documentation provided) |
Type Component
Abstract class that implements the base functionality of the component's.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
componentPk (int) | 0/1 | (no documentation provided) |
name (string) | 1/1 | (no documentation provided) |
altCode (string) | 0/1 | (no documentation provided) |
externalID (string) | 0/1 | Gets the external identification that references to a external system application. |
externalVersion (string) | 0/1 | Gets the external version of this component. |
assetID (string) | 0/1 | Get Asset Id. |
createDate (dateTime) | 0/1 | (no documentation provided) |
lastModified (dateTime) | 0/1 | (no documentation provided) |
uuid (string) | 0/1 | (no documentation provided) |
ciid (string) | 0/1 | (no documentation provided) |
versionNumber (int) | 0/1 | Gets the component's version number. This value is incremented every time the component is updated |
sourceAssetID (string) | 0/1 | Gets the component's Asset ID. |
generationType (generationType) | 0/1 | Gets the generation type of component whether the component is created by ingestion or user |
customAttributes/customAttribute (CustomAttribute) | 0/unbounded | Gets the set of AbstractCustomAttribute associated to this component. This method includes also the AbstractCustomAttribute in delete state of custom attribute type |
componentSourceXml (ComponentSourceXml) | 0/1 | Gets the component's ComponentSourceXml associated. |
autoSnapshotAllowed (boolean) | 0/1 | (no documentation provided) |
restrictionKey (string) | 0/1 | (no documentation provided) |
schedules/schedule (Schedule) | 0/unbounded | Gets list of schedules for current component. Used for generating XML only.It contains schedules of all bundle items for this component. By default it's null, it's initialized only if isAddSchedule flag is truefor current component in order to avoid redundant marshalling schedules for components to which schedules are not related to. |
parentReferences/parentReference (ParentReference) | 0/unbounded | (no documentation provided) |
Type ComponentSort
The component fields that are available to sort by.
Possible Values
value | description |
---|---|
name | The name field used to sort components. |
altCode | The Alt code field used to sort components. |
lastModified | The last modified date field to sort components. |
componentTypeName | The bundle type name field used to sort components. |
startDate | The start date field used to sort components. |
expiryDate | The expiry date field used to sort components. |
Type ComponentSortField
- Extends: SortField
This class is used to determine the format of component list based on the selected sort field.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
sortField (ComponentSort) | 0/1 | Returns the sort field. |
Type ComponentSourceXml
Stores data associated with AbstractComponent and its source XML.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
sourceXml (string) | 0/1 | Gets the field to store the source XML of the component. This is not a required field. |
Type ComponentType
- Extends: AbstractType
Type classification for Components. Contains the fully qualified implementation class and discriminator values for a component implementation.Bundle type items containing Components refer to a ComponentType.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
implementationClass (string) | 0/1 | Get the component implementation class. |
componentDiscriminator (string) | 0/1 | Get the component discriminator. This field is used to differentiate between types in a hierarchy. |
isInstantiable (boolean) | 0/1 | Flag indicating if the Component type implementation class can be instantiated. |
Type ComponentUpdateRule
Possible Values
value | description |
---|---|
ALT_CODE | Finds a component to update based on whether the Alt code matches the Alt code of the incoming component XML. |
ASSET_ID | Finds a component to update based on whether the asset ID matches the asset ID in the incoming component XML. |
EXTERNAL_ID | Finds a component to update based on whether the external ID matches the external ID in the incoming component XML. |
CLASSIFICATION_UUID_OR_EXTERNAL_ID | Finds a component to update based on whether the UUID matches the UUID in the incoming component XML. |
NAME | Finds a component to update based on whether the name matches the name in the incoming component XML. |
Type ContentManagerGenericPlugin
- Extends: genericConfigurablePlugin
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
predefined (boolean) | 0/1 | (no documentation provided) |
discriminator (string) | 0/1 | (no documentation provided) |
uuid (string) | 0/1 | Get UUID. |
Type Currency
The Currency class represents currency object.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
currencyPk (int) | 0/1 | Gets primary key for currency. |
name (string) | 1/1 | Gets descriptive name of current currency(US Dollars, Euro, ...) |
isoCurrencyCode (string) | 1/1 | Gets ISO currency code for current currency. |
isoLocale (string) | 1/1 | Gets ISO locale for current currency. |
isActive (boolean) | 1/1 | Gets active/inactive state of current currency. |
lastModified (dateTime) | 0/1 | Gets date of last changes on current currency. |
uuid (string) | 0/1 | Returns the component UUID generated by VMS when the entity is created. |
Type CustomAttribute
CustomAttribute entity.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
customAttributePk (int) | 0/1 | Gets the primary key of the customAttribute. |
discriminator (string) | 1/1 | Gets the customAttribute's discriminator that indicates the type of customAttribute. |
customAttributeTypeName (string) | 1/1 | Gets the customAttribute associated customAttributeType's name. |
uuid (string) | 0/1 | (no documentation provided) |
customAttributeTypeIdentifier (string) | 0/1 | Gets the customAttribute associated customAttributeType's identifier. |
Type CustomAttributeClob
- Extends: CustomAttribute
Represents CustonAttributeClob entity.
Attributes
name | type | description |
---|---|---|
identifier | string | Used for schema validation only. |
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
value (string) | 1/1 | Gets current value of CustonAttributeClob entity. |
Type CustomAttributeDate
- Extends: CustomAttribute
Represents CustomAttributeDate entity.
Attributes
name | type | description |
---|---|---|
identifier | string | Used for schema validation only. |
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
value (dateTime) | 1/1 | Gets current value of CustomAttributeDate entity. |
Type CustomAttributeDbl
- Extends: CustomAttribute
Represents CustomAttributeDbl entity.
Attributes
name | type | description |
---|---|---|
identifier | string | Used for schema validation only. |
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
value (double) | 1/1 | Gets current value of CustomAttributeDbl entity. |
Type CustomAttributeInt
- Extends: CustomAttribute
CustomAttributeInt entity.
Attributes
name | type | description |
---|---|---|
identifier | string | Used for schema validation only. |
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
value (int) | 1/1 | Gets current value of CustomAttributeInt. |
Type CustomAttributeMultipleValueDbl
- Extends: CustomAttribute
Represents CustomAttributeMultipleValueDbl entity.
Attributes
name | type | description |
---|---|---|
identifier | string | Used for schema validation only. |
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
value (double) | 1/unbounded | Gets current value of CustomAttributeMultipleValueDbl entity. |
Type CustomAttributeMultipleValueInt
- Extends: CustomAttribute
CustomAttributeMultipleValueInt entity.
Attributes
name | type | description |
---|---|---|
identifier | string | Used for schema validation only. |
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
value (int) | 1/unbounded | Gets current value of CustomAttributeMultipleValueInt. |
Type CustomAttributeMultipleValueStr
- Extends: CustomAttribute
Represents CustomAttributeMultipleValueStr entity.
Attributes
name | type | description |
---|---|---|
identifier | string | Used for schema validation only. |
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
value (string) | 1/unbounded | Gets current value of CustomAttributeMultipleValueStr. |
Type CustomAttributeStr
- Extends: CustomAttribute
Represents CustomAttributeStr entity.
Attributes
name | type | description |
---|---|---|
identifier | string | Used for schema validation only. |
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
value (string) | 1/1 | Gets current value of CustomAttributeStr. |
Type Domain
- Extends: Component
The Domain component associates a given ClassificationNode hierarchy to a CatalogDomain has only a start date and no end date. If multiple domains are associated to a Catalog, the start date of the proceeding Domain will bethe endDate of the preceding Domain.
Type DrmProfile
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
drmProfilePk (int) | 0/1 | (no documentation provided) |
name (string) | 1/1 | (no documentation provided) |
description (string) | 0/1 | (no documentation provided) |
type (string) | 1/1 | (no documentation provided) |
isActive (boolean) | 1/1 | (no documentation provided) |
drmTermsSets (DrmTermsSet) | 1/unbounded | (no documentation provided) |
licenseLimit (int) | 0/1 | (no documentation provided) |
includeNonPersistentLicenses (boolean) | 0/1 | (no documentation provided) |
lastModified (dateTime) | 0/1 | (no documentation provided) |
uuid (string) | 0/1 | Returns the UUID. |
Type DrmTermsSet
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
drmTermsSetPk (int) | 0/1 | (no documentation provided) |
drmTermsSetXml (string) | 1/1 | (no documentation provided) |
drmType (DrmType) | 1/1 | (no documentation provided) |
DrmTermsBean (abstractDrmTermsBean) | 0/1 | (no documentation provided) |
uuid (string) | 0/1 | Returns the UUID. |
Type DrmType
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
drmTypePk (int) | 0/1 | (no documentation provided) |
name (string) | 1/1 | (no documentation provided) |
drmTermsSetClass (string) | 1/1 | (no documentation provided) |
implementationTechnology (string) | 1/1 | (no documentation provided) |
isActive (boolean) | 1/1 | (no documentation provided) |
discriminator (string) | 1/1 | (no documentation provided) |
uuid (string) | 0/1 | Returns the component UUID generated by VMS when the entity is created. |
Type DrmTypeDomain
- Extends: DrmType
Defines the maximum number of PCs and devices allowed to play content under a domain.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
pcLimit (int) | 0/1 | (no documentation provided) |
deviceLimit (int) | 0/1 | (no documentation provided) |
Type DrmTypeInteroperableDomain
- Extends: DrmTypeDomain
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
includedDrmTypes (DrmType) | 0/unbounded | (no documentation provided) |
Type EidrAlternativeIdentifier
Entity class that represents EIDR alternative identifier.The Alternative ID is of particular significance in EIDR metadata schema. It plays an important role in ensuring interoperability of EIDR IDswith other existing systems.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
eidrAlternativeIdentifierPk (int) | 0/1 | Getter for eidrAlternativeIdentifierPk. |
value (string) | 1/1 | Getter for value field. |
type (EidrAlternativeIdentifierType) | 1/1 | Getter for type field. |
Type EidrAlternativeIdentifierType
Enum that represent types of supported alternative identifiers for EidrIdentifier.
Possible Values
value | description |
---|---|
IMDB | Represents id that used by http://www.imdb.com/. |
ISAN | Represents id that used by http://www.isan.org/. |
CRID | Represents CRID (Content Reference Identifier). See http://en.wikipedia.org/wiki/Content_Reference_Identifier. |
TRIB | Represents id that used by http://www.tribunemediaservices.com/ |
Type EidrCollectionIdentifier
- Extends: EidrIdentifier
Defines entity class for EIDR Collection ID. Represents unique identifier for collections of audiovisual assets.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
seasonId (string) | 0/1 | Gets season ID associated with current EIDR ID. |
seriesId (string) | 0/1 | Gets series ID associated with current EIDR ID. |
collectionId (string) | 0/1 | Gets collection ID associated with current EIDR ID. |
Type EidrIdentifier
- Extends: AbstractEidrIdentifier
Entity class that represents EIDR(Entertainment Identifier Registry).EidrIdentifier is universal unique identifier system for motion pictures and television programs. The identification system uses metadata thatis associated with top-level titles, edits, DVDs, encodings, clips, and mash-ups
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
baseId (string) | 0/1 | Getter for baseId field. |
editId (string) | 0/1 | Getter for editId field. |
Type EidrProgramIdentifier
- Extends: EidrIdentifier
Defines entity class for EIDR Program ID. Represents unique identifier for program assets.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
seasonId (string) | 0/1 | Gets season ID associated with current EIDR ID. |
seriesId (string) | 0/1 | Gets series ID associated with current EIDR ID. |
Type EntitlementCheck
Handles basic getters and setters for the values in the table OCME_ENTITLEMENT_CHECK
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
entitlementCheckPk (int) | 0/1 | Gets the primary key of the entitlement check plug-in. |
name (string) | 1/1 | Gets the name of the entitlement check plug-in. |
description (string) | 0/1 | Gets the description of the entitlement check plug-in. |
uuid (string) | 1/1 | Gets the UUID of the entitlement check plug-in. |
implementationClass (string) | 1/1 | Gets the name of the class implementing this entitlement check plug-in. |
isActive (boolean) | 1/1 | Gets a Boolean to control whether this plug-in should be processed or not. |
isDefault (boolean) | 1/1 | Gets a Boolean to control the default state. |
Type EntitlementCheckMapping
Handles basic getters and setters for the values in the table OCME_ENT_CHECK_MAPPING
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
entitlementCheckMappingPk (int) | 0/1 | Gets the primary key of the entitlement check mapping. |
entitlementCheck (EntitlementCheck) | 1/1 | Gets the entitlement check associated with this entitlement check mapping. |
invocationArgumentsXml (string) | 0/1 | Gets the invocation arguments xml for this entitlement check mapping. |
invocationArguments (NameValuePairs) | 0/1 | Gets the invocation arguments and their values from the invocation arguments xml. |
Type EntitlementProfile
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
entitlementProfilePk (int) | 0/1 | (no documentation provided) |
name (string) | 1/1 | (no documentation provided) |
description (string) | 0/1 | (no documentation provided) |
evaluationType (EvaluationType) | 1/1 | (no documentation provided) |
isActive (boolean) | 1/1 | (no documentation provided) |
lastModified (dateTime) | 1/1 | (no documentation provided) |
entitlementCheckMappings (EntitlementCheckMapping) | 1/unbounded | (no documentation provided) |
uuid (string) | 0/1 | Returns the UUID. |
Type EvaluationType
An enum containing the supported evaluation types for use in entitlementProfile.
Possible Values
value | description |
---|---|
ALL | |
ANY |
Type Genre
- Extends: CommonEntity
The Genre entity specify a genre(with parent genre sub genre relation) for an asset.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
genreName (string) | 1/1 | Gets the genre's name. |
parentUuid (string) | 0/1 | Gets UUID of parent genre for current one. |
parentName (string) | 0/1 | Gets genre name of parent genre for current one. |
Type HierarchicalCategory
The HierarchicalCategory class represents category object which will be used only for web service needs. It is simple datatransfer object for category which will be used through appropriate category tranformers.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
locale (Locale) | 0/1 | Gets the locale of hierarchical category. |
resourceLabel (ResourceLabel) | 0/1 | (no documentation provided) |
parentUuid (string) | 0/1 | Gets the parent category uuid. |
orderNumber (int) | 0/1 | Gets order number for current hierarchical category. Specifies position for one-level categories in hierarchical structure. |
externalId (string) | 0/1 | Gets the external identification that references to an external system application. |
altCode (string) | 0/1 | Gets the category's altCode. |
commonEntityPk (int) | 0/1 | Gets primary key for category. |
uuid (string) | 0/1 | Gets the category uuid. |
categoryName (string) | 1/1 | Gets the name of current category. |
extraInfos/extraInfo (CommonEntityExtraInfo) | 0/unbounded | Gets the list of attached extra information. |
Type Identifier
- Extends: Component
Abstract class that implements base functionality required for implementing various Identifiers.Identifiers are objects that carry enough information to uniquely identify a business entity as well as optionally provide additionalinformation about the entity and relation ships to other business entities.
Type ImageProfile
Image profile entity
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
imageProfilePk (int) | 0/1 | Gets primary key vale. |
name (string) | 1/1 | Gets name of entity. |
width (int) | 0/1 | Gets width that will be applied during image transforming. |
height (int) | 0/1 | Gets height that will be applied during image transforming. |
fileFormat (string) | 0/1 | Gets transformed image format |
colorDepth (imageTransformationColorDepthEnum) | 0/1 | Gets possible color depth. |
letterboxBGColor (int) | 0/1 | Gets background color for letter box. |
description (string) | 0/1 | Gets description of profile. |
relatedThumbnailsWidth (int) | 0/1 | Gets width of related to Artwork Thumbnail |
relatedThumbnailsHeight (int) | 0/1 | Gets height of related to Artwork Thumbnail |
renamingOptions (string) | 0/1 | Gets renaming options. |
active (boolean) | 1/1 | Gets true when entity active and false otherwise. |
transparent (boolean) | 1/1 | Gets value that shows if result image will be "transparent" |
uuid (string) | 1/1 | Gets UUID of instance. |
targetDevices/targetDevice (TargetDevice) | 0/unbounded | Gets related Set of TargetDevice. Fetch type - FetchType#EAGER |
imageType (ImageType) | 0/1 | Gets imageType object.javax.persistence.FetchType#EAGER fetching due to web service call not able to determine actual sub type. |
Type ImageType
- Extends: CommonEntity
CommonEntity ImageType defines type of images associated to the Component PhysicalAssetImage
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
imageKey (string) | 1/1 | Represents imageKey of ImageType entity. |
name (string) | 1/1 | Represents name of ImageType entity. |
isStbViewRequired (boolean) | 0/1 | Gets whether this is STB View Required ImageType. |
Type IsanDocument
- Extends: Identifier
A IsanDocument Component for document-type assets.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
isbn10Identifier (string) | 0/1 | Get ISBN 10 identifier |
isbn13Identifier (string) | 0/1 | Get ISBN 13 identifier |
Type IsanGame
- Extends: Identifier
A IsanGame Component for game-type assets.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
identifier (string) | 0/1 | Get entity identifier |
userExperience (string) | 0/1 | Get user experience |
onlineExperienceFeatures (string) | 0/1 | Get online experience features |
supportedPlayers (string) | 0/1 | Get supported players |
supplementaryInformation (string) | 0/1 | Get supplementary information |
Type IsanVideo
- Extends: Identifier
A IsanVideo Component for video-type assets.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
identifier (string) | 0/1 | Get entity identifier |
rootIdentifier (string) | 0/1 | Get root identifier |
type (string) | 0/1 | Get entity type |
actionType (string) | 0/1 | Get action type |
versionDescriptiveName (string) | 0/1 | Get version descriptive name |
supplementaryInformation (string) | 0/1 | Get supplementary information |
isbnIdentifier (string) | 0/1 | Get ISBN identifier |
Type LicenseRequestInfo
Contains the info for license request
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
product (Product) | 1/1 | Gets the product related to the license request |
component (Component) | 1/1 | Gets the component related to the license request |
Type LicensingWindow
The LicensingWindow entity contains data relating to Licensing Window to be inserted into an asset.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
startDate (dateTime) | 0/1 | Gets the Start Date. |
endDate (dateTime) | 0/1 | Gets the End Date. |
componentPk (int) | 0/1 | (no documentation provided) |
name (string) | 1/1 | (no documentation provided) |
altCode (string) | 0/1 | (no documentation provided) |
externalID (string) | 0/1 | Gets the external identification that references to a external system application. |
externalVersion (string) | 0/1 | Gets the external version of this component. |
assetID (string) | 0/1 | Get Asset Id. |
createDate (dateTime) | 0/1 | (no documentation provided) |
lastModified (dateTime) | 0/1 | (no documentation provided) |
uuid (string) | 0/1 | (no documentation provided) |
ciid (string) | 0/1 | (no documentation provided) |
versionNumber (int) | 0/1 | Gets the component's version number. This value is incremented every time the component is updated |
sourceAssetID (string) | 0/1 | Gets the component's Asset ID. |
generationType (generationType) | 0/1 | Gets the generation type of component whether the component is created by ingestion or user |
customAttributes/customAttribute (CustomAttribute) | 0/unbounded | Gets the set of AbstractCustomAttribute associated to this component. This method includes also the AbstractCustomAttribute in delete state of custom attribute type |
componentSourceXml (ComponentSourceXml) | 0/1 | Gets the component's ComponentSourceXml associated. |
autoSnapshotAllowed (boolean) | 0/1 | (no documentation provided) |
restrictionKey (string) | 0/1 | (no documentation provided) |
schedules/schedule (Schedule) | 0/unbounded | Gets list of schedules for current component. Used for generating XML only.It contains schedules of all bundle items for this component. By default it's null, it's initialized only if isAddSchedule flag is truefor current component in order to avoid redundant marshalling schedules for components to which schedules are not related to. |
parentReferences/parentReference (ParentReference) | 0/unbounded | (no documentation provided) |
Type Locale
Model class representing the Locale
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
localePk (int) | 0/1 | Get the primary key of the Locale |
language (string) | 1/1 | Get the language of the Locale |
country (string) | 0/1 | Get the country of the Locale |
uuid (string) | 0/1 | (no documentation provided) |
Type Metadata
- Extends: Component
Base class for all Metadata implementations. A Metadata Component is a generic localized descriptor of an asset, containing titles, summaries,and keywords.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
locale (Locale) | 0/1 | Get the Metadata's locale. |
titleLong (string) | 0/1 | Get the long title (limited to 1000 characters). |
titleMedium (string) | 0/1 | Get the medium title (limited to 1000 characters). |
titleShort (string) | 0/1 | Get the short title (limited to 1000 characters). |
titleSortable (string) | 0/1 | Get the sortable title (limited to 1000 characters). |
summaryLong (string) | 0/1 | Get the long summary (limited to 4000 characters). |
summaryMedium (string) | 0/1 | Get the medium summary (limited to 3000 characters). |
summaryShort (string) | 0/1 | Get the short summary (limited to 1000 characters). |
notes (string) | 0/1 | Get the notes for this Metadata (limited to 4000 characters). |
keywords (string) | 0/1 | Get the keywords for this Metadata (limited to 4000 characters). |
releaseDate (dateTime) | 0/1 | Get the Metadata's release date. |
studios/studio (Studio) | 0/unbounded | Gets the Studio associated with Metadata. The number of Studios per Metadata is limited to one. |
marketingMessage (string) | 0/1 | Gets the text set as the marketing message. |
Type MetadataAlbum
- Extends: Metadata
MetadataAlbum entity that extends from Metadata
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
artist (string) | 0/1 | Get the String representation of the artist of MetadataAlbum
|
title (string) | 0/1 | Get the String representation of the title of MetadataAlbum
|
producer (string) | 0/1 | Get the String representation of the producer of MetadataAlbum
|
label (string) | 0/1 | Get the String representation of the label of MetadataAlbum
|
yearProduced (string) | 0/1 | Get the year produced of MetadataAlbum
|
yearReleased (string) | 0/1 | Get the year released in MetadataAlbum
|
credit (string) | 0/1 | Get the credit of the MetadataAlbum
|
isrc (string) | 0/1 | Get the String representation of isrc associated with Album
|
genres/genre (Genre) | 0/unbounded | Get the genres field which is Set of Genre
|
Type MetadataApp
- Extends: Metadata
MetadataApp entity that extends from Metadata
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
developer (string) | 0/1 | Get the String representation of the developer of MetadataApp
|
publisher (string) | 0/1 | Get the String representation of the publisher of MetadataApp
|
genres/genre (Genre) | 0/unbounded | Get the set of Genre associated with MetadataApp
|
styles/style (Style) | 0/unbounded | Get the set of Style associated with MetadataApp
|
advisories/advisory (Advisory) | 0/unbounded | Get the set of Advisory associated with MetadataApp
|
ratings/rating (Rating) | 0/unbounded | Get the set of Rating associated with MetadataApp
|
Type MetadataAudio
- Extends: Metadata
A Metadata Component for audio-type assets.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
album (string) | 0/1 | Gets the associated album. |
originalAlbum (string) | 0/1 | Gets the original album. |
track (int) | 0/1 | Gets the track number. |
year (string) | 0/1 | Gets the associated year. |
copyright (string) | 0/1 | Gets the audio's copyright. |
bpm (int) | 0/1 | Gets the audio's number of beats per minute (BPM). |
language (string) | 0/1 | Gets the audio's language. |
length (string) | 0/1 | Gets the length of the audio. |
artist (string) | 0/1 | Gets the associated artist. |
advisories/advisory (Advisory) | 0/unbounded | Gets the audio's set of advisories. |
genres/genre (Genre) | 0/unbounded | Gets the audio's set of genres. |
composers/composer (Talent) | 0/unbounded | Gets the audio's set of composers. |
lyricists/lyricist (Talent) | 0/unbounded | Gets the audio's set of lyricists. |
ratings/rating (Rating) | 0/unbounded | Gets the audio's set of ratings. |
Type MetadataAvailabilityWindow
The MetadataAvailabilityWindow entity contains data relating to metadata availability window to be inserted into an availabilitywindow bundle.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
category (string) | 0/1 | Getter for property category. |
startDate (dateTime) | 0/1 | Getter for property startDate. |
endDate (dateTime) | 0/1 | Getter for property endDate. |
offerTypes/offerType (OfferType) | 0/unbounded | Gets the offerTypes for the MetadataAvailabilityWindow. |
componentPk (int) | 0/1 | (no documentation provided) |
name (string) | 1/1 | (no documentation provided) |
altCode (string) | 0/1 | (no documentation provided) |
usageType (string) | 0/1 | Gets the usage type. |
usageTypeLabel (string) | 0/1 | Gets the usage type label. |
externalID (string) | 0/1 | Gets the external identification that references to a external system application. |
externalVersion (string) | 0/1 | Gets the external version of this component. |
assetID (string) | 0/1 | Get Asset Id. |
createDate (dateTime) | 0/1 | (no documentation provided) |
lastModified (dateTime) | 0/1 | (no documentation provided) |
uuid (string) | 0/1 | (no documentation provided) |
ciid (string) | 0/1 | (no documentation provided) |
versionNumber (int) | 0/1 | Gets the component's version number. This value is incremented every time the component is updated |
sourceAssetID (string) | 0/1 | Gets the component's Asset ID. |
generationType (generationType) | 0/1 | Gets the generation type of component whether the component is created by ingestion or user |
customAttributes/customAttribute (CustomAttribute) | 0/unbounded | Gets the set of AbstractCustomAttribute associated to this component. This method includes also the AbstractCustomAttribute in delete state of custom attribute type |
componentSourceXml (ComponentSourceXml) | 0/1 | Gets the component's ComponentSourceXml associated. |
autoSnapshotAllowed (boolean) | 0/1 | (no documentation provided) |
restrictionKey (string) | 0/1 | (no documentation provided) |
schedules/schedule (Schedule) | 0/unbounded | Gets list of schedules for current component. Used for generating XML only.It contains schedules of all bundle items for this component. By default it's null, it's initialized only if isAddSchedule flag is truefor current component in order to avoid redundant marshalling schedules for components to which schedules are not related to. |
parentReferences/parentReference (ParentReference) | 0/unbounded | (no documentation provided) |
Type MetadataCatalog
- Extends: Component
The MetadataCatalog component encapsulates name and locale information for theassociated Catalog bundle.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
path (string) | 0/1 | Gets the catalog's parent/child hierarchical path |
locale (Locale) | 0/1 | Gets the associated locale. |
Type MetadataChapter
- Extends: Component
entity class for MetadataChapter
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
locale (Locale) | 0/1 | get the Locale value |
title (string) | 0/1 | get the Title value |
summary (string) | 0/1 | get the Summary value |
chapterNumber (string) | 0/1 | get the ChapterNumber associated to this MetadataChapter |
startTime (string) | 0/1 | get the StartTime of this MetadataChapterThe time will be in the format of hh:mm:ss[:ff] |
duration (int) | 0/1 | get the Duration associated to this MetadataChapter |
Type MetadataClassification
- Extends: Metadata
The MetadataClassification is a container for classification Attributes
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
providerBranding (string) | 0/1 | (no documentation provided) |
softName (string) | 0/1 | Get the Metadata's soft name. |
toggleLabel (string) | 0/1 | Get Metadata's toggle label. |
Type MetadataClassificationNode
- Extends: Component
The MetadataClassificationNode is a container for classification Attributes
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
locale (Locale) | 0/1 | Gets the associated locale. |
Type MetadataDocument
- Extends: Metadata
A Metadata Component for document-type assets.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
publisher (string) | 0/1 | Get the associated publisher. |
authors/author (Talent) | 0/unbounded | Get the document authors. |
artists/artist (Talent) | 0/unbounded | Get the document artists. |
categories/category (Category) | 0/unbounded | Gets the categories. |
productType (string) | 0/1 | Get structure type of this product. |
readingLevel (string) | 0/1 | Get the associated reading level. |
seriesName (string) | 0/1 | Get the unique name of related collection or continuation of stories. |
franchise (string) | 0/1 | Get the name of associated Franchise. |
pageCount (int) | 0/1 | Get the number of pages. |
publishingDate (dateTime) | 0/1 | Get the Metadata's release date. |
expirationDate (dateTime) | 0/1 | Get the Metadata's release date. |
audioAvailable (boolean) | 0/1 | Gets the audio available. |
sampleAvailable (boolean) | 0/1 | Gets the sample available. |
distributionRights (string) | 0/1 | Get the distributionRights. |
Type MetadataDvd
- Extends: Metadata
This class is an entity class to hold metadata for DVD assets.This class is serializable. When it is serialized it will save (and restore) any objects that are themselves serializable.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
additionalFeatures (string) | 0/1 | Gets the additional features of the asset |
colorType (string) | 0/1 | Gets the color type of the asset |
format (string) | 0/1 | Gets the format of the asset |
region (string) | 0/1 | Gets the region of the asset |
advisories/advisory (Advisory) | 0/unbounded | Gets all advisory common entities associated with the asset |
categories/category (Category) | 0/unbounded | Gets all categories associated with the asset |
genres/genre (Genre) | 0/unbounded | Gets the list of genres that are associated with the asset |
producers/producer (Talent) | 0/unbounded | Gets the list of producers associated with the asset |
directors/director (Talent) | 0/unbounded | Gets the list of directors associated with the asset |
writers/writer (Talent) | 0/unbounded | Gets the list of writers associated with the asset |
castMembers/castMember (Talent) | 0/unbounded | Gets the list of cast members associated with the asset |
ratings/rating (Rating) | 0/unbounded | Gets the list of ratings associated with the asset |
Type MetadataImage
- Extends: Metadata
entity class for MetadataImage
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
credit (string) | 0/1 | get the Credit value associated to this MetadataImage |
publisher (string) | 0/1 | get the Publisher value associated to this MetadataImage |
Type MetadataShow
- Extends: MetadataVideoCommon
the entity class for MetadataShow
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
additionalFeatures (string) | 0/1 | get the AdditionalFeature value associated to this MetadataShow |
numberOfEpisodes (int) | 0/1 | get the NumberOfEpisodes value associated to this MetadataShow |
creators/creator (Talent) | 0/unbounded | get a set of Talent associated to this MetadataShow |
Type MetadataStation
- Extends: Metadata
This class is an entity class to hold metadata for Programming Service assets.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
displayName (string) | 0/1 | Gets the Programming Service display name. |
callSign (string) | 0/1 | Gets the Programming Service call sign. |
stationIdent (string) | 0/1 | Gets the Programming Service ident. |
network (string) | 0/1 | Gets the Programming Service network, cable or broadcasting group with which a Programming Service is associated. |
serviceType (string) | 0/1 | Gets the Programming Service type. |
timeZone (string) | 0/1 | Gets the Programming Service time zone. |
communityOfLicense (string) | 0/1 | Gets the Programming Service Community Of License. |
genres/genre (Genre) | 0/unbounded | Gets the Programming Service genres. |
website (string) | 0/1 | Gets the Programming Service website URL. |
faceBook (string) | 0/1 | Gets the Programming Service Facebook page URL. |
twitter (string) | 0/1 | Gets the Programming Service Twitter page URL. |
street1 (string) | 0/1 | Gets the Programming Service street address or post office box. |
street2 (string) | 0/1 | Gets the Programming Service additional address data - e.g. suite, village, quarter. |
city (string) | 0/1 | Gets the Programming Service address town or city. |
state (string) | 0/1 | Gets the Programming Service address state, province or territory. |
zipCode (string) | 0/1 | Gets the Programming Service address zip code. |
country (string) | 0/1 | Gets the Programming Service address country. |
Type MetadataVideo
- Extends: MetadataVideoCommon
Entity class that represents metadata of video.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
episodeName (string) | 0/1 | Getter for field episodeName. |
episodeNumber (string) | 0/1 | Getter for episodeNumber field. |
duration (string) | 0/1 | Getter for duration field. |
copyrightNotice (string) | 0/1 | Getter for copyrightNotice field. |
workType (string) | 0/1 | Getter for workType field.Work type is defined by the context & specific pattern that qualify a given type of content such as music, film, TV, web, mobile, etc. |
creators/creator (Talent) | 0/unbounded | Getter for creators field. |
Type MetadataVideoCommon
- Extends: Metadata
Abstract model class that implements the base functionality of Metadata Video Common.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
colorType (string) | 0/1 | Returns the color type. |
seriesName (string) | 0/1 | Gets the series name. |
seasonNumber (string) | 0/1 | Gets the season number. |
country (string) | 0/1 | Gets the country. |
firstAirDate (dateTime) | 0/1 | Gets the first air date. |
publisher (string) | 0/1 | Gets the publisher. |
publishDate (dateTime) | 0/1 | Gets the publish date |
distributor (string) | 0/1 | Gets the distributor. |
provider (string) | 0/1 | Gets the provider. |
advisories/advisory (Advisory) | 0/unbounded | Gets the advisories. |
categories/category (Category) | 0/unbounded | Gets the categories. |
genres/genre (Genre) | 0/unbounded | Gets the genres. |
producers/producer (Talent) | 0/unbounded | Gets the producers. |
directors/director (Talent) | 0/unbounded | Gets the directors. |
writers/writer (Talent) | 0/unbounded | Gets the writers. |
castMembers/castMember (Talent) | 0/unbounded | Gets the cast members. |
ratings/rating (Rating) | 0/unbounded | Gets the ratings. |
billingId (string) | 0/1 | Getter for billingId field. |
Type OfferType
- Extends: CommonEntity
A new CommonEntity OfferType defines type of offer associated to the Components OfferWindow and MetadataAvailabilityWindow.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
name (string) | 1/1 | Represents name of OfferType entity. |
offerEndCalculatorClass (string) | 0/1 | Gets OfferEndCalculatorClass name value. |
Type OfferTypeEnum
Enum representation of the available OfferType
Possible Values
value | description |
---|---|
PERPETUAL | |
RENTAL |
Type OfferWindow
Offer window entity represents a period of time that entitled content is available for clients to consume. The specific type of offer (SVOD,TVOD, FREE, etc) is defined by the offer type ('type' parameter).
This entity is used for passing entitlement metadata to Merchandiser. This offer window is not related to EM policies or products.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
offerTemplate (string) | 0/1 | Gets offer window template. |
startDate (dateTime) | 0/1 | Gets start date/time of the offer window. |
expiryDate (dateTime) | 0/1 | Gets expiry date of the offer window. |
rentalPeriod (string) | 0/1 | Gets rental period for the offer window. |
priceCategorys/priceCategory (PriceCategory) | 0/unbounded | Get product price categories available within the offer window. |
componentPk (int) | 0/1 | (no documentation provided) |
name (string) | 1/1 | (no documentation provided) |
offerTypes/offerType (OfferType) | 0/unbounded | Gets the offerTypes for the offer window component. |
altCode (string) | 0/1 | (no documentation provided) |
externalID (string) | 0/1 | Gets the external identification that references to a external system application. |
externalVersion (string) | 0/1 | Gets the external version of this component. |
assetID (string) | 0/1 | Get Asset Id. |
createDate (dateTime) | 0/1 | (no documentation provided) |
usageType (string) | 0/1 | Gets the usage type. |
lastModified (dateTime) | 0/1 | (no documentation provided) |
usageTypeLabel (string) | 0/1 | Gets the usage type label. |
uuid (string) | 0/1 | (no documentation provided) |
ciid (string) | 0/1 | (no documentation provided) |
plannerRetention (int) | 0/1 | Gets planner retention days value. |
versionNumber (int) | 0/1 | Gets the component's version number. This value is incremented every time the component is updated |
sourceAssetID (string) | 0/1 | Gets the component's Asset ID. |
generationType (generationType) | 0/1 | Gets the generation type of component whether the component is created by ingestion or user |
customAttributes/customAttribute (CustomAttribute) | 0/unbounded | Gets the set of AbstractCustomAttribute associated to this component. This method includes also the AbstractCustomAttribute in delete state of custom attribute type |
componentSourceXml (ComponentSourceXml) | 0/1 | Gets the component's ComponentSourceXml associated. |
autoSnapshotAllowed (boolean) | 0/1 | (no documentation provided) |
restrictionKey (string) | 0/1 | (no documentation provided) |
schedules/schedule (Schedule) | 0/unbounded | Gets list of schedules for current component. Used for generating XML only.It contains schedules of all bundle items for this component. By default it's null, it's initialized only if isAddSchedule flag is truefor current component in order to avoid redundant marshalling schedules for components to which schedules are not related to. |
parentReferences/parentReference (ParentReference) | 0/unbounded | (no documentation provided) |
Type OfferWindowOptions
The Enum representation of all the available OfferWindowOptions
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
date (dateTime) | 0/1 | Get the date of the OfferWindowOptions |
numOfDays (int) | 0/1 | Get the number of days of the OfferWindowOptions |
hours (int) | 0/1 | get the hours of OfferWindowOptions |
minutes (int) | 0/1 | get the minutes of OfferWindowOptions |
Possible Values
value | description |
---|---|
ACTIVATE_IMMEDIATELY | |
ACTIVATE_IN_X_DAYS_AT | |
ACTIVATE_ON | |
ACTIVATE_ON_LICENSE_START | |
DEACTIVATE_NEVER | |
DEACTIVATE_AFTER_X_DAYS_AT | |
DEACTIVATE_ON | |
DEACTIVATE_ON_LICENSE_END |
Type OfferWindowValue
The model class of OfferWindowValue
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
offerWindowName (OfferWindowOptions) | 0/1 | Get the OfferWindowOptions associated with OfferWindowValue |
offerWindowDate (dateTime) | 0/1 | Get the offer window date of OfferWindowValue |
numOfDays (int) | 1/1 | Get the number of days of OfferWindowValue |
hourOfDay (int) | 1/1 | Get the hours of day of OfferWindowValue |
minute (int) | 1/1 | get the minute of OfferWindowValue |
Type opencase
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
component (Component) | 0/unbounded | (no documentation provided) |
products (Product) | 0/unbounded | (no documentation provided) |
commonEntities (CommonEntities) | 0/1 | (no documentation provided) |
Type OriginMapping
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
orginMappingPk (int) | 0/1 | (no documentation provided) |
name (string) | 1/1 | (no documentation provided) |
originBaseUrl (string) | 1/1 | (no documentation provided) |
publicUrl (string) | 1/1 | (no documentation provided) |
urlSignerConfiguration (UrlSignerConfiguration) | 0/1 | (no documentation provided) |
uuid (string) | 0/1 | (no documentation provided) |
Type ParentReference
Object uses for Classification Ingestion. Shows relationship to the parent Node.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
uuid (string) | 0/1 | (no documentation provided) |
externalID (string) | 0/1 | (no documentation provided) |
orderNumber (int) | 0/1 | (no documentation provided) |
subOrderNumber (int) | 0/1 | (no documentation provided) |
startDate (dateTime) | 0/1 | (no documentation provided) |
endDate (dateTime) | 0/1 | (no documentation provided) |
ciid (string) | 0/1 | (no documentation provided) |
Type Person
The Person entity contains a person information related to an asset.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
personPk (int) | 0/1 | Represents PK of Person entity. |
firstName (string) | 0/1 | Represents first name of Person entity. |
lastName (string) | 0/1 | Represents last name of Person entity. |
displayName (string) | 0/1 | Represents display name of Person entity. |
Type PhysicalAsset
- Extends: Component
PhysicalAsset component represents common fields in a digital asset in VMS e.g. Image, Video, App, Document etc. This class is base class forother physical assets.
NOTE: When extending this class and overriding the #getComponentLabelKey() method, the return value must either start with"component.type.physicalasset" or "component.type.abstract.physicalasset".
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
url (string) | 0/1 | This method returns the manually set URL. The manual URL defines the URL access to the physical asset file. The variable manualURL ismapped to the database as URL in the OCM_PHYSICAL_ASSET table. The function name is equivalent to getManualURL() however to maintainbackwards compatibility with the schema and method calls the name was unchaged. |
cdnURL (string) | 0/1 | This method returns the manually set CDN URL. The manual CDN URL defines where the file is stored on the CDN. The variable manualCdnURL ismapped to the database as CDN_URL in the OCM_PHYSICAL_ASSET table. The function name is also equivalent to getmanualCdnURL() however tokeep backwards compatibility with schema and method calls the name was unchanged. |
publicUrl (string) | 0/1 | Returns the public URL value aka the dynamically generated URL value.More details on generation of the value in the setter method. |
publicCdnUrl (string) | 0/1 | Gets public CDN URL field value aka dynamically generated CDN URL fieldMore information on how the public CDN URL is generated in the setter method. |
tokenizedUrl (string) | 0/1 | Transient xml element for Feed to display the URL field. |
checkSum (string) | 0/1 | Gets value of checksum field (max length = 255) |
fileSize (long) | 0/1 | Gets fileSize in bytes (valid values = between 0 to 2^63 - 1) |
mimeType (string) | 0/1 | Gets mimeType field (max length = 255) |
pcFileName (string) | 0/1 | Gets pcFileName OC 3.5 compatibility field. (max length = 500)The file name under which a download client should locally store a video on a client's PC. Just the file name, this dates back to the OCMedia Agent when downloads were stored in the storage that was accessible to Silverlight and the names of the files were obfuscated toprevent piracy. |
deviceGroup (string) | 0/1 | Gets the device group that the physical asset belongs to |
isEncrypted (boolean) | 0/1 | Gets isEncrypted field, whether this asset is encrypted or not |
encryptionData (string) | 0/1 | Gets the encryption data related to the physical asset |
encryptionImplementationTechnology (string) | 0/1 | Gets the encryption implementation technology |
licenseRequestData (string) | 0/1 | (no documentation provided) |
contentID (string) | 0/1 | Gets the contentID field that stores the key ID, This field is used in ABRE encryption. |
mosContentID (string) | 0/1 | Gets the MOS Content ID field that stores the key ID for MOS content. |
isSourceAsset (boolean) | 0/1 | Gets isSourceAsset which determines if it's a sourceAsset that's generated by Armada.Additionally value Boolean#TRUE can be used to specify the Physical Asset is created from ADI/hotfolder file.While value Boolean#FALSE can be used to specify the Physical Asset is created by CAV or MOS. |
contentFileUUID (string) | 0/1 | Gets UUID value of the content file |
originBaseURL (string) | 0/1 | Gets originBaseURL field (max length = 255)The base URL of the origin server that is the asset's entry point to the CDN. Used for origin mapping |
originResourceURL (string) | 0/1 | Gets the originResourceURL fieldThe resource url for this asset that can be appended to the origin base url to create the complete origin mapping |
deleteURL (string) | 0/1 | Gets the delete url for the asset |
keySetID (string) | 0/1 | (no documentation provided) |
isSignedByOriginMapping (boolean) | 0/1 | Gets whether the asset has a origin mapping related to it or not |
urlSignerConfiguration (UrlSignerConfiguration) | 0/1 | Gets the URL signer configuration object associated with this physical asset. |
targetDevices/targetDevice (TargetDevice) | 0/unbounded | Gets the targetDevices associated with this PhysicalAsset |
assetFormats/assetFormat (AssetFormat) | 0/unbounded | Retrieves AssetFormats associated with this PhysicalAsset |
ratings/rating (Rating) | 0/unbounded | Returns the ratings associated with this PhysicalAsset |
assetClassification (string) | 0/1 | Gets value of assetClassification field (max length = 255) |
providers/provider (Provider) | 0/unbounded | Gets the Provider associated with this PhysicalAsset. NOTE: The number of providers per bundle is limited to one. |
Type PhysicalAssetApp
- Extends: PhysicalAsset
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
platform (string) | 0/1 | Gets the App Platform. |
commandLineArgs (string) | 0/1 | Gets the physical asset app command line arguments. |
Type PhysicalAssetAudio
- Extends: PhysicalAsset
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
audioCodec (string) | 0/1 | Gets the component's audio codec. |
audioBitRate (int) | 0/1 | Gets the audio bit rate value for this component. |
audioSampleRate (int) | 0/1 | Gets the audio sample rate value for this component. |
audioBitRateType (string) | 0/1 | Gets the audio bit rate type for this component. |
audioChannelCount (int) | 0/1 | Gets the audio channel count for this component. |
deliveryType (string) | 0/1 | Gets the delivery type used by this component to deliver audio. |
Type PhysicalAssetDocument
- Extends: PhysicalAsset
Type PhysicalAssetImage
- Extends: PhysicalAsset
Entity Class for Physical Asset Image
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
height (int) | 0/1 | Gets the height of image. |
width (int) | 0/1 | Gets the width of image. |
displayAspectRatio (string) | 0/1 | Gets the display aspect ratio. |
encodingType (string) | 0/1 | Gets the encoding type of image. |
tier (string) | 0/1 | Gets the tier of image. |
locale (Locale) | 0/1 | Gets the locale for the physical asset image. |
imageTypes/imageType (ImageType) | 0/unbounded | Gets the imageTypes for the physical asset image. |
Type PhysicalAssetManifest
- Extends: AbstractPhysicalAssetVideo
Entity Class for Physical Asset Manifest.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
manifestType (string) | 0/1 | Gets the manifest type. |
Type PhysicalAssetSubtitle
- Extends: PhysicalAsset
Entity Class for Physical Asset Subtitle.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
locale (Locale) | 0/1 | Gets the locale. |
format (string) | 0/1 | Gets the format. |
Type PhysicalAssetVideo
- Extends: AbstractPhysicalAssetVideo
Entity class for Physical Asset Video.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
deliveryType (string) | 0/1 | Gets the delivery type. |
Type PlayReadyDomain
- Extends: PlayReadyStreaming
Container class for DRM terms for generating PlayReady Domain licenses.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
allowCopyToAACS (boolean) | 0/1 | Get the flag that indicates whether copy to Advanced Access Content System is allowed |
allowCopyToCPRM (boolean) | 0/1 | Get the flag that indicates whether copy to Content Protection Recordable Media is allowed |
allowCopyToCSS (boolean) | 0/1 | Get the flag that indicates whether copy to Content Scrambling System is allowed |
allowCopyToHelix (boolean) | 0/1 | Get the flag that indicates whether copy to Copy to Helix is allowed |
allowCopyToOrangeBookCD (boolean) | 0/1 | Get the flag that indicates whether copy to Orange Book CD is allowed |
allowCopyToSDCC (boolean) | 0/1 | Get the flag that indicates whether copy to Secure Digital Container for Copy is allowed |
allowCopyToSDCCP (boolean) | 0/1 | Get the flag that indicates whether copy to Secure Digital Container for Copy with Preview is allowed |
allowCopyToSDCLC (boolean) | 0/1 | Get the flag that indicates whether copy to Secure Digital Container for Limited Copy is allowed |
allowPlaybackOnDTCP (boolean) | 0/1 | Get the flag that indicates whether playback on DTCP is allowed |
allowPlaybackOnHelix (boolean) | 0/1 | Get the flag that indicates whether playback on Helix is allowed |
allowPlaybackOnUnknown (boolean) | 0/1 | Get the flag that indicates whether playback on unknown outputs is allowed |
constrainPlaybackOnUnknown (boolean) | 0/1 | Get the flag that indicates whether playback to unknown outputs should be constrained |
licenseType (string) | 0/1 | Get a constant String indicating the License Type (Persistent or Non-Persistent). Value will be one of:
|
timeZoneBehavior (string) | 0/1 | Get the constant that indicates the timezone behavior type that should be used by the system when licenses are generated using the termscontained by an instance of this class. The value will be one of the following:
|
timeZoneId (string) | 0/1 | If 'drm.terms.timezonebehavior.type.select' is the timezone behavior get the identifier for the selected timezone. |
firstPlayExpiration (int) | 0/1 | Get the number of seconds after first play that the license will expire |
gracePeriod (int) | 0/1 | Get the grace period after clock changes after which the license will expire. |
issueWindowEnd (string) | 0/1 | Gets a String constant indicating how the end date of the license should be calculated. Valid values:
|
issueWindowEndAfterNDays (int) | 0/1 | Gets the number of days after being stored that the license will expire. |
issueWindowEndDate (dateTime) | 0/1 | Get the specific date on which the license will expire if the issue window end type 'End on [date picker] is selected |
issueWindowStart (string) | 0/1 | Get a String constant indicating how the system will calculate the start date of a license generated with this terms object. Valid values:
|
issueWindowStartDate (dateTime) | 0/1 | Gets the start date if the selected issue window start is 'date' |
issueWindowStartFailover (string) | 0/1 | Gets the issue window start failover type. Valid values:
|
issueWindowStartFailoverDate (dateTime) | 0/1 | If issue window start failover type is 'Date', gets the date for failover start |
issueWindowEndFailover (string) | 0/1 | Gets the issue window end failover type. Valid values:
|
issueWindowEndFailoverDate (dateTime) | 0/1 | If issue window end failover type is 'Date', gets the date for failover end |
issueWindowEndFailoverNDays (int) | 0/1 | Gets the number of days specified if failover end type is 'N-days' |
agcAndColorStrips (string) | 0/1 | Gets the value of the AGC and Colorstrips output protection level (See Microsoft PlayReady Compliance Rules document for details on validvalues). |
analogTV (string) | 0/1 | Gets the value of the Analog TV output protection level (See Microsoft PlayReady Compliance Rules document for details on valid values). |
analogTVUseBestEffort (boolean) | 0/1 | Gets the value of the Analog TV Best Effort output protection level (See Microsoft PlayReady Compliance Rules document for details onvalid values). |
analogVideo (string) | 0/1 | Gets the value of the Analog Video output protection level (See Microsoft PlayReady Compliance Rules document for details on validvalues). |
componentVideo (boolean) | 0/1 | Gets the value of the Component Video output protection level (See Microsoft PlayReady Compliance Rules document for details on validvalues). |
compressedDigitalAudio (string) | 0/1 | Gets the value of the Compressed Digital Audio output protection level (See Microsoft PlayReady Compliance Rules document for details onvalid values). |
compressedDigitalVideo (string) | 0/1 | Gets the value of the Compressed Digital Video output protection level (See Microsoft PlayReady Compliance Rules document for details onvalid values). |
computerMonitor (boolean) | 0/1 | Gets the value of the Computer Monitor output protection level (See Microsoft PlayReady Compliance Rules document for details on validvalues). |
scms (string) | 0/1 | Gets the value of the SCMS output protection level (See Microsoft PlayReady Compliance Rules document for details on valid values). |
uncompressedDigitalAudio (string) | 0/1 | Gets the value of the Uncompressed Digital Audio output protection level (See Microsoft PlayReady Compliance Rules document for details onvalid values). |
uncompressedDigitalVideo (string) | 0/1 | Gets the value of the Uncompressed Digital Video output protection level (See Microsoft PlayReady Compliance Rules document for details onvalid values). |
Type PlayReadyDownload
- Extends: PlayReadyDomain
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
allowCopyToDevice (boolean) | 0/1 | (no documentation provided) |
allowCopyToPC (boolean) | 0/1 | (no documentation provided) |
copyCount (int) | 0/1 | (no documentation provided) |
Type PlayReadyStreaming
- Extends: abstractDrmTermsBean
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
minimumSecurity (string) | 0/1 | (no documentation provided) |
Type Policy
policy entity class
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
policyPk (int) | 0/1 | PolicyPk getter |
name (string) | 1/1 | name getter |
description (string) | 0/1 | description getter |
offerWindowStartXml (string) | 0/1 | offerWindowStartXml getter |
offerWindowEndXml (string) | 0/1 | offerWindowEndXml getter |
isActive (boolean) | 1/1 | isActive getter |
isSubscription (boolean) | 1/1 | isSubscription getter |
drmProfile (DrmProfile) | 0/1 | DrmProfile getter |
adSlotSet (AdSlotSet) | 0/1 | AdSlotSet getter |
offerType (OfferTypeEnum) | 0/1 | offerType getter |
entitlementProfile (EntitlementProfile) | 0/1 | entitilementProfile getter |
affiliates (Affiliate) | 0/unbounded | affiliates getter |
charge (Charge) | 0/1 | charge getter |
uuid (string) | 1/1 | UUID getter |
offerWindowStart (OfferWindowValue) | 0/1 | offerWindowStart getter |
offerWindowEnd (OfferWindowValue) | 0/1 | offerWindowEnd getter |
Type PriceCategory
- Extends: CommonEntity
The PriceCategory entity is a common entity that contains an association between a price point and a currency.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
categoryName (string) | 1/1 | Gets the category name. |
price (float) | 1/1 | Gets the price. |
currency (Currency) | 1/1 | Gets the Currency. |
tierCode (string) | 0/1 | Get Tier code |
regionCode (string) | 0/1 | Get Reigon code |
Type Product
Products are created by applying one or more policies to bundles to create monetizable offerings that can be output in feeds and may bepresented on storefronts or web portals.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
productPk (int) | 0/1 | Gets the primary key of this product. |
name (string) | 1/1 | Gets the name of this product. |
uuid (string) | 1/1 | Gets the uuid of this product. |
offerWindowStartDate (dateTime) | 0/1 | Gets the starting date for the offer window time range. |
offerWindowEndDate (dateTime) | 0/1 | Gets the ending date for the offer window time range. |
policy (Policy) | 1/1 | Gets the policy attached to this product. |
bundlePk (int) | 1/1 | Gets the primary key of the bundle attached to this product. |
bundleContentProvider (Provider) | 1/1 | Gets the provider of the bundle attached to this product. |
affiliates (Affiliate) | 0/unbounded | Gets the set of affiliates related to this product. |
isActive (boolean) | 1/1 | Gets the boolean indicating whether this product is active(true) or not(false). |
isSubscriptionPollOn (boolean) | 0/1 | Gets the boolean indicating whether subscription pool is on(true) / off(false). |
offerType (OfferTypeEnum) | 0/1 | Gets the offer type of this product. |
lastModified (dateTime) | 0/1 | Gets the last modified date. |
productLifecycleMetadas (ProductLifecycleMetadata) | 0/unbounded | Gets the set of product lifecycle metadatas. |
externalID (string) | 0/1 | Gets the externalID of this product. |
type (ChargeType) | 0/1 | Gets the charge type of this product. |
amount (double) | 0/1 | Gets the amount of this product. |
repeatCount (int) | 0/1 | Gets the repeat count for this product. |
currency (Currency) | 0/1 | Gets the currency for this product. |
subscriptionPriority (int) | 0/1 | Gets the subscription priority |
dateDeactivated (dateTime) | 0/1 | Gets the date this policy was deactivated. |
Type ProductLifecycleMetadata
The ProductLifecycleMetadata class represents product lifecycle metadata object.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
productMetadataPk (int) | 0/1 | Gets primary key for product lifecycle metadata. |
name (string) | 0/1 | Gets lifecycle metadata's name. |
value (string) | 0/1 | Gets lifecycle metadata's value. |
Type ProgramIdentifier
- Extends: Identifier
This class is used to represent an EPG Program identifier as it relates to VMS EPG module, not to a specific EPG vendor. This identifier isused to tie together EPG programs defined in EPG module to bundles created in Content Manager that represent the same programs for VODconsumption. Relationship between the EPG module programs and ContentManager bundles is established by adding this identifier to Bundlesidentifiers.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
epgProgramId (string) | 0/1 | Get the EPG program identifier that uniquely identifies a broadcast program. The format of the value of this identifier depends on the EPGprovider used in EPG module. |
epgSeasonId (string) | 0/1 | Get the season id that the broadcast program referenced by this identifier belongs to. |
epgSeriesId (string) | 0/1 | Get the series id that the broadcast program referenced by this identifier belongs to. |
Type Provider
- Extends: CommonEntity
The Provider entity specifies a category for an asset.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
providerName (string) | 1/1 | Represents name of Provider entity. |
Type Rating
- Extends: CommonEntity
The Rating entity contain a standing information.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
ratingName (string) | 1/1 | Gets ratingName of entity. |
ratingBody (string) | 0/1 | Gets rating body. |
reason (string) | 0/1 | Gets reason value. |
Type RatingFilterData
- Extends: abstractFilterData
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
commonEntityPks/commonEntityPk (int) | 0/unbounded | (no documentation provided) |
restrictionType (restrictionType) | 0/1 | (no documentation provided) |
filterType (string) | 0/1 | (no documentation provided) |
Type RenderHint
- Extends: CommonEntity
The RenderHint is a container for Render Hint common entity
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
renderHintType (string) | 1/1 | Gets the RenderHintType |
name (string) | 1/1 | Gets Render Hint name |
value (string) | 1/1 | Gets Render Hint value |
Type ResourceKey
Model class representing the ResourceKey
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
resourceKeyPk (int) | 0/1 | Get the primary key of ResourceKey |
key (string) | 0/1 | Get the String representation of the key for ResourceKey |
resourceLabels/resourceLabel (ResourceLabel) | 0/unbounded | Get the ResourceLabels associated with the current ResourceKey |
Type ResourceLabel
Model class representing ResourceLabel
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
resourceLabelPk (int) | 0/1 | Get the primary key of the ResourceLabel |
label (string) | 0/1 | Get the string representation of the ResourceLabel |
language (string) | 0/1 | Get the language of the ResourceLabel |
Type RestrictTo
- Extends: CommonEntity
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
name (string) | 1/1 | (no documentation provided) |
value (string) | 0/1 | (no documentation provided) |
Type Schedule
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
startDate (string) | 0/1 | Gets schedule start date. |
endDate (string) | 0/1 | Gets schedule end date. |
Type SearchBundleResult
- Extends: SearchResult
Contains results of an executed search. The search results can be any bundle.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
solrHitsCount (int) | 1/1 | (no documentation provided) |
searchResults (Bundle) | 0/unbounded | Gets the search results list |
Type SearchCommonEntityResult
- Extends: SearchResult
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
searchResults (CommonEntity) | 0/unbounded | Gets the search results list |
Type SearchComponentResult
- Extends: SearchResult
Contains results of an executed search. The search results can be any component.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
searchResults (Component) | 0/unbounded | Gets the search results list |
Type SearchProductResult
- Extends: SearchResult
Contains results of an executed search. The search results can be any bundle.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
searchResults (Product) | 0/unbounded | Gets the search results list |
Type StationIdentifier
- Extends: Identifier
This class is used to represent an EPG Station identifier as it relates to VMS EPG module. This identifier is used to tie together EPG Station(also referred to as a Service) defined in EPG module by a feed provider to bundles created in Content Manager that represent the samebroadcast Station. Station Bundles in Content Manager can be used to display in catalog and to grant access to extended information for OTTpurposes (streaming URL, Facebook link,...). Relationship between the EPG module programs and Content Manager bundles is established by addingthis identifier to Bundles identifiers.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
epgServiceId (string) | 0/1 | (no documentation provided) |
Type Studio
- Extends: CommonEntity
The Studio Common Entity - A STUDIO entity represents the studio house that is producing the asset.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
code (string) | 1/1 | Gets the code of the studio that is producing the asset. |
Type Style
- Extends: CommonEntity
The Style entity specify a category for an asset.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
styleName (string) | 1/1 | Gets style name. |
Type SubscriptionCode
Subscription codes are entities that can be attached to bundles to denote that they are part of a particular subscription package.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
subscriptionCodePk (int) | 0/1 | (no documentation provided) |
name (string) | 0/1 | (no documentation provided) |
code (string) | 1/1 | (no documentation provided) |
description (string) | 0/1 | (no documentation provided) |
uuid (string) | 0/1 | (no documentation provided) |
Type SubscriptionPolicy
Represents the Subscription Policy found in Entitlement > Productization > Subscriptions > Subscription PolicySubscription Policies dictate which Product Resolution Plugin to execute during Entitlement Check, whether or not to run additionalEntitlement Checks for products (via Entitlement Check Plugins), and the Subscription Product Priority (i.e., which product would we returnback to the consumer if they own many relevant entitled products).
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
subscriptionPolicyPk (int) | 0/1 | Gets the subscription policy primary key. |
productResolutionPlugin (ProductResolutionPlugin) | 1/1 | Gets the product resolution plug-in. |
entitlementCheck (boolean) | 1/1 | A boolean indicating whether the subscription policy requires entitlement checks. |
lastModified (dateTime) | 0/1 | Gets the subscription policy's last modified date. |
Type SubtitleLanguage
- Extends: CommonEntity
The Language entity holds string representation of language.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
language (string) | 1/1 | Gets name of language. |
Type Talent
- Extends: CommonEntity
The Talent entity contain the association between person and role.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
person (Person) | 1/1 | Gets person entity. |
talentRole (TalentRole) | 0/1 | Gets talentRole entity. |
Type TalentRole
The TalentRole entity contain a role or character to associate to a person.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
talentRolePk (int) | 0/1 | Gets entity PK. |
roleName (string) | 1/1 | Gets role name. |
Type TargetDevice
- Extends: CommonEntity
The Target Device entity will be added to the Content Manager model to allow PhysicalAssets to be classified to support Device Tailoring.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
name (string) | 1/1 | Gets name. |
manufacturer (string) | 0/1 | Gets manufacturer. |
type (string) | 0/1 | R Gets type. |
os (string) | 0/1 | Gets os. |
minOSVersion (string) | 0/1 | Gets min OS version. |
maxOSVersion (string) | 0/1 | Gets max OS version. |
Type TribuneMediaServiceProgramIdentifier
- Extends: Identifier
This class is used to represent a TSM Program identifier as defined by Tribune Media Services (TMS). This identifier captures not only theunique identification of the asset within the system, but also holds additional connection (relational) information to other assets within theTribune data set. This identifier can be attached to a Content Manager Bundle for the purpose of linking to an EPG program represented by thebundle if it is known that EPG feed provider in use is TMS.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
tmsId (string) | 0/1 | Get the primary unique identifier for the program.
|
rootId (string) | 0/1 | Get a TMS identifier for this work that spans all version of the work. |
connectorId (string) | 0/1 | Get a TMS identifier that connects to a parent record within TMS or a connector instance in the on_connectors TMS product. |
seriesId (string) | 0/1 | Get the series id that the broadcast program referenced by this identifier belongs to. |
seasonId (string) | 0/1 | Get the season id that the broadcast program referenced by this identifier belongs to. |
versionId (string) | 0/1 | Get a TMS identifier for a specific version of a work. |
alternateFilmId (string) | 0/1 | Get a TMS specific alternate film identifier. |
Type TribuneMediaServiceStationIdentifier
- Extends: StationIdentifier
This class is used to represent a TSM Station (also referred to as a Service or a programming Service) identifier as defined by Tribune MediaServices (TMS).
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
programmingServiceId (string) | 0/1 | Get the station (programming service) identifier that uniquely identifies a station. |
alternateSourceId (string) | 0/1 | Get a TMS alternate identifier for programming service. |
Type TypeDiscriminator
Listing of AbstractType Type Discriminator value
Possible Values
value | description |
---|---|
CLASSIFICATION | Classification |
CLASSIFICATION_CONTAINER | Classification Container |
CLASSIFICATION_NODE_LEAF | Classification Node Leaf |
CLASSIFICATION_NODE_BRANCH | Classification Node Branch |
CLASSIFICATION_NODE_BRANCH_CONTAINER | Classification Node Branch Container |
CLASSIFICATION_METADATA | Classification Metadata |
CLASSIFICATION_MEDIA | Classification Media |
ASSETS | Assets |
CHILD_CLASSIFICATION_NODES | Child Classification Nodes |
CLASSIFICATION_CONTAINER_FOLDER | Classification Container Folder |
CLASSIFICATION_FOLDER | Classification Folder |
CLASSIFICATION_ATTRIBUTE | Classification Attribute |
CLASSIFICATION_NODE_ATTRIBUTE | Classification Node Attribute |
CLASSIFICATION_NODE_METADATA | Classification Node Metadata |
VIDEOS | Videos |
VIDEO_PREVIEWS | Video Previews |
Type UrlSigner
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
urlSignerPk (int) | 0/1 | (no documentation provided) |
description (string) | 0/1 | (no documentation provided) |
name (string) | 1/1 | (no documentation provided) |
urlSignerSettingsClass (string) | 1/1 | (no documentation provided) |
urlSignerClass (string) | 1/1 | (no documentation provided) |
uuid (string) | 0/1 | Get UUID. |
Type UrlSignerConfiguration
URL Signer Configuration provides the configuration to be used by URL signing, which works in conjunction with CDS-IS to fulfill video contentrequests in a secure manner.
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
urlSignerConfigurationPk (int) | 0/1 | (no documentation provided) |
name (string) | 1/1 | (no documentation provided) |
uuid (string) | 1/1 | (no documentation provided) |
urlSigner (UrlSigner) | 1/1 | (no documentation provided) |
isActive (boolean) | 1/1 | (no documentation provided) |
isEnabled (boolean) | 1/1 | (no documentation provided) |
lastModified (dateTime) | 1/1 | (no documentation provided) |
urlSignerSettingsObject (URLSignerSettings) | 1/1 | (no documentation provided) |
Type WidevineDrmTerms
- Extends: abstractDrmTermsBean
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
enableHeartbeat (boolean) | 0/1 | Determines if a client will send a heartbeat request to the server. |
heartbeatInterval (int) | 0/1 | Gets the interval in seconds the client will send a heartbeat request in. |
heartbeatUrl (string) | 0/1 | The URL the client will send heartbeat requests to. |
maxBitRate (int) | 0/1 | Set the maximum bit rate for asset playback. |
policyName (string) | 0/1 | Gets the mapped name of the Widevine policy. |
Type WmrmDrmTerms
- Extends: abstractDrmTermsBean
Class of Wmrm Drm term
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
allowBackupRestore (boolean) | 0/1 | (no documentation provided) |
allowCollaborativePlay (boolean) | 0/1 | (no documentation provided) |
allowCopy (boolean) | 0/1 | (no documentation provided) |
allowOutputToCPRM (boolean) | 0/1 | (no documentation provided) |
allowOutputToDTCP (boolean) | 0/1 | (no documentation provided) |
allowPlaylistBurn (boolean) | 0/1 | (no documentation provided) |
allowTransferToNonSDMI (boolean) | 0/1 | (no documentation provided) |
allowTransferToSDMI (boolean) | 0/1 | (no documentation provided) |
clockRollback (string) | 0/1 | (no documentation provided) |
clockRollbackAfter (int) | 0/1 | (no documentation provided) |
copyCount (int) | 0/1 | (no documentation provided) |
expiration (string) | 0/1 | (no documentation provided) |
expirationAfterNHours (int) | 0/1 | (no documentation provided) |
extendedAnalogVideoProtection (string) | 0/1 | (no documentation provided) |
issueWindowEnd (string) | 0/1 | (no documentation provided) |
issueWindowEndAfterNDays (int) | 0/1 | (no documentation provided) |
issueWindowEndDate (dateTime) | 0/1 | Issue Window End - Date |
issueWindowStart (string) | 0/1 | (no documentation provided) |
issueWindowStartDate (dateTime) | 0/1 | Issue Window Start - Date, shown if date is selected |
issueWindowStartFailover (string) | 0/1 | (no documentation provided) |
issueWindowStartFailoverDate (dateTime) | 0/1 | Failover start date Issue Window Start - Date, shown if date is selected |
issueWindowEndFailover (string) | 0/1 | (no documentation provided) |
issueWindowEndFailoverDate (dateTime) | 0/1 | Issue Window end - Date, shown if date is selected |
issueWindowEndFailoverNDays (int) | 0/1 | (no documentation provided) |
licensePriority (int) | 0/1 | (no documentation provided) |
maxPlaylistBurnCount (int) | 0/1 | (no documentation provided) |
minimumAppSecurity (string) | 0/1 | (no documentation provided) |
playCount (int) | 0/1 | (no documentation provided) |
playlistBurnTrackCount (int) | 0/1 | (no documentation provided) |
playRestrictionAnalogVideo (string) | 0/1 | (no documentation provided) |
playRestrictionCompressedDigitalAudio (string) | 0/1 | (no documentation provided) |
playRestrictionCompressedDigitalVideo (string) | 0/1 | (no documentation provided) |
playRestrictionUnCompressedDigitalAudio (string) | 0/1 | (no documentation provided) |
playRestrictionUncompressedDigitalVideo (string) | 0/1 | (no documentation provided) |
reissueCount (int) | 0/1 | (no documentation provided) |
requireMetering (boolean) | 0/1 | (no documentation provided) |
sapAllowDigitalOut (boolean) | 0/1 | (no documentation provided) |
sapCheckDriverCert (boolean) | 0/1 | (no documentation provided) |
sapMinDriverSecurity (string) | 0/1 | (no documentation provided) |
sapSetSAPMode (boolean) | 0/1 | (no documentation provided) |
transferCount (int) | 0/1 | (no documentation provided) |
timeZoneBehavior (string) | 0/1 | (no documentation provided) |
timeZoneId (string) | 0/1 | (no documentation provided) |
Type XlsParserConfig
Entity for excel spreadsheet XML configuration
Child Elements
name (type) | min/max occurs |
description |
---|---|---|
xlsParserConfigPk (int) | 0/1 | (no documentation provided) |
name (string) | 1/1 | (no documentation provided) |
xmlConfig (string) | 0/1 | (no documentation provided) |
status (boolean) | 1/1 | (no documentation provided) |
uuid (string) | 0/1 | UUID getter |
lastModified (dateTime) | 1/1 | (no documentation provided) |
defaultLocale (Locale) | 1/1 | (no documentation provided) |
bundleTypeName (string) | 0/1 | (no documentation provided) |