General

Download URL: http://videos.izmotion.com/api_v3/index.php/service/schema/action/serve/type/bulkUploadXml.bulkUploadResultXML/name/bulkUploadXml.bulkUploadResultXML.xsd
Version: 1.0

<xs:schema version="1.0">
<xs:complexType name="T_mrss">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="1" ref="channel"> </xs:element>

<xs:element maxOccurs="unbounded" minOccurs="0" ref="mrss-extension"></xs:element>
</xs:sequence>

<xs:attribute name="version" type="xs:string" use="optional"> </xs:attribute>
</xs:complexType>

<xs:complexType name="T_channel">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="1" ref="item"> </xs:element>

<xs:element maxOccurs="unbounded" minOccurs="0" ref="channel-extension"></xs:element>
</xs:sequence>
</xs:complexType>

<xs:complexType name="T_item">
<xs:sequence>
<xs:element maxOccurs="1" minOccurs="1" ref="result"> </xs:element>

<xs:element maxOccurs="1" minOccurs="1" name="action">

<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="add"></xs:enumeration>

<xs:enumeration value="update"></xs:enumeration>

<xs:enumeration value="delete"></xs:enumeration>
</xs:restriction>
</xs:simpleType>
</xs:element>

<xs:element maxOccurs="1" minOccurs="1" name="entryId" nillable="false">

<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="20"></xs:maxLength>
</xs:restriction>
</xs:simpleType>
</xs:element>

<xs:element maxOccurs="1" minOccurs="0" name="referenceID" type="xs:string"> </xs:element>

<xs:element maxOccurs="1" minOccurs="1" name="createdAt" type="xs:int"> </xs:element>

<xs:element maxOccurs="1" minOccurs="1" name="updatedAt" type="xs:int"> </xs:element>

<xs:element maxOccurs="1" minOccurs="1" name="title">

<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="60"></xs:maxLength>
</xs:restriction>
</xs:simpleType>
</xs:element>

<xs:element maxOccurs="1" minOccurs="1" name="type" type="KalturaEntryType"> </xs:element>

<xs:element maxOccurs="1" minOccurs="1" name="licenseType" type="KalturaLicenseType"> </xs:element>

<xs:element maxOccurs="1" minOccurs="1" name="userId" type="xs:string"> </xs:element>

<xs:element maxOccurs="1" minOccurs="1" name="name">

<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="60"></xs:maxLength>
</xs:restriction>
</xs:simpleType>
</xs:element>

<xs:element maxOccurs="1" minOccurs="1" name="status" type="KalturaEntryStatus"> </xs:element>

<xs:element maxOccurs="1" minOccurs="0" name="description" type="xs:string"> </xs:element>

<xs:element maxOccurs="1" minOccurs="0" name="thumbnailUrl">

<xs:complexType>
<xs:attribute name="url" type="xs:string"></xs:attribute>
</xs:complexType>
</xs:element>

<xs:element maxOccurs="1" minOccurs="0" ref="tags"> </xs:element>

<xs:element maxOccurs="unbounded" minOccurs="0" ref="category"> </xs:element>

<xs:element maxOccurs="1" minOccurs="0" name="partnerData" type="xs:string"> </xs:element>

<xs:element maxOccurs="1" minOccurs="0" name="partnerSortData" type="xs:int"> </xs:element>

<xs:element maxOccurs="1" minOccurs="0" name="accessControlId" type="xs:int"> </xs:element>

<xs:element maxOccurs="1" minOccurs="0" name="conversionProfileId" type="xs:int"> </xs:element>

<xs:element maxOccurs="1" minOccurs="0" name="startDate" type="xs:int"> </xs:element>

<xs:element maxOccurs="1" minOccurs="0" name="endDate" type="xs:int"> </xs:element>

<xs:choice maxOccurs="1" minOccurs="0">
<xs:element maxOccurs="1" minOccurs="1" ref="media"> </xs:element>
</xs:choice>

<xs:choice maxOccurs="unbounded" minOccurs="0">
<xs:element maxOccurs="1" minOccurs="1" ref="content"> </xs:element>

<xs:element maxOccurs="1" minOccurs="1" ref="thumbnail"> </xs:element>
</xs:choice>

<xs:element maxOccurs="unbounded" minOccurs="0" ref="item-extension"></xs:element>
</xs:sequence>
</xs:complexType>

<xs:complexType name="T_tags">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="1" name="tag" type="xs:string"> </xs:element>
</xs:sequence>
</xs:complexType>

<xs:complexType name="T_result">
<xs:sequence>
<xs:element maxOccurs="1" minOccurs="1" name="errorDescription" type="xs:string"> </xs:element>
</xs:sequence>
</xs:complexType>

<xs:complexType name="T_category">
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="name" type="xs:string" use="required"> </xs:attribute>
</xs:extension>
</xs:simpleContent>
</xs:complexType>

<xs:complexType name="T_media">
<xs:sequence>
<xs:element maxOccurs="1" minOccurs="1" name="mediaType" type="KalturaMediaType"> </xs:element>

<xs:element maxOccurs="1" minOccurs="1" name="duration" type="xs:int"> </xs:element>

<xs:element maxOccurs="1" minOccurs="1" name="flavorParamsIds" type="xs:string"> </xs:element>

<xs:element maxOccurs="unbounded" minOccurs="0" ref="media-extension"></xs:element>
</xs:sequence>
</xs:complexType>

<xs:complexType name="T_thumbnail">
<xs:sequence>
<xs:element maxOccurs="1" minOccurs="0" ref="tags"> </xs:element>

<xs:element maxOccurs="unbounded" minOccurs="0" ref="thumbnail-extension"></xs:element>
</xs:sequence>

<xs:attribute name="url" type="xs:string" use="required"> </xs:attribute>

<xs:attribute name="thumbAssetId" type="xs:string" use="required"> </xs:attribute>

<xs:attribute name="format" type="xs:string" use="required"> </xs:attribute>

<xs:attribute name="isDefault" type="xs:boolean" use="required"> </xs:attribute>

<xs:attribute name="height" type="xs:int" use="optional"> </xs:attribute>

<xs:attribute name="width" type="xs:int" use="optional"> </xs:attribute>

<xs:attribute name="thumbParamsId" type="xs:int" use="optional"> </xs:attribute>
</xs:complexType>

<xs:complexType name="T_content">
<xs:sequence>
<xs:element maxOccurs="1" minOccurs="0" ref="tags"> </xs:element>

<xs:element maxOccurs="unbounded" minOccurs="0" ref="content-extension"></xs:element>
</xs:sequence>

<xs:attribute name="url" type="xs:string" use="required"> </xs:attribute>

<xs:attribute name="flavorAssetId" type="xs:string" use="required"> </xs:attribute>

<xs:attribute name="containerFormat" type="xs:string" use="required"> </xs:attribute>

<xs:attribute name="format" type="xs:string" use="required"> </xs:attribute>

<xs:attribute name="extension" type="xs:string" use="required"> </xs:attribute>

<xs:attribute name="isSource" type="xs:boolean" use="required"> </xs:attribute>

<xs:attribute name="height" type="xs:int" use="optional"> </xs:attribute>

<xs:attribute name="width" type="xs:int" use="optional"> </xs:attribute>

<xs:attribute name="videoBitrate" type="xs:int" use="optional"> </xs:attribute>

<xs:attribute name="videoCodec" type="xs:string" use="optional"> </xs:attribute>

<xs:attribute name="audioBitrate" type="xs:int" use="optional"> </xs:attribute>

<xs:attribute name="audioCodec" type="xs:string" use="optional"> </xs:attribute>

<xs:attribute name="frameRate" type="xs:int" use="optional"> </xs:attribute>

<xs:attribute name="flavorParamsId" type="xs:int" use="optional"> </xs:attribute>

<xs:attribute name="flavorParamsName" type="xs:string" use="optional"> </xs:attribute>

<xs:attribute name="assetId" type="xs:string" use="optional"> </xs:attribute>
</xs:complexType>

<xs:element name="mrss" type="T_mrss"> </xs:element>

<xs:element name="channel" type="T_channel"> </xs:element>

<xs:element name="item" type="T_item"> </xs:element>

<xs:element name="result" type="T_result"> </xs:element>

<xs:element name="tags" type="T_tags"> </xs:element>

<xs:element name="category" type="T_category"> </xs:element>

<xs:element name="media" type="T_media"> </xs:element>

<xs:element name="content" type="T_content"> </xs:element>

<xs:element name="thumbnail" type="T_thumbnail"> </xs:element>

<xs:element name="mrss-extension"></xs:element>

<xs:element name="channel-extension"></xs:element>

<xs:element name="item-extension"></xs:element>

<xs:element name="media-extension"></xs:element>

<xs:element name="content-extension"></xs:element>

<xs:element name="thumbnail-extension"></xs:element>

<xs:element name="player-extension"></xs:element>

<xs:complexType name="T_subTitles">
<xs:sequence>
<xs:element name="action" minOccurs="0" maxOccurs="1">

<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="update"></xs:enumeration>
</xs:restriction>
</xs:simpleType>
</xs:element>

<xs:element ref="subTitle" maxOccurs="unbounded" minOccurs="0"> </xs:element>
</xs:sequence>
</xs:complexType>

<xs:complexType name="T_subTitle">
<xs:sequence>
<xs:element name="tags" minOccurs="1" maxOccurs="1" type="T_tags"> </xs:element>

<xs:choice minOccurs="1" maxOccurs="1">
<xs:element ref="serverFileContentResource" minOccurs="1" maxOccurs="1"> </xs:element>

<xs:element ref="urlContentResource" minOccurs="1" maxOccurs="1"> </xs:element>

<xs:element ref="remoteStorageContentResource" minOccurs="1" maxOccurs="1"> </xs:element>

<xs:element ref="remoteStorageContentResources" minOccurs="1" maxOccurs="1"> </xs:element>

<xs:element ref="entryContentResource" minOccurs="1" maxOccurs="1"> </xs:element>

<xs:element ref="assetContentResource" minOccurs="1" maxOccurs="1"> </xs:element>

<xs:element ref="contentResource-extension" minOccurs="1" maxOccurs="1"></xs:element>
</xs:choice>

<xs:element ref="subtitle-extension" minOccurs="0" maxOccurs="unbounded"></xs:element>
</xs:sequence>

<xs:attribute name="captionParamsId" type="xs:int" use="optional"> </xs:attribute>

<xs:attribute name="captionParams" type="xs:string" use="optional"> </xs:attribute>

<xs:attribute name="captionAssetId" type="xs:string" use="optional"> </xs:attribute>

<xs:attribute name="isDefault" type="xs:boolean" use="optional"> </xs:attribute>

<xs:attribute name="format" type="KalturaCaptionType" use="optional"> </xs:attribute>

<xs:attribute name="lang" type="KalturaLanguage" use="optional"> </xs:attribute>
</xs:complexType>

<xs:element name="subtitle-extension"></xs:element>

<xs:element name="subTitles" type="T_subTitles" substitutionGroup="item-extension"> </xs:element>

<xs:element name="subTitle" type="T_subTitle"> </xs:element>

<xs:complexType name="T_attachments">
<xs:sequence>
<xs:element name="action" minOccurs="0" maxOccurs="1">

<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="update"></xs:enumeration>
</xs:restriction>
</xs:simpleType>
</xs:element>

<xs:element ref="attachment" maxOccurs="unbounded" minOccurs="0"> </xs:element>
</xs:sequence>
</xs:complexType>

<xs:complexType name="T_attachment">
<xs:sequence>
<xs:element name="tags" minOccurs="0" maxOccurs="1" type="T_tags"> </xs:element>

<xs:choice minOccurs="1" maxOccurs="1">
<xs:element ref="serverFileContentResource" minOccurs="1" maxOccurs="1"> </xs:element>

<xs:element ref="urlContentResource" minOccurs="1" maxOccurs="1"> </xs:element>

<xs:element ref="remoteStorageContentResource" minOccurs="1" maxOccurs="1"> </xs:element>

<xs:element ref="remoteStorageContentResources" minOccurs="1" maxOccurs="1"> </xs:element>

<xs:element ref="entryContentResource" minOccurs="1" maxOccurs="1"> </xs:element>

<xs:element ref="assetContentResource" minOccurs="1" maxOccurs="1"> </xs:element>

<xs:element ref="contentResource-extension" minOccurs="1" maxOccurs="1"></xs:element>
</xs:choice>

<xs:element name="filename" minOccurs="0" maxOccurs="1" type="xs:string"> </xs:element>

<xs:element name="title" minOccurs="0" maxOccurs="1" type="xs:string"> </xs:element>

<xs:element name="description" minOccurs="0" maxOccurs="1" type="xs:string"> </xs:element>

<xs:element ref="attachment-extension" minOccurs="0" maxOccurs="unbounded"></xs:element>
</xs:sequence>

<xs:attribute name="attachmentAssetId" type="xs:string" use="optional"> </xs:attribute>

<xs:attribute name="format" type="KalturaAttachmentType" use="optional"> </xs:attribute>
</xs:complexType>

<xs:element name="attachment-extension"></xs:element>

<xs:element name="attachments" type="T_attachments" substitutionGroup="item-extension"> </xs:element>

<xs:element name="attachment" type="T_attachment" substitutionGroup="item-extension"> </xs:element>

<xs:element name="scene-customData" type="T_customData" substitutionGroup="scene-extension"> </xs:element>

<xs:complexType name="T_scenes">
<xs:sequence>
<xs:element name="action" minOccurs="0" maxOccurs="1">

<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="update"></xs:enumeration>
</xs:restriction>
</xs:simpleType>
</xs:element>

<xs:element ref="scene" minOccurs="0" maxOccurs="unbounded"> </xs:element>
</xs:sequence>
</xs:complexType>

<xs:complexType name="T_scene" abstract="true">
<xs:sequence>
<xs:element name="sceneStartTime" minOccurs="1" maxOccurs="1" type="xs:time"> </xs:element>

<xs:element ref="tags" minOccurs="0" maxOccurs="1"> </xs:element>
</xs:sequence>

<xs:attribute name="sceneId" use="optional">

<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="250"></xs:maxLength>
</xs:restriction>
</xs:simpleType>
</xs:attribute>

<xs:attribute name="systemName" use="optional">

<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="120"></xs:maxLength>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>

<xs:element name="scenes" type="T_scenes" substitutionGroup="item-extension"> </xs:element>

<xs:element name="scene" type="T_scene"> </xs:element>

<xs:element name="scene-extension"></xs:element>

<xs:complexType name="T_scene_adCuePointBulkUploadXml">
<xs:complexContent>
<xs:extension base="T_scene">
<xs:sequence>
<xs:element name="sceneEndTime" minOccurs="0" maxOccurs="1" type="xs:time"> </xs:element>

<xs:element name="sceneTitle" minOccurs="0" maxOccurs="1">

<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="250"></xs:maxLength>
</xs:restriction>
</xs:simpleType>
</xs:element>

<xs:element name="sourceUrl" minOccurs="0" maxOccurs="1" type="xs:string"> </xs:element>

<xs:element name="adType" minOccurs="1" maxOccurs="1" type="KalturaAdType"> </xs:element>

<xs:element name="protocolType" minOccurs="1" maxOccurs="1" type="KalturaAdProtocolType"> </xs:element>

<xs:element ref="scene-extension" minOccurs="0" maxOccurs="unbounded"></xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>

<xs:element name="scene-ad-cue-point" type="T_scene_adCuePointBulkUploadXml" substitutionGroup="scene"> </xs:element>

<xs:complexType name="T_scene_codeCuePointBulkUploadXml">
<xs:complexContent>
<xs:extension base="T_scene">
<xs:sequence>
<xs:element name="sceneEndTime" minOccurs="0" maxOccurs="1" type="xs:time"> </xs:element>

<xs:element name="code" minOccurs="0" maxOccurs="1">

<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="250"></xs:maxLength>
</xs:restriction>
</xs:simpleType>
</xs:element>

<xs:element name="description" minOccurs="0" maxOccurs="1" type="xs:string"> </xs:element>

<xs:element ref="scene-extension" minOccurs="0" maxOccurs="unbounded"></xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>

<xs:element name="scene-code-cue-point" type="T_scene_codeCuePointBulkUploadXml" substitutionGroup="scene"> </xs:element>

<xs:complexType name="T_scene_thumbCuePoint">
<xs:complexContent>
<xs:extension base="T_scene">
<xs:sequence>
<xs:element name="title" minOccurs="1" maxOccurs="1" type="xs:string"> </xs:element>

<xs:element name="description" minOccurs="1" maxOccurs="1" type="xs:string"> </xs:element>

<xs:element name="subType" minOccurs="0" maxOccurs="1" type="KalturaThumbCuePointSubType"> </xs:element>

<xs:element maxOccurs="1" minOccurs="0" ref="slide"></xs:element>

<xs:element ref="scene-extension" minOccurs="0" maxOccurs="unbounded"></xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>

<xs:complexType name="T_slide">
<xs:sequence>
<xs:choice maxOccurs="1" minOccurs="0">
<xs:element maxOccurs="1" minOccurs="0" ref="urlContentResource"></xs:element>

<xs:element maxOccurs="1" minOccurs="0" ref="remoteStorageContentResource"></xs:element>

<xs:element maxOccurs="1" minOccurs="0" ref="remoteStorageContentResources"></xs:element>

<xs:element maxOccurs="1" minOccurs="0" ref="assetContentResource"></xs:element>

<xs:element maxOccurs="1" minOccurs="0" ref="entryContentResource"></xs:element>

<xs:element maxOccurs="1" minOccurs="0" ref="contentResource-extension"></xs:element>
</xs:choice>
</xs:sequence>

<xs:attribute name="timedThumbAssetId" type="xs:string" use="optional"></xs:attribute>
</xs:complexType>

<xs:element name="scene-thumb-cue-point" type="T_scene_thumbCuePoint" substitutionGroup="scene"> </xs:element>

<xs:element name="slide" type="T_slide"> </xs:element>

<xs:complexType name="T_scene_annotationBulkUploadXml">
<xs:complexContent>
<xs:extension base="T_scene">
<xs:sequence>
<xs:element name="sceneEndTime" minOccurs="1" maxOccurs="1" type="xs:time"> </xs:element>

<xs:element name="sceneText" minOccurs="0" maxOccurs="1" type="xs:string"> </xs:element>

<xs:choice minOccurs="0" maxOccurs="1">
<xs:element name="parent" minOccurs="1" maxOccurs="1">

<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="120"></xs:maxLength>
</xs:restriction>
</xs:simpleType>
</xs:element>

<xs:element name="parentId" minOccurs="1" maxOccurs="1">

<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="250"></xs:maxLength>
</xs:restriction>
</xs:simpleType>
</xs:element>
</xs:choice>

<xs:element ref="scene-extension" minOccurs="0" maxOccurs="unbounded"></xs:element>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>

<xs:element name="scene-annotation" type="T_scene_annotationBulkUploadXml" substitutionGroup="scene"> </xs:element>

<xs:complexType name="T_customData">
<xs:sequence>
<xs:element name="action" minOccurs="0" maxOccurs="1">

<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="transformXslt"></xs:enumeration>

<xs:enumeration value="replace"></xs:enumeration>
</xs:restriction>
</xs:simpleType>
</xs:element>

<xs:element name="xslt" minOccurs="0" maxOccurs="1"> </xs:element>

<xs:element ref="xmlData" maxOccurs="1" minOccurs="0"> </xs:element>
</xs:sequence>

<xs:attribute name="metadataId" use="optional" type="xs:int"> </xs:attribute>

<xs:attribute name="metadataProfile" use="optional">

<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="120"></xs:maxLength>
</xs:restriction>
</xs:simpleType>
</xs:attribute>

<xs:attribute name="metadataProfileId" use="optional" type="xs:int"> </xs:attribute>
</xs:complexType>

<xs:complexType name="T_xmlData">
<xs:sequence>
<xs:any namespace="##local" processContents="skip" minOccurs="1" maxOccurs="1"> </xs:any>
</xs:sequence>
</xs:complexType>

<xs:complexType name="T_customDataItems">
<xs:sequence>
<xs:element name="action" minOccurs="0" maxOccurs="1">

<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="update"></xs:enumeration>
</xs:restriction>
</xs:simpleType>
</xs:element>

<xs:element ref="customData" maxOccurs="unbounded" minOccurs="0"> </xs:element>
</xs:sequence>
</xs:complexType>

<xs:element name="customDataItems" type="T_customDataItems" substitutionGroup="item-extension"> </xs:element>

<xs:element name="customData" type="T_customData"> </xs:element>

<xs:element name="xmlData" type="T_xmlData"> </xs:element>

<xs:complexType name="T_distribution">
<xs:sequence>
<xs:choice minOccurs="1" maxOccurs="1">
<xs:element name="distributionProvider" minOccurs="1" maxOccurs="1" type="KalturaDistributionProviderType"> </xs:element>

<xs:element name="distributionProfileId" minOccurs="1" maxOccurs="1" type="xs:int"> </xs:element>

<xs:element name="distributionProfile" minOccurs="1" maxOccurs="1">

<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="120"></xs:maxLength>
</xs:restriction>
</xs:simpleType>
</xs:element>
</xs:choice>

<xs:element name="sunrise" minOccurs="0" maxOccurs="1" type="xs:dateTime"> </xs:element>

<xs:element name="sunset" minOccurs="0" maxOccurs="1" type="xs:dateTime"> </xs:element>

<xs:element name="flavorAssetIds" minOccurs="0" maxOccurs="1" type="xs:string"> </xs:element>

<xs:element name="thumbAssetIds" minOccurs="0" maxOccurs="1" type="xs:string"> </xs:element>

<xs:element ref="distribution-extension" minOccurs="0" maxOccurs="unbounded"></xs:element>
</xs:sequence>

<xs:attribute name="entryDistributionId" use="optional" type="xs:int"> </xs:attribute>

<xs:attribute name="submitWhenReady" use="optional" type="xs:boolean" default="false"> </xs:attribute>
</xs:complexType>

<xs:complexType name="T_distributions">
<xs:sequence>
<xs:element ref="distribution" maxOccurs="unbounded" minOccurs="0"> </xs:element>
</xs:sequence>
</xs:complexType>

<xs:element name="distributions" type="T_distributions" substitutionGroup="item-extension"> </xs:element>

<xs:element name="distribution" type="T_distribution"> </xs:element>

<xs:element name="distribution-extension"></xs:element>

<xs:simpleType name="KalturaEntryType">

<xs:restriction base="xs:string">
<xs:enumeration value="-1"></xs:enumeration>

<xs:enumeration value="1"></xs:enumeration>

<xs:enumeration value="2"></xs:enumeration>

<xs:enumeration value="5"></xs:enumeration>

<xs:enumeration value="6"></xs:enumeration>

<xs:enumeration value="7"></xs:enumeration>

<xs:enumeration value="8"></xs:enumeration>

<xs:enumeration value="10"></xs:enumeration>

<xs:enumeration value="externalMedia.externalMedia"></xs:enumeration>
</xs:restriction>
</xs:simpleType>

<xs:simpleType name="KalturaDynamicEnum">

<xs:restriction base="xs:string"> </xs:restriction>
</xs:simpleType>

<xs:simpleType name="KalturaLicenseType">

<xs:restriction base="xs:int">
<xs:enumeration value="-1"></xs:enumeration>

<xs:enumeration value="0"></xs:enumeration>

<xs:enumeration value="1"></xs:enumeration>

<xs:enumeration value="2"></xs:enumeration>

<xs:enumeration value="3"></xs:enumeration>

<xs:enumeration value="4"></xs:enumeration>

<xs:enumeration value="5"></xs:enumeration>

<xs:enumeration value="6"></xs:enumeration>

<xs:enumeration value="7"></xs:enumeration>

<xs:enumeration value="8"></xs:enumeration>

<xs:enumeration value="9"></xs:enumeration>

<xs:enumeration value="10"></xs:enumeration>

<xs:enumeration value="11"></xs:enumeration>

<xs:enumeration value="12"></xs:enumeration>

<xs:enumeration value="13"></xs:enumeration>

<xs:enumeration value="14"></xs:enumeration>

<xs:enumeration value="15"></xs:enumeration>
</xs:restriction>
</xs:simpleType>

<xs:simpleType name="KalturaEntryStatus">

<xs:restriction base="xs:string">
<xs:enumeration value="-2"></xs:enumeration>

<xs:enumeration value="-1"></xs:enumeration>

<xs:enumeration value="0"></xs:enumeration>

<xs:enumeration value="1"></xs:enumeration>

<xs:enumeration value="2"></xs:enumeration>

<xs:enumeration value="3"></xs:enumeration>

<xs:enumeration value="4"></xs:enumeration>

<xs:enumeration value="5"></xs:enumeration>

<xs:enumeration value="6"></xs:enumeration>

<xs:enumeration value="7"></xs:enumeration>

<xs:enumeration value="virusScan.Infected"></xs:enumeration>

<xs:enumeration value="virusScan.ScanFailure"></xs:enumeration>
</xs:restriction>
</xs:simpleType>

<xs:simpleType name="KalturaMediaType">

<xs:restriction base="xs:int">
<xs:enumeration value="1"></xs:enumeration>

<xs:enumeration value="2"></xs:enumeration>

<xs:enumeration value="5"></xs:enumeration>

<xs:enumeration value="201"></xs:enumeration>

<xs:enumeration value="202"></xs:enumeration>

<xs:enumeration value="203"></xs:enumeration>

<xs:enumeration value="204"></xs:enumeration>
</xs:restriction>
</xs:simpleType>

<xs:simpleType name="KalturaCaptionType">

<xs:restriction base="xs:string">
<xs:enumeration value="1"></xs:enumeration>

<xs:enumeration value="2"></xs:enumeration>

<xs:enumeration value="3"></xs:enumeration>
</xs:restriction>
</xs:simpleType>

<xs:simpleType name="KalturaLanguage">

<xs:restriction base="xs:string">
<xs:enumeration value="Abkhazian"></xs:enumeration>

<xs:enumeration value="Afar"></xs:enumeration>

<xs:enumeration value="Afrikaans"></xs:enumeration>

<xs:enumeration value="Albanian"></xs:enumeration>

<xs:enumeration value="Amharic"></xs:enumeration>

<xs:enumeration value="Arabic"></xs:enumeration>

<xs:enumeration value="Armenian"></xs:enumeration>

<xs:enumeration value="Assamese"></xs:enumeration>

<xs:enumeration value="Aymara"></xs:enumeration>

<xs:enumeration value="Azerbaijani"></xs:enumeration>

<xs:enumeration value="Bashkir"></xs:enumeration>

<xs:enumeration value="Basque"></xs:enumeration>

<xs:enumeration value="Bengali (Bangla)"></xs:enumeration>

<xs:enumeration value="Bhutani"></xs:enumeration>

<xs:enumeration value="Bihari"></xs:enumeration>

<xs:enumeration value="Bislama"></xs:enumeration>

<xs:enumeration value="Breton"></xs:enumeration>

<xs:enumeration value="Bulgarian"></xs:enumeration>

<xs:enumeration value="Burmese"></xs:enumeration>

<xs:enumeration value="Byelorussian (Belarusian)"></xs:enumeration>

<xs:enumeration value="Cambodian"></xs:enumeration>

<xs:enumeration value="Catalan"></xs:enumeration>

<xs:enumeration value="Chinese"></xs:enumeration>

<xs:enumeration value="Corsican"></xs:enumeration>

<xs:enumeration value="Croatian"></xs:enumeration>

<xs:enumeration value="Czech"></xs:enumeration>

<xs:enumeration value="Danish"></xs:enumeration>

<xs:enumeration value="Dutch"></xs:enumeration>

<xs:enumeration value="English"></xs:enumeration>

<xs:enumeration value="English (British)"></xs:enumeration>

<xs:enumeration value="English (American)"></xs:enumeration>

<xs:enumeration value="Esperanto"></xs:enumeration>

<xs:enumeration value="Estonian"></xs:enumeration>

<xs:enumeration value="Faeroese"></xs:enumeration>

<xs:enumeration value="Farsi"></xs:enumeration>

<xs:enumeration value="Fiji"></xs:enumeration>

<xs:enumeration value="Finnish"></xs:enumeration>

<xs:enumeration value="French"></xs:enumeration>

<xs:enumeration value="Frisian"></xs:enumeration>

<xs:enumeration value="Galician"></xs:enumeration>

<xs:enumeration value="Gaelic (Scottish)"></xs:enumeration>

<xs:enumeration value="Gaelic (Manx)"></xs:enumeration>

<xs:enumeration value="Georgian"></xs:enumeration>

<xs:enumeration value="German"></xs:enumeration>

<xs:enumeration value="Greek"></xs:enumeration>

<xs:enumeration value="Greenlandic"></xs:enumeration>

<xs:enumeration value="Guarani"></xs:enumeration>

<xs:enumeration value="Gujarati"></xs:enumeration>

<xs:enumeration value="Hausa"></xs:enumeration>

<xs:enumeration value="Hebrew"></xs:enumeration>

<xs:enumeration value="Hebrew"></xs:enumeration>

<xs:enumeration value="Hindi"></xs:enumeration>

<xs:enumeration value="Hungarian"></xs:enumeration>

<xs:enumeration value="Icelandic"></xs:enumeration>

<xs:enumeration value="Indonesian"></xs:enumeration>

<xs:enumeration value="Indonesian"></xs:enumeration>

<xs:enumeration value="Interlingua"></xs:enumeration>

<xs:enumeration value="Interlingue"></xs:enumeration>

<xs:enumeration value="Inuktitut"></xs:enumeration>

<xs:enumeration value="Inupiak"></xs:enumeration>

<xs:enumeration value="Irish"></xs:enumeration>

<xs:enumeration value="Italian"></xs:enumeration>

<xs:enumeration value="Japanese"></xs:enumeration>

<xs:enumeration value="Javanese"></xs:enumeration>

<xs:enumeration value="Kannada"></xs:enumeration>

<xs:enumeration value="Kashmiri"></xs:enumeration>

<xs:enumeration value="Kazakh"></xs:enumeration>

<xs:enumeration value="Kinyarwanda (Ruanda)"></xs:enumeration>

<xs:enumeration value="Kirghiz"></xs:enumeration>

<xs:enumeration value="Kirundi (Rundi)"></xs:enumeration>

<xs:enumeration value="Korean"></xs:enumeration>

<xs:enumeration value="Kurdish"></xs:enumeration>

<xs:enumeration value="Laothian"></xs:enumeration>

<xs:enumeration value="Latin"></xs:enumeration>

<xs:enumeration value="Latvian (Lettish)"></xs:enumeration>

<xs:enumeration value="Limburgish ( Limburger)"></xs:enumeration>

<xs:enumeration value="Lingala"></xs:enumeration>

<xs:enumeration value="Lithuanian"></xs:enumeration>

<xs:enumeration value="Macedonian"></xs:enumeration>

<xs:enumeration value="Malagasy"></xs:enumeration>

<xs:enumeration value="Malay"></xs:enumeration>

<xs:enumeration value="Malayalam"></xs:enumeration>

<xs:enumeration value="Maltese"></xs:enumeration>

<xs:enumeration value="Maori"></xs:enumeration>

<xs:enumeration value="Marathi"></xs:enumeration>

<xs:enumeration value="Moldavian"></xs:enumeration>

<xs:enumeration value="Mongolian"></xs:enumeration>

<xs:enumeration value="Nauru"></xs:enumeration>

<xs:enumeration value="Nepali"></xs:enumeration>

<xs:enumeration value="Norwegian"></xs:enumeration>

<xs:enumeration value="Occitan"></xs:enumeration>

<xs:enumeration value="Oriya"></xs:enumeration>

<xs:enumeration value="Oromo (Afan, Galla)"></xs:enumeration>

<xs:enumeration value="Pashto (Pushto)"></xs:enumeration>

<xs:enumeration value="Polish"></xs:enumeration>

<xs:enumeration value="Portuguese"></xs:enumeration>

<xs:enumeration value="Punjabi"></xs:enumeration>

<xs:enumeration value="Quechua"></xs:enumeration>

<xs:enumeration value="Rhaeto-Romance"></xs:enumeration>

<xs:enumeration value="Romanian"></xs:enumeration>

<xs:enumeration value="Russian"></xs:enumeration>

<xs:enumeration value="Samoan"></xs:enumeration>

<xs:enumeration value="Sangro"></xs:enumeration>

<xs:enumeration value="Sanskrit"></xs:enumeration>

<xs:enumeration value="Serbian"></xs:enumeration>

<xs:enumeration value="Serbo-Croatian"></xs:enumeration>

<xs:enumeration value="Sesotho"></xs:enumeration>

<xs:enumeration value="Setswana"></xs:enumeration>

<xs:enumeration value="Shona"></xs:enumeration>

<xs:enumeration value="Sindhi"></xs:enumeration>

<xs:enumeration value="Sinhalese"></xs:enumeration>

<xs:enumeration value="Siswati"></xs:enumeration>

<xs:enumeration value="Slovak"></xs:enumeration>

<xs:enumeration value="Slovenian"></xs:enumeration>

<xs:enumeration value="Somali"></xs:enumeration>

<xs:enumeration value="Spanish"></xs:enumeration>

<xs:enumeration value="Sundanese"></xs:enumeration>

<xs:enumeration value="Swahili (Kiswahili)"></xs:enumeration>

<xs:enumeration value="Swedish"></xs:enumeration>

<xs:enumeration value="Tagalog"></xs:enumeration>

<xs:enumeration value="Tajik"></xs:enumeration>

<xs:enumeration value="Tamil"></xs:enumeration>

<xs:enumeration value="Tatar"></xs:enumeration>

<xs:enumeration value="Telugu"></xs:enumeration>

<xs:enumeration value="Thai"></xs:enumeration>

<xs:enumeration value="Tibetan"></xs:enumeration>

<xs:enumeration value="Tigrinya"></xs:enumeration>

<xs:enumeration value="Tonga"></xs:enumeration>

<xs:enumeration value="Tsonga"></xs:enumeration>

<xs:enumeration value="Turkish"></xs:enumeration>

<xs:enumeration value="Turkmen"></xs:enumeration>

<xs:enumeration value="Twi"></xs:enumeration>

<xs:enumeration value="Uighur"></xs:enumeration>

<xs:enumeration value="Ukrainian"></xs:enumeration>

<xs:enumeration value="Urdu"></xs:enumeration>

<xs:enumeration value="Uzbek"></xs:enumeration>

<xs:enumeration value="Vietnamese"></xs:enumeration>

<xs:enumeration value="Volapuk"></xs:enumeration>

<xs:enumeration value="Welsh"></xs:enumeration>

<xs:enumeration value="Wolof"></xs:enumeration>

<xs:enumeration value="Xhosa"></xs:enumeration>

<xs:enumeration value="Yiddish"></xs:enumeration>

<xs:enumeration value="Yiddish"></xs:enumeration>

<xs:enumeration value="Yoruba"></xs:enumeration>

<xs:enumeration value="Zulu"></xs:enumeration>

<xs:enumeration value="Multilingual"></xs:enumeration>
</xs:restriction>
</xs:simpleType>

<xs:simpleType name="KalturaAttachmentType">

<xs:restriction base="xs:string">
<xs:enumeration value="1"></xs:enumeration>

<xs:enumeration value="2"></xs:enumeration>

<xs:enumeration value="3"></xs:enumeration>
</xs:restriction>
</xs:simpleType>

<xs:simpleType name="KalturaAdType">

<xs:restriction base="xs:string">
<xs:enumeration value="1"></xs:enumeration>

<xs:enumeration value="2"></xs:enumeration>
</xs:restriction>
</xs:simpleType>

<xs:simpleType name="KalturaAdProtocolType">

<xs:restriction base="xs:string">
<xs:enumeration value="0"></xs:enumeration>

<xs:enumeration value="1"></xs:enumeration>

<xs:enumeration value="2"></xs:enumeration>

<xs:enumeration value="3"></xs:enumeration>
</xs:restriction>
</xs:simpleType>

<xs:simpleType name="KalturaThumbCuePointSubType">

<xs:restriction base="xs:int">
<xs:enumeration value="1"></xs:enumeration>

<xs:enumeration value="2"></xs:enumeration>
</xs:restriction>
</xs:simpleType>

<xs:simpleType name="KalturaDistributionProviderType">

<xs:restriction base="xs:string">
<xs:enumeration value="1"></xs:enumeration>

<xs:enumeration value="2"></xs:enumeration>

<xs:enumeration value="youtubeApiDistribution.YOUTUBE_API"></xs:enumeration>

<xs:enumeration value="ideticDistribution.IDETIC"></xs:enumeration>

<xs:enumeration value="facebookDistribution.FACEBOOK"></xs:enumeration>
</xs:restriction>
</xs:simpleType>
</xs:schema>

mrss element (T_mrss)
Wrapper element holding XML structure

Attributes
Attribute Name Description Required Type Restrictions
version Indicates the XSD version to be used
No string

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
channel holding multiple item elements
Yes Unbounded

XML Example
<mrss version="2.0">
<channel>
<items>
<item>...</item>

<item>...</item>

<item>...</item>
</items>
</channel>
</mrss>

channel element (T_channel)
Wrapper element holding multiple item elements

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
item holding entry element
Yes Unbounded

XML Example
<mrss version="2.0">
<channel>
<items>
<item>...</item>

<item>...</item>

<item>...</item>
</items>
</channel>
</mrss>

item element (T_item)
Single entry wrapper element

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
result Action results
Yes 1
action Entry action that applied on the entry element
Yes 1 string Acceptable values:
  • add
  • update
  • delete
entryId ID of entry that the action appled on
Yes 1 string Maximum length: 20 characters
referenceID Partner external reference string
No 1 string
createdAt Entry creation date as Unix timestamp (In seconds)
Yes 1 int
updatedAt Entry last update date as Unix timestamp (In seconds)
Yes 1 int
title Entry name
Yes 1 string Maximum length: 60 characters
type Entry type
Yes 1 KalturaEntryType
licenseType Entry license type
Yes 1 KalturaLicenseType
userId The ID of the user who is the owner of this entry
Yes 1 string
name Entry name
Yes 1 string Maximum length: 60 characters
status Entry current status
Yes 1 KalturaEntryStatus
description Entry free text description
No 1 string
thumbnailUrl Download URL of the entry thumbnail
No 1
tags Entry searchable keywords
No 1
category Entry assigned category
No Unbounded
partnerData Used to store various partner related data as a string
No 1 string
partnerSortData Used to store various partner related data as a numeric value
No 1 int
accessControlId The id of the access control profile that assigned to this entry
No 1 int
conversionProfileId The ingestion profile that used to ingest this entry
No 1 int
startDate Entry scheduling start date
No 1 int
endDate Entry scheduling end date.
If not specified the entry will be available forever

No 1 int
Choice No 1 One of the following choices
media Option 1 Media related information, such as media type
Yes 1
Choice No Unbounded One of the following choices
content Option 1 Flavor asset information
Yes 1
thumbnail Option 2 Thumbnail asset information
Yes 1
Extensions:
subTitles All subTitles elements
No Unbounded
attachments All attachments elements
No Unbounded
attachment Attachment asset element
No Unbounded
scenes A cue points wrapper element
No Unbounded
customDataItems All custom metadata elemets
No Unbounded
distributions All custom metadata elemets
No Unbounded

XML Example
<item>
<result>
<errorDescription>...</errorDescription>
</result>

<action>add</action>

<entryId>{entry id}</entryId>

<createdAt>1311878948</createdAt>

<updatedAt>1311879522</updatedAt>

<title>my entry name</title>

<link>http://my.feed.url?entry_id={entry id}</link>

<type>1</type>

<licenseType>-1</licenseType>

<userId>my.example.user</userId>

<name>my entry name</name>

<status>2</status>

<description>my entry free text description</description>

<thumbnailUrl url="http://kaltura.domain/thumbnail/path/to/file.jpg"></thumbnailUrl>

<tags>
<tag>example</tag>

<tag>my_tag</tag>
</tags>

<category name="example1">examples &gt; example1</category>

<category name="example2">examples &gt; example2</category>

<partnerData>my advanced data</partnerData>

<accessControlId>{access control id}</accessControlId>

<conversionProfileId>{conversion profile id}</conversionProfileId>

<media>
<mediaType>1</mediaType>

<duration>34951</duration>

<flavorParamsIds>0,3</flavorParamsIds>
</media>

<thumbnail url="http://kaltura.domain/thumbnail/path/to/thumbnail1.jpg">...</thumbnail>

<thumbnail url="http://kaltura.domain/thumbnail/path/to/thumbnail2.jpg">...</thumbnail>

<content url="http://kaltura.domain/flavor/path/to/flavor1.flv">...</content>

<content url="http://kaltura.domain/flavor/path/to/flavor2.flv">...</content>
</item>

result element (T_result)
Entry action result element

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
errorDescription Ingestion error description
Yes 1 string

XML Example
<item>
<result>
<errorDescription>...</errorDescription>
</result>

<action>add</action>

<entryId>{entry id}</entryId>
</item>

tags element (T_tags)
Free text tags

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
tag Free text keyword
Yes Unbounded string


category element (T_category)
Category assignments for entries

Attributes
Attribute Name Description Required Type Restrictions
name Category name
Yes string

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
Extended from xs:string


media element (T_media)
Media related information, such as media type

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
mediaType Entry media type
Yes 1 KalturaMediaType
duration Entry media (video/audio) duration
Yes 1 int
flavorParamsIds Flavor params ids that have compatible ready flavor asset
Yes 1 string

XML Example
<item>
<result>
<errorDescription>...</errorDescription>
</result>

<action>add</action>

<entryId>{entry id}</entryId>

<media>
<mediaType>1</mediaType>

<duration>34951</duration>

<flavorParamsIds>0,3</flavorParamsIds>
</media>
</item>

content element (T_content)
Flavor asset element

Attributes
Attribute Name Description Required Type Restrictions
url Download URL
Yes string
flavorAssetId ID of the flavor asset
Yes string
containerFormat Format of the asset file
Yes string
format Configured format of the flavor
Yes string
extension Flavor asset file extension
Yes string
isSource Is the source flavor asset
Yes boolean
height Flavor height
No int
width Flavor width
No int
videoBitrate Flavor asset video bitrate
No int
videoCodec Flavor asset video codec
No string
audioBitrate Flavor asset audio bitrate
No int
audioCodec Flavor asset audio codec
No string
frameRate Flavor asset frame rate
No int
flavorParamsId ID of accosiated flavor params
No int
flavorParamsName System name of accosiated flavor params
No string
assetId The asset id to be updated with this resource userd only for update
No string

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
tags Specifies specific tags you want to set for the flavor asset
No 1

XML Example
<item>
<result>
<errorDescription>...</errorDescription>
</result>

<action>add</action>

<entryId>{entry id}</entryId>

<media>...</media>

<content assetId="{flavor asset id}" audioBitrate="0" audioCodec="" containerFormat="flash video" extension="flv" flavorParamsId="0" flavorParamsName="Source" format="" frameRate="0" height="0" isSource="true" url="http://kaltura.domain/path/my_flavor_asset.flv" videoBitrate="0" videoCodec="" width="0">
&gt; <tags>
<tag>example</tag>

<tag>my_tag</tag>
</tags>
</content>
</item>

thumbnail element (T_thumbnail)
Thumbnail asset element

Attributes
Attribute Name Description Required Type Restrictions
url Download URL
Yes string
thumbAssetId Thumbnail asset id
Yes string
format Format of the thumbnail asset file
Yes string
isDefault Is the entry default thumbnail
Yes boolean
height Thumbnail height
No int
width Thumbnail width
No int
thumbParamsId ID of thumbnail params that associated with the thumbnail
No int

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
tags Entry searchable keywords
No 1

XML Example
<item>
<result>
<errorDescription>...</errorDescription>
</result>

<action>add</action>

<entryId>{entry id}</entryId>

<media>...</media>

<thumbnail format="" height="120" isDefault="false" thumbAssetId="{thumb asset id}" url="http://kaltura.domain/path/my_thumbnail_asset.flv" width="120">
<tags>
<tag>example</tag>

<tag>my_tag</tag>
</tags>
</thumbnail>
</item>

subTitles element (T_subTitles)
All subTitles elements

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
action The action to apply:
Update - Update existing subtitles

No 1 string
subTitle All subTitles elements
No Unbounded

XML Example
<subTitles>
<action>update</action>

<subTitle>...</subTitle>

<subTitle>...</subTitle>

<subTitle>...</subTitle>
</subTitles>

subTitle element (T_subTitle)
A single caption asset element

Attributes
Attribute Name Description Required Type Restrictions
captionParamsId The asset id to be updated with this resource used only for update
No int
captionParams System name of caption params to be associated with the caption asset
No string
captionAssetId ID of caption params to be associated with the caption asset
No string
isDefault Specifies if this asset is the default caption asset
No boolean
format Caption asset file format
No KalturaCaptionType
lang Caption asset file language
No KalturaLanguage

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
tags Specifies specific tags you want to set for the flavor asset
Yes 1
Choice Yes 1 One of the following choices
serverFileContentResource Option 1 Specifies that content ingestion location is on a Kaltura hosted server
Yes 1
urlContentResource Option 2 Specifies that content file location is a URL (http,ftp)
Yes 1
remoteStorageContentResource Option 3 Specifies that content file location is a path within a Kaltura defined remote storage
Yes 1
remoteStorageContentResources Option 4 Set of content files within several Kaltura defined remote storages
Yes 1
entryContentResource Option 5 Specifies that content is a Kaltura entry
Yes 1
assetContentResource Option 6 Specifies that content is a Kaltura asset
Yes 1

XML Example
<subTitle isDefault="true" format="2" lang="Hebrew">
<tags>
<tag>tag1</tag>

<tag>tag2</tag>
</tags>

<urlContentResource url="http://my.domain/path/caption.srt"></urlContentResource>
</subTitle>

attachments element (T_attachments)
All attachments elements

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
action The action to apply:
Update - Update existing attachment

No 1 string
attachment All attachment elements
No Unbounded

XML Example
<attachments>
<action>update</action>

<attachment>...</attachment>

<attachment>...</attachment>

<attachment>...</attachment>
</attachments>

attachment element (T_attachment)
Attachment asset element

Attributes
Attribute Name Description Required Type Restrictions
attachmentAssetId The asset id to be updated with this resource used only for update
No string
format Attachment asset file format
No KalturaAttachmentType

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
tags Specifies specific tags you want to set for the flavor asset
No 1
Choice Yes 1 One of the following choices
serverFileContentResource Option 1 Specifies that content ingestion location is on a Kaltura hosted server
Yes 1
urlContentResource Option 2 Specifies that content file location is a URL (http,ftp)
Yes 1
remoteStorageContentResource Option 3 Specifies that content file location is a path within a Kaltura defined remote storage
Yes 1
remoteStorageContentResources Option 4 Set of content files within several Kaltura defined remote storages
Yes 1
entryContentResource Option 5 Specifies that content is a Kaltura entry
Yes 1
assetContentResource Option 6 Specifies that content is a Kaltura asset
Yes 1
filename Attachment asset file name
No 1 string
title Attachment asset title
No 1 string
description Attachment asset free text description
No 1 string

XML Example
<attachment format="1" attachmentAssetId="{asset id}">
<tags>
<tag>example</tag>

<tag>my_tag</tag>
</tags>

<urlContentResource url="http://my.domain/path/file.txt"></urlContentResource>

<filename>my_file_name.txt</filename>

<title>my attachment asset title</title>

<description>my attachment asset free text description</description>
</attachment>

scene-customData element (T_customData)
XML for custom metadata

Attributes
Attribute Name Description Required Type Restrictions
metadataId The identifier of the custom metadata object that an update/delete action applies to
No int
metadataProfile The schema profile system name of the custom metadata
No string Maximum length: 120 characters
metadataProfileId The schema profile identifier of the custom metadata
No int

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
action The action to apply:
transformXslt - transform metadata object using Xslt

No 1 string Acceptable values:
  • transformXslt
  • replace
xslt The xslt to transform on the current metadata object
No 1
xmlData metadata xml Data
No 1

XML Example
<scene-ad-cue-point entryId="{entry id}">
<sceneStartTime>00:00:05</sceneStartTime>

<sceneTitle>my ad title</sceneTitle>

<sourceUrl>http://source.to.my/ad.xml</sourceUrl>

<adType>1</adType>

<protocolType>1</protocolType>

<scene-customData metadataProfile="MY_AD_METADATA_PROFILE_SYSTEM_NAME">
<metadata>
<adData>my ad custom data</adData>
</metadata>
</scene-customData>
</scene-ad-cue-point>

scenes element (T_scenes)
A cue points wrapper element

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
action The action to apply from the item element:
Update - Update an existing entry

No 1 string
scene A cue point element
No Unbounded

XML Example
<scenes>
<action>update</action>

<scene-ad-cue-point entryId="{entry id}" systemName="MY_AD_CUE_POINT_SYSTEM_NAME">...</scene-ad-cue-point>

<scene-annotation entryId="{entry id}" systemName="MY_ANNOTATION_PARENT_SYSTEM_NAME">...</scene-annotation>

<scene-annotation entryId="{entry id}">...</scene-annotation>

<scene-code-cue-point entryId="{entry id}">...</scene-code-cue-point>
</scenes>

scene element (abstract T_scene)
A base cue point element. This is an abstract element and cannot be used. Use only extended elements.

Attributes
Attribute Name Description Required Type Restrictions
sceneId The identifier of the cue point that an update/delete action applies to
No string Maximum length: 250 characters
systemName The system name of the cue point that an update/delete action applies to
No string Maximum length: 120 characters

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
sceneStartTime A cue point that marks the start time
Yes 1 time
tags Searchable keywords associated with a cue point
No 1

Extended elements
  1. scene-ad-cue-point
  2. scene-code-cue-point
  3. scene-thumb-cue-point
  4. scene-annotation

scene-ad-cue-point element (T_scene_adCuePointBulkUploadXml)
A single advertisement cue point element

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
Extended from T_scene
sceneStartTime A cue point that marks the start time
Yes 1 time
tags Searchable keywords associated with a cue point
No 1
sceneEndTime A cue point that marks the end time
No 1 time
sceneTitle Text that defines the title
No 1 string Maximum length: 250 characters
sourceUrl The URL of the ad XML
No 1 string
adType Indicates the ad type
Yes 1 KalturaAdType
protocolType Indicates the ad protocol type
Yes 1 KalturaAdProtocolType
Extensions:
scene-customData XML for custom metadata
No Unbounded

XML Example
<scene-ad-cue-point systemName="MY_AD_CUE_POINT_SYSTEM_NAME">
<sceneStartTime>00:00:05</sceneStartTime>

<tags>
<tag>tag1</tag>

<tag>tag2</tag>
</tags>

<sceneTitle>my ad title</sceneTitle>

<sourceUrl>http://source.to.my/ad.xml</sourceUrl>

<adType>1</adType>

<protocolType>1</protocolType>
</scene-ad-cue-point>

scene-code-cue-point element (T_scene_codeCuePointBulkUploadXml)
A single code cue point element

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
Extended from T_scene
sceneStartTime A cue point that marks the start time
Yes 1 time
tags Searchable keywords associated with a cue point
No 1
sceneEndTime A cue point that marks the end time
No 1 time
code Textual code
No 1 string Maximum length: 250 characters
description A free text description
No 1 string
Extensions:
scene-customData XML for custom metadata
No Unbounded

XML Example
<scene-code-cue-point entryId="{entry id}">
<sceneStartTime>00:00:05.3</sceneStartTime>

<tags>
<tag>tag1</tag>

<tag>tag2</tag>
</tags>

<code>MY_CODE</code>

<description>my code cue point description</description>
</scene-code-cue-point>

scene-thumb-cue-point element (T_scene_thumbCuePoint)
Single thumb cue point element

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
Extended from T_scene
sceneStartTime A cue point that marks the start time
Yes 1 time
tags Searchable keywords associated with a cue point
No 1
title Yes 1 string
description Yes 1 string
subType Indicates the thumb cue point sub type 1 = Slide 2 = Chapter, defaults to Slide
No 1 KalturaThumbCuePointSubType
slide No 1
Extensions:
scene-customData XML for custom metadata
No Unbounded

XML Example
<scene-thumb-cue-point sceneId="{scene id}" entryId="{entry id}">
<sceneStartTime>00:00:05.3</sceneStartTime>

<tags>
<tag>my_tag</tag>
</tags>

<slide>
<urlContentResource url="URL_TO_FILE"></urlContentResource>
</slide>
</scene-thumb-cue-point>

slide element (T_slide)
The slide image to attahce to tht thumb cue point ellement

Attributes
Attribute Name Description Required Type Restrictions
timedThumbAssetId No string

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
Choice No 1 One of the following choices
urlContentResource Option 1 No 1
remoteStorageContentResource Option 2 No 1
remoteStorageContentResources Option 3 No 1
assetContentResource Option 4 No 1
entryContentResource Option 5 No 1


scene-annotation element (T_scene_annotationBulkUploadXml)
A single annotation cue point element

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
Extended from T_scene
sceneStartTime A cue point that marks the start time
Yes 1 time
tags Searchable keywords associated with a cue point
No 1
sceneEndTime A cue point that marks the end time
Yes 1 time
sceneText A free text description
No 1 string
Choice No 1 One of the following choices
parent Option 1 The system name of a parent annotation
Yes 1 string Maximum length: 120 characters
parentId Option 2 The identifier of a parent annotation
Yes 1 string Maximum length: 250 characters
Extensions:
scene-customData XML for custom metadata
No Unbounded

XML Example 1: Single annotation
<scene-annotation entryId="{entry id}">
<sceneStartTime>00:00:05.3</sceneStartTime>

<tags>
<tag>tag1</tag>

<tag>tag2</tag>
</tags>

<sceneEndTime>00:00:10</sceneEndTime>

<sceneText>my annotation</sceneText>
</scene-annotation>
Example 2: Multiple related annotations
<scene-annotation entryId="{entry id}" systemName="MY_ANNOTATION_PARENT_SYSTEM_NAME">
<sceneStartTime>00:00:05.3</sceneStartTime>

<tags>
<tag>tag1</tag>

<tag>tag2</tag>
</tags>

<sceneEndTime>00:00:10</sceneEndTime>

<sceneText>my annotation parent</sceneText>
</scene-annotation>

<scene-annotation entryId="{entry id}">
<sceneStartTime>00:00:05.3</sceneStartTime>

<tags>
<tag>tag3</tag>

<tag>tag4</tag>
</tags>

<sceneEndTime>00:00:10</sceneEndTime>

<sceneText>my annotation child</sceneText>

<parent>MY_ANNOTATION_PARENT_SYSTEM_NAME</parent>
</scene-annotation>

customDataItems element (T_customDataItems)
All custom metadata elemets

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
action The action to apply:
Update - Update metadata for existing entry

No 1 string
customData All custom data elemets
No Unbounded

XML Example
<customDataItems>
<action>update</action>

<customData>...</customData>

<customData>...</customData>

<customData>...</customData>
</customDataItems>

customData element (T_customData)
XML for custom metadata

Attributes
Attribute Name Description Required Type Restrictions
metadataId The identifier of the custom metadata object that an update/delete action applies to
No int
metadataProfile The schema profile system name of the custom metadata
No string Maximum length: 120 characters
metadataProfileId The schema profile identifier of the custom metadata
No int

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
action The action to apply:
transformXslt - transform metadata object using Xslt

No 1 string Acceptable values:
  • transformXslt
  • replace
xslt The xslt to transform on the current metadata object
No 1
xmlData metadata xml Data
No 1

XML Example
<customData metadataId="{metadata id}" metadataProfile="MY_METADATA_PROFILE_SYSTEM_NAME}" metadataProfileId="{metadata profile id}">
<action>transformXslt</action>

<xslt></xslt>

<xmlData>
<metadata>
<TextFieldName>entry field value</TextFieldName>

<MultipleTextFieldName>entry multiple text field value1</MultipleTextFieldName>

<MultipleTextFieldName>entry multiple text field value2</MultipleTextFieldName>

<TextSelectionListFieldName>entry selected text value</TextSelectionListFieldName>

<DateFieldName>21741540</DateFieldName>

<EntryIDFieldName>0_5b3t2c8z</EntryIDFieldName>
</metadata>
</xmlData>
</customData>

xmlData element (T_xmlData)
XML data for custom metadata

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
[Any element] The XML for custom metadata according to a schema profile
Yes 1 any type

XML Example
<xmlData>
<metadata>
<TextFieldName>entry field value</TextFieldName>

<MultipleTextFieldName>entry multiple text field value1</MultipleTextFieldName>

<MultipleTextFieldName>entry multiple text field value2</MultipleTextFieldName>

<TextSelectionListFieldName>entry selected text value</TextSelectionListFieldName>

<DateFieldName>21741540</DateFieldName>

<EntryIDFieldName>0_5b3t2c8z</EntryIDFieldName>
</metadata>
</xmlData>

distributions element (T_distributions)
All custom metadata elemets

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
distribution All distributions
No Unbounded

XML Example
<distributions>
<distribution>
<distributionProfile>MY_DISTRIBUTION_PROFILE</distributionProfile>

<sunrise>2011-10-26T21:32:52</sunrise>

<sunset>2011-12-26T21:32:52</sunset>
</distribution>
</distributions>

distribution element (T_distribution)
Details related to a content distribution submission

Attributes
Attribute Name Description Required Type Restrictions
entryDistributionId The identifier of an entry distribution object that an update/delete action applies to
No int
submitWhenReady Indicates that the entry should be submitted when it is possible
No boolean

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
Choice Yes 1 One of the following choices
distributionProvider Option 1 The provider (Distribution Partner) that the entry is distributed to
Yes 1 KalturaDistributionProviderType
distributionProfileId Option 2 The identifier of the distribution profile to use for entry distribution
Yes 1 int
distributionProfile Option 3 The system name of the distribution profile to use for entry distribution
Yes 1 string Maximum length: 120 characters
sunrise The date and time that the entry becomes available on the remote site.
If not specified, the entry scheduling date and time are used.

No 1 dateTime
sunset The date and time that the entry becomes unavailable on the remote site.
If not specified, the entry scheduling date and time are used.

No 1 dateTime
flavorAssetIds Comma-separated list of existing flavor asset IDs for the distribution destination.
Used only for an existing entry.

No 1 string
thumbAssetIds Comma-separated list of existing thumbnail asset IDs for the distribution destination.
Used only for an existing entry.

No 1 string

XML Example
<distribution>
<distributionProfile>MY_DISTRIBUTION_PROFILE</distributionProfile>

<sunrise>2011-10-26T21:32:52</sunrise>

<sunset>2011-12-26T21:32:52</sunset>
</distribution>