General

Download URL: https://mp.streamamg.com/api_v3/index.php/service/schema/action/serve/type/dropFolderXmlBulkUpload.dropFolderXml/name/dropFolderXmlBulkUpload.dropFolderXml.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:decimal" 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="0" 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:choice maxOccurs="2" minOccurs="1">
<xs:choice maxOccurs="1" minOccurs="1">
<xs:sequence>
<xs:element maxOccurs="1" minOccurs="1" name="type" type="KalturaEntryType"> </xs:element>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

<xs:complexType name="T_serverFileContentResource">
<xs:choice maxOccurs="1" minOccurs="0">
<xs:element maxOccurs="1" minOccurs="1" name="fileSize" type="xs:int"> </xs:element>

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

<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute default="md5" name="type" use="optional">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="md5"></xs:enumeration>

<xs:enumeration value="sha1"></xs:enumeration>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
</xs:choice>

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

<xs:complexType name="T_urlContentResource">
<xs:attribute ref="url" use="required"> </xs:attribute>
</xs:complexType>

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

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

<xs:attribute ref="url" use="required"> </xs:attribute>

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

<xs:complexType name="T_remoteStorageContentResource">
<xs:choice maxOccurs="1" minOccurs="1">
<xs:element maxOccurs="1" minOccurs="1" name="storageProfileId" type="xs:int"> </xs:element>

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

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

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

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

<xs:complexType name="T_entryContentResource">
<xs:choice maxOccurs="1" minOccurs="0">
<xs:element maxOccurs="1" minOccurs="1" name="flavorParamsId" type="xs:int"> </xs:element>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

<xs:simpleType name="T_url">
<xs:restriction base="xs:string">
<xs:pattern value="(([hH][tT][tT][pP][sS]?)|(([fF][tT][pP])|([sS][fF][tT][pP])|([sS][cC][pP])))://?(([ 0-9a-zA-Z_!~* &apos; (). &amp; =+$%-\[\]]+)?(:[0-9a-zA-Z_!~* &apos; (). &amp; =+$%-\[\]]+@)?)?(([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-zA-Z_!~* &apos; ()-]+\.)*)(:[0-9]{1,4})?((/?)|(/[ 0-9a-zA-Z_!~* &apos; ().;?:@ &amp; =+$,%#-\[\]]+)+)"></xs:pattern>
</xs:restriction>
</xs:simpleType>

<xs:complexType name="T_tags">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" name="tag">

<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="100"></xs:maxLength>
</xs:restriction>
</xs:simpleType>
</xs:element>
</xs:sequence>
</xs:complexType>

<xs:complexType name="T_categories">
<xs:sequence>
<xs:element maxOccurs="32" minOccurs="0" name="category" type="xs:string"> </xs:element>
</xs:sequence>
</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="media" type="T_media"> </xs:element>

<xs:element name="contentAssets" type="T_contentAssets"> </xs:element>

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

<xs:element name="thumbnails" type="T_thumbnails"> </xs:element>

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

<xs:attribute name="url" type="T_url"></xs:attribute>

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

<xs:element name="serverFileContentResource" type="T_serverFileContentResource"> </xs:element>

<xs:element name="urlContentResource" type="T_urlContentResource"> </xs:element>

<xs:element name="sshUrlContentResource" type="T_sshUrlContentResource"> </xs:element>

<xs:element name="remoteStorageContentResource" type="T_remoteStorageContentResource"> </xs:element>

<xs:element name="remoteStorageContentResources" type="T_remoteStorageContentResources"> </xs:element>

<xs:element name="entryContentResource" type="T_entryContentResource"> </xs:element>

<xs:element name="assetContentResource" type="T_assetContentResource"> </xs:element>

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

<xs:element name="categories" type="T_categories"> </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="mix-extension"></xs:element>

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

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

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

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

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

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

<xs:complexType name="T_dropFolderFileContentResource">
<xs:choice minOccurs="0" maxOccurs="1">
<xs:element name="fileSize" type="xs:long" minOccurs="1" maxOccurs="1"> </xs:element>

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

<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="type" use="optional" default="md5">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="md5"></xs:enumeration>

<xs:enumeration value="sha1"></xs:enumeration>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
</xs:choice>

<xs:attribute name="filePath" use="required">

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

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

<xs:element name="dropFolderFileContentResource" type="T_dropFolderFileContentResource" substitutionGroup="contentResource-extension"> </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: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_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: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: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="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="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="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="KalturaDistributionProviderType">

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

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

<xs:enumeration value="tvinciDistribution.TVINCI"></xs:enumeration>

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

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

<xs:enumeration value="ftpDistribution.FTP"></xs:enumeration>

<xs:enumeration value="ftpDistribution.FTP_SCHEDULED"></xs:enumeration>

<xs:enumeration value="vimeoDistribution.VIMEO"></xs:enumeration>

<xs:enumeration value="dropboxDistribution.DROPBOX"></xs:enumeration>

<xs:enumeration value="dropboxDistribution.DROPBOX_SCHEDULED"></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="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: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:schema>

mrss element (T_mrss)
A wrapper element that holds the XML structure

Attributes
Attribute Name Description Required Type Restrictions
version The XSD version to be used
No decimal

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
channel A single entry wrapper element
Yes Unbounded

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

<item>...</item>

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

channel element (T_channel)
A wrapper element that holds multiple item elements

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

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

<item>...</item>

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

item element (T_item)
A single entry wrapper element

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

No 1 string Acceptable values:
  • add
  • update
  • delete
Choice Yes 2 One of the following choices
Choice Option 1 Yes 1 One of the following choices
type Option 1 The type of the new entry.
Only the MEDIA_CLIP (= 1) type is supported for XML ingestion.
This option is used only when applying an “Add” Action.

Yes 1 KalturaEntryType
licenseType The license type of the new entry.
This option is used only when applying an “Add” Action.

No 1 KalturaLicenseType
entryId Option 2 The identifier of the entry that an update/delete action applies to.
This option is used only when applying an “Update” or a “Delete” Action.

Yes 1 string Maximum length: 20 characters
referenceId Option 2 Partner external identifier of the entry
Yes 1 string Maximum length: 100 characters
userId The user identifier of the content creator/owner
No 1 string Maximum length: 100 characters
name The title of the entry
No 1 string Maximum length: 256 characters
description Text that describes the entry
No 1 string
tags Tags associated with the entry
No 1
categories The categories assigned to the entry
No 1
partnerData Publisher-specific information related to the entry.
Usually used for implementing an account-specific integration.

No 1 string Maximum length: 4000 characters
partnerSortData Partner-specific order used to enable custom ordering and filtering.
Usually used to implement an account-specific integration.

No 1 int
Choice No 1 One of the following choices
accessControlId Option 1 The access control profile identifier of the entry. If not specified, the account's default access control profile is used.
Yes 1 int
accessControl Option 2 The access control profile system name of the entry. If not specified, the account's default access control profile is used. You can use the Kaltura API to set a specific access control system name.
Yes 1 string Maximum length: 120 characters
Choice No 1 One of the following choices
conversionProfileId Option 1 The transcoding profile identifier of the entry.
If the transcoding profile is not specified, the transcoding profile set to the bulk upload API action is used.
If the bulk upload API action's transcoding profile is not specified or is set to (-1), the account's default transcoding profile is used.

Yes 1 int
conversionProfile Option 2 The transcoding profile system name of the entry.
If the transcoding profile is not specified, the transcoding profile set to the bulk upload API action is used.
If the bulk upload API action's transcoding profile is not specified or is set to (-1), the account's default transcoding profile is used.
You can use the Kaltura API to set a specific transcoding profile system name.

Yes 1 string Maximum length: 120 characters
startDate The scheduled start date for the entry.
When the start date is not defined, the entry is available for publishing upon creation.

No 1 dateTime
endDate The scheduled end date for the entry.
When the end date is not defined, the entry is available for publishing with no end time restriction.

No 1 dateTime
Choice No 1 One of the following choices
media Option 1 Specifies media-related information, such as media type
Yes 1
msDuration The duration in miliseconds
No 1 int
contentAssets Specifies media/flavor asset information, such as location of media files to upload, type of ingestion, and related transcoding flavor settings
No 1
thumbnails Specifies thumbnail-related information, such as location of media files and related thumbnail flavor settings
No 1
Extensions:
scenes A cue points wrapper element
No Unbounded
customDataItems All custom metadata elemets
No Unbounded
distributions All custom metadata elemets
No Unbounded
subTitles All subTitles elements
No Unbounded
attachments All attachments elements
No Unbounded
attachment Attachment asset element
No Unbounded

XML Example 1: Adding a new media entry: Adding source media file and a default thumbnail
<item>
<action>add</action>

<type>1</type>

<licenseType>-1</licenseType>

<userId>myUserId</userId>

<name>my entry name</name>

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

<tags>
<tag>tag1</tag>

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

<categories>
<category>examples &gt; example1</category>

<category>examples &gt; example2</category>
</categories>

<conversionProfile>MY_TRANSCODING_PROFILE_SYSTEM_NAME</conversionProfile>

<startDate>2011-05-05T00:00:00</startDate>

<endDate>2011-05-19T00:00:00</endDate>

<media>
<mediaType>1</mediaType>
</media>

<contentAssets>...</contentAssets>

<thumbnails>...</thumbnails>
</item>
XML Example 2: Adding a new media entry: Adding multiple previously transcoded files as flavors and multiple thumbnails
<item>
<action>add</action>

<type>1</type>

<licenseType>-1</licenseType>

<userId>myUserId</userId>

<name>my entry name</name>

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

<tags>
<tag>tag1</tag>

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

<categories>
<category>examples &gt; example1</category>

<category>examples &gt; example2</category>
</categories>

<conversionProfile>MY_TRANSCODING_PROFILE_SYSTEM_NAME</conversionProfile>

<startDate>2011-05-05T00:00:00</startDate>

<endDate>2011-05-19T00:00:00</endDate>

<media>
<mediaType>1</mediaType>
</media>

<contentAssets>
<content flavorParamsId="0">...</content>

<content flavorParamsId="1">...</content>

<content flavorParamsId="2">...</content>
</contentAssets>

<thumbnails>
<thumbnail isDefault="true">...</thumbnail>

<thumbnail>...</thumbnail>

<thumbnail>...</thumbnail>
</thumbnails>
</item>
XML Example 3: Updating an existing media entry: Updating both metadata and media
<item>
<action>update</action>

<entryId>{entry id}</entryId>

<userId>UpdatedUserId</userId>

<name>updated entry name</name>

<description>updated entry description</description>

<tags>
<tag>tag3</tag>

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

<categories>
<category>examples &gt; example3</category>

<category>examples &gt; example4</category>
</categories>

<startDate>2011-05-05T00:00:00</startDate>

<endDate>2011-05-19T00:00:00</endDate>

<contentAssets>...</contentAssets>

<thumbnails>...</thumbnails>
</item>
XML Example 4: Deleting an existing entry
<item>
<action>delete</action>

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

media element (T_media)
Media related information

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
mediaType Specifies the entry media type.
Only VIDEO (=1), AUDIO (=5) and IMAGE (=2) are currently supported for XML-based ingestion.

Yes 1 KalturaMediaType

XML Example
<item>
<action>add</action>

<type>1</type>

<media>
<mediaType>1</mediaType>
</media>
</item>

contentAssets element (T_contentAssets)
All content assets

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

No 1 string Acceptable values:
  • update
  • replace
content All Content Assets
No Unbounded

XML Example
<item>
<action>add</action>

<type>1</type>

<media>...</media>

<contentAssets>
<content>...</content>

<content>...</content>

<content>...</content>
</contentAssets>
</item>

content element (T_content)
Specifies media/flavor asset information, such as location of media files to upload, type of ingestion, and related transcoding flavor settings

Attributes
Attribute Name Description Required Type Restrictions
flavorParamsId The identifier of the flavor params to be associated with the media/flavor asset. This is the flavor params identifier across partner entries. The identifier can be used to filter content.
No int
flavorParams The system name of the flavor params to be associated with the media/flavor asset.
This is the flavor params identifier across partner entries. The identifier can be used to filter content.

No string Maximum length: 120 characters
assetId The identifier of the asset to be updated with the media/flavor asset.
Used only for updating an existing media/flavor asset.

No string

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
tags Specifies specific tags for the ingested flavor asset.
Tags are used mostly to set the flavor as suitable for a specific delivery option or device. For example: web, mobile, html5, iphone, ipad, mbr (mbr is used for setting the flavor to an adaptive bit-rate delivery)
When the tags element is not set, the tags assigned to the transcoding flavor are used. In any case, tags from this element will be appended to the flavor params tags already set in the system.

No 1
Choice Yes 1 One of the following choices
serverFileContentResource Option 1 Specifies that the content location is on a Kaltura-hosted server.
By default, this option is not available to Kaltura partners.

Yes 1
urlContentResource Option 2 Specifies that the content location is a URL (http/ftp)
Yes 1
sshUrlContentResource Option 3 Specifies that the content location is a URL (scp/sftp)
Yes 1
remoteStorageContentResource Option 4 Specifies that the content location is a path within a remote storage defined in Kaltura.
Using this option, only a link to the content location is set from the entry, without actually uploading content to Kaltura.

Yes 1
remoteStorageContentResources Option 5 Specifies that content is located within several remote storages defined in Kaltura.
Using this option, only links to the content locations are set from the entry, without actually uploading content to Kaltura.

Yes 1
entryContentResource Option 6 Specifies that the source of content ingestion is the content of an existing Kaltura entry
Yes 1
assetContentResource Option 7 Specifies that the source of content ingestion is a specific asset of an existing Kaltura entry
Yes 1
Extensions: Option 8
dropFolderFileContentResource Specifies that content file location is within a Kaltura defined drop folder
No Unbounded

XML Example
<item>
<action>add</action>

<type>1</type>

<media>...</media>

<contentAssets>
<content>
<tags>
<tag>web</tag>

<tag>mbr</tag>
</tags>

<urlContentResource>...</urlContentResource>
</content>
</contentAssets>
</item>

thumbnails element (T_thumbnails)
All thumbnail assets

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

No 1 string Acceptable values:
  • update
  • replace
thumbnail All Thumbnails Assets
No Unbounded

XML Example
<item>
<action>add</action>

<type>1</type>

<media>...</media>

<contentAssets>...</contentAssets>

<thumbnails>
<thumbnail>...</thumbnail>
</thumbnails>
</item>

thumbnail element (T_thumbnail)
Specifies thumbnail asset information, such as location of image files to upload, type of ingestion, and related thumbnail flavor settings

Attributes
Attribute Name Description Required Type Restrictions
assetId The identifier of the asset to be updated with the resource. Used only for updating an existing thumbnail.
No string
isDefault Specifies whether this thumbnail is set as the default thumbnail of the entry.
No boolean
thumbParamsId The identifier of the thumb params to be associated with this thumbnail asset. This is the thumbnail params identifier across partner entries. The identifier can be used to filter content.
No int
thumbParams The thumb params system name to be associated with this thumbnail asset. This is the thumbnail params identifier across partner entries. The identifier can be used to filter content.
No string Maximum length: 120 characters

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
tags Specifies specific user tags to set for the thumbnail asset
No 1
Choice Yes 1 One of the following choices
serverFileContentResource Option 1 Specifies that the thumbnail location is on a Kaltura-hosted server.
By default, this option is not available to Kaltura partners.

Yes 1
urlContentResource Option 2 Specifies that the thumbnail location is a URL (http/ftp)
Yes 1
sshUrlContentResource Option 3 Specifies that the content location is a URL (scp/sftp)
Yes 1
remoteStorageContentResource Option 4 Specifies that the thumbnail location is a path within a remote storage defined in Kaltura.
Using this option, only a link to the thumbnail location is set from the entry, without actually uploading thumbnails to Kaltura.

Yes 1
remoteStorageContentResources Option 5 Specifies that the thumbnail is located within several remote storages defined in Kaltura.
Using this option, only links to the thumbnail locations are set from the entry, without actually uploading thumbnails to Kaltura.

Yes 1
entryContentResource Option 6 Specifies that the source of thumbnail ingestion is an existing Kaltura entry
Yes 1
assetContentResource Option 7 Specifies that the source of thumbnail ingestion is a specific asset of an existing Kaltura entry
Yes 1
Extensions: Option 8
dropFolderFileContentResource Specifies that content file location is within a Kaltura defined drop folder
No Unbounded

XML Example
<item>
<action>add</action>

<type>1</type>

<media>...</media>

<contentAssets>...</contentAssets>

<thumbnails>
<thumbnail isDefault="true">
<urlContentResource>...</urlContentResource>
</thumbnail>
</thumbnails>
</item>

serverFileContentResource element (T_serverFileContentResource)
Specifies that the location of content ingestion is on a Kaltura-hosted server. By default, this option is not available to Kaltura partners.

Attributes
Attribute Name Description Required Type Restrictions
filePath The full path of the file on the Kaltura-hosted server
Yes string

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
Choice No 1 One of the following choices
fileSize Option 1 The expected size of the file.
Used for validation.

Yes 1 int
fileChecksum Option 2 The expected checksum of the file.
Used for validation.

Yes 1

XML Example 1: Adding content from a Kaltura server: Using file size validation
<item>
<action>add</action>

<type>1</type>

<media>...</media>

<contentAssets>
<content>
<serverFileContentResource filePath="/server/external/disc/path/video.mp4">
<fileSize>453453344</fileSize>
</serverFileContentResource>
</content>
</contentAssets>

<thumbnails>...</thumbnails>
</item>
XML Example 2: Adding content from a Kaltura server: Using checksum validation
<item>
<action>add</action>

<type>1</type>

<media>...</media>

<contentAssets>
<content>
<serverFileContentResource filePath="/server/external/disc/path/file.jpg">
<fileChecksum type="md5">sdfsjodf90sfsdfzfasdfwrg34</fileChecksum>
</serverFileContentResource>
</content>
</contentAssets>

<thumbnails>...</thumbnails>
</item>

urlContentResource element (T_urlContentResource)
Specifies that the location of content ingestion is a URL (http/ftp)

Attributes
Attribute Name Description Required Type Restrictions
url The URL location of the file
Yes

XML Example
<item>
<action>add</action>

<type>1</type>

<media>...</media>

<contentAssets>
<content>
<urlContentResource url="http://my.domain/path/video.mp4"></urlContentResource>
</content>
</contentAssets>

<thumbnails>
<thumbnail>
<urlContentResource url="http://my.domain/path/thumb.jpg"></urlContentResource>
</thumbnail>
</thumbnails>
</item>

sshUrlContentResource element (T_sshUrlContentResource)
Specifies that the location of content ingestion is a URL (scp/sftp)

Attributes
Attribute Name Description Required Type Restrictions
url The URL location of the file
Yes
keyPassphrase The SSH key pass phrase
No string

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
privateKey The SSH private key string
Yes 1 string
publicKey The SSH public key string
Yes 1 string

XML Example
<item>
<action>add</action>

<type>1</type>

<media>...</media>

<contentAssets>
<content>
<sshUrlContentResource url="sftp://user@my.domain/path/video.mp4">
<privateKey>-----BEGIN RSA PRIVATE KEY----- MIIEoQIBAAKCAQEAxVOIocT3q+aQKUvs53LOnxokoJUtZXKHL+LArNl4a3dhZ8wY ZPGwodSydB/jo4aHKZztA0YCPd3LOnxoko3LOnxokoJUtCM/DdVGQfb/0+PpWzPe KIGdzIl3LOoJUtfOAMS6nC3LOnxJUt33LOnxnxokoJUtXN1ej06CYPR5ZfwKFFIO tK1yWx3LOnxokoJUtNRSdEi</privateKey>

<publicKey>ssh-rsa AAAAB3NzaC1yc2l4a3dhZ8wYEAAxVOIocT3q+aQKUvs5omvVdPl4a3dhZ8wY+LArTNl4a3dhZ8wl4a3dhZ8wY/jo4aHKZztA0YCPd3LOnxokoJUtACM/Dm0wq67dVGQfb/0+PpWzPeCKIGdEEPAzIlfOAMS6nC3Hy3ydBFbi5IJtbGmXN1ej06CYPR5ZfwKAD8FFIOa7dMYtK1yWxNRSdEih00Z8vEiiAkoEHDatRMKVbluqdPVTleQzgqnYL/45l4a3dhZ8wYnbItnQYQgyxGbYgmMMVGGZsZnpRhRtvhAUOsQoixRC14sKHsl4a3dhZ8wY/l4a3dhZ8wY+qbHEaDdl4a3dhZ8wY/QWnhlhKQwIzXl4a3dhZ8wY== user@my.domain</publicKey>
</sshUrlContentResource>
</content>
</contentAssets>

<thumbnails>
<thumbnail>
<sshUrlContentResource url="scp://user@my.domain/path/thumb.jpg">
<privateKey>-----BEGIN RSA PRIVATE KEY----- MIIEoQIBAAKCAQEAxVOIocT3q+aQKUvs53LOnxokoJUtZXKHL+LArNl4a3dhZ8wY ZPGwodSydB/jo4aHKZztA0YCPd3LOnxoko3LOnxokoJUtCM/DdVGQfb/0+PpWzPe KIGdzIl3LOoJUtfOAMS6nC3LOnxJUt33LOnxnxokoJUtXN1ej06CYPR5ZfwKFFIO tK1yWx3LOnxokoJUtNRSdEi</privateKey>

<publicKey>ssh-rsa AAAAB3NzaC1yc2l4a3dhZ8wYEAAxVOIocT3q+aQKUvs5omvVdPl4a3dhZ8wY+LArTNl4a3dhZ8wl4a3dhZ8wY/jo4aHKZztA0YCPd3LOnxokoJUtACM/Dm0wq67dVGQfb/0+PpWzPeCKIGdEEPAzIlfOAMS6nC3Hy3ydBFbi5IJtbGmXN1ej06CYPR5ZfwKAD8FFIOa7dMYtK1yWxNRSdEih00Z8vEiiAkoEHDatRMKVbluqdPVTleQzgqnYL/45l4a3dhZ8wYnbItnQYQgyxGbYgmMMVGGZsZnpRhRtvhAUOsQoixRC14sKHsl4a3dhZ8wY/l4a3dhZ8wY+qbHEaDdl4a3dhZ8wY/QWnhlhKQwIzXl4a3dhZ8wY== user@my.domain</publicKey>
</sshUrlContentResource>
</thumbnail>
</thumbnails>
</item>

remoteStorageContentResource element (T_remoteStorageContentResource)
Specifies that the location of content ingestion is a path within a remote storage defined in Kaltura. Using this option, only a link to the content location is set from the entry, without actually uploading content to Kaltura.

Attributes
Attribute Name Description Required Type Restrictions
url The relative path of the file from the remote storage base directory
Yes string

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
Choice Yes 1 One of the following choices
storageProfileId Option 1 The identifier of the remote storage profile used as the source of content ingestion. Only links to the files on this remote storage are set from the entry, without actually uploading content to Kaltura. (The remote storage must be defined in Kaltura.)
Yes 1 int
storageProfile Option 2 The system name of the remote storage profile used as the source of content ingestion. Only links to the files on this remote storage are set from the entry, without actually uploading content to Kaltura. (The remote storage must be defined in Kaltura.)
Yes 1 string Maximum length: 120 characters

XML Example
<item>
<action>add</action>

<type>1</type>

<media>...</media>

<contentAssets>
<content>
<remoteStorageContentResource url="path_from_base_dir/video.mp4">
<storageProfile>MY_STORAGE_PROFILE_SYSTEM_NAME</storageProfile>
</remoteStorageContentResource>
</content>
</contentAssets>

<thumbnails>
<thumbnail>
<remoteStorageContentResource url="path_from_base_dir/thumb.jpg">
<storageProfile>MY_STORAGE_PROFILE_SYSTEM_NAME</storageProfile>
</remoteStorageContentResource>
</thumbnail>
</thumbnails>
</item>

remoteStorageContentResources element (T_remoteStorageContentResources)
Sets the location of content ingestion within several remote storages defined in Kaltura. Using this option, only links to the content location are set from the entry, without actually uploading content to Kaltura.

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
remoteStorageContentResource Specifies that the content location is a path within a single remote storage defined in Kaltura.
Using this option, only a link to the content location is set from the entry, without actually uploading content to Kaltura.

Yes Unbounded

XML Example
<item>
<action>add</action>

<type>1</type>

<media>...</media>

<contentAssets>
<content>
<remoteStorageContentResources>
<remoteStorageContentResource url="path_from_base_dir/video.mp4">
<storageProfile>MY_STORAGE_PROFILE_SYSTEM_NAME_1</storageProfile>
</remoteStorageContentResource>

<remoteStorageContentResource url="path_from_base_dir/video.mp4">
<storageProfile>MY_STORAGE_PROFILE_SYSTEM_NAME_2</storageProfile>
</remoteStorageContentResource>
</remoteStorageContentResources>
</content>
</contentAssets>
</item>

entryContentResource element (T_entryContentResource)
Specifies that the source of content ingestion is the content of an existing Kaltura entry

Attributes
Attribute Name Description Required Type Restrictions
entryId The identifier of the entry that is the origin of the content
Yes string

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
Choice No 1 One of the following choices
flavorParamsId Option 1 The flavor params identifier of the content origin entry
Yes 1 int
flavorParams Option 2 The flavor params system name of the content origin entry
Yes 1 string Maximum length: 120 characters

XML Example: Adding flavor asset from an existing entry and associating it with a specific flavor params in a target entry
<item>
<action>add</action>

<type>1</type>

<media>...</media>

<contentAssets>
<content>
<entryContentResource entryId="{origin entry id}">
<flavorParams>BASIC_SMALL</flavorParams>
</entryContentResource>
</content>
</contentAssets>
</item>

assetContentResource element (T_assetContentResource)
Specifies that the source of content ingestion is a specific asset of an existing Kaltura entry

Attributes
Attribute Name Description Required Type Restrictions
assetId The identifier of the asset that is the origin of the content
Yes string

XML Example
<item>
<action>add</action>

<type>1</type>

<media>...</media>

<contentAssets>
<content>
<assetContentResource assetId="{existing asset id}"></assetContentResource>
</content>
</contentAssets>
</item>

tags element (T_tags)
Free text tags

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
tag Specifies a single tag to set for a related object
No Unbounded string Maximum length: 100 characters

XML Example: Entry tags
<item>
<action>add</action>

<tags>
<tag>tag1</tag>

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

<media>...</media>

<contentAssets>...</contentAssets>
</item>

categories element (T_categories)
Entry`s category assignment.

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
category Specifies a single category assigned to an entry. Use the > character (`&gt;`) to indicate the position of the category in the category tree hierarchy
No 32 string

XML Example: Entry categories
<item>
<action>add</action>

<categories>
<category>examples &gt; example1</category>

<category>examples &gt; example2</category>
</categories>

<media>...</media>

<contentAssets>...</contentAssets>
</item>

dropFolderFileContentResource element (T_dropFolderFileContentResource)
Specifies that content file location is within a Kaltura defined drop folder

Attributes
Attribute Name Description Required Type Restrictions
filePath The name of the file in the drop folder
Yes string Maximum length: 500 characters
dropFolderFileId The id of the drop folder file object
No string

Sub-Elements
Element Name Description Required Maximum Appearances Type Restrictions
Choice No 1 One of the following choices
fileSize Option 1 The expected size of the file
Used for validation

Yes 1 long
fileChecksum Option 2 The expected checksum of the file
md5 or sha1
Used for validation

Yes 1

Using file size validation example
<item>
<action>add</action>

<type>1</type>

<media>...</media>

<content>...</content>

<thumbnail>
<dropFolderFileContentResource filePath="file.jpg">
<fileSize>453453344</fileSize>
</dropFolderFileContentResource>
</thumbnail>
</item>
Using checksum validation example
<item>
<action>add</action>

<type>1</type>

<media>...</media>

<content>...</content>

<thumbnail>
<dropFolderFileContentResource filePath="file.jpg">
<fileChecksum type="md5">sdfsjodf90sfsdfzfasdfwrg34</fileChecksum>
</dropFolderFileContentResource>
</thumbnail>
</item>

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
Extensions: Option 6
dropFolderFileContentResource Specifies that content file location is within a Kaltura defined drop folder
No Unbounded


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-thumb-cue-point
  2. scene-ad-cue-point
  3. scene-code-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-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>

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
Extensions: Option 7
dropFolderFileContentResource Specifies that content file location is within a Kaltura defined drop folder
No Unbounded

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
Extensions: Option 7
dropFolderFileContentResource Specifies that content file location is within a Kaltura defined drop folder
No Unbounded
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>