Multimedia.getExternalObjects (Method)

 

Returns:

Multimedia_getExternalObjects_Result_Query (query)

Each row of the returned query results has the following fields:

Field Name	Type	Description
CreationDate	Datetime	Date the object was created at external service.
CSReferenceID	PlainText_255	The CS reference ID stored at the external service. The format is #serverKey#_#siteID#_#pageID#_#versionID#.
CSReferenceIDList	PlainText_2000	Full list of CSReferenceIDs assigned to this object in the format of | delimited list.
DisplayedDate	Datetime	The date and time requested by the value within this method's 'displayDate' argument.
Extension	MultimediaFileExtension_EmptyString	Extension (if any) for the multimedia object.
ExtReferenceID	PlainText_NonNull_255	Unique reference ID assigned to the Multimedia Object by external service.
FileName	PlainText_255	FileName of the Multimedia object.
FileSize	NonNegativeLongInteger_EmptyString	Multimedia object file size (if any) in bytes.
FormattedLength	String_255	The item's length formatted in hh:mm:ss format.
FormattedSize	String_255	The items's size formatted in megabytes, as decimalformat.
Height	NonNegativeInteger_EmptyString	Multimedia Object height.
KeywordsList	KeywordList_NonExisting_EmptyString	List of keywords (tags) entered at the time of creation/update at the external service.
LastModifiedDate	Datetime	Date the object was last modified at the external service.
LongDescription	PlainText_2000	A longer text describing the Multimedia Object.
MediaLength	NonNegativeInteger_EmptyString	Multimedia object length in seconds.
MultimediaObjectStatus	MultimediaObjectStatus	Status of the Multimedia object at the external service.
PublishedDate	Datetime	Date the object was published at external service.
ServiceCategoryList	PlainText_2000	External service specific category (not related to CommonSpot category).
ShortDescription	PlainText_255	A short text describing the Multimedia Object.
ThumbnailSize	PlainText_25	A string that represents size type of the thumbnail image as defined by the external service. for eg:default,standard,high,poster.
Title	PlainText_NonNull_255	Title of the Multimedia object.
VideoStillURL	FullyQualifiedURL_EmptyString	External service URL of the media still generated by the service.
VideoURL	ValidURL_EmptyString	Direct URL at the external service to the Multimedia object.
Width	NonNegativeInteger_EmptyString	Multimedia Object width.

Arguments:

Name	Type	Required	Description
channelID	MultimediaChannelID	Required	ID of the Multimedia channel.
multimediaObjectStatusFilter	MultimediaObjectStatusFilter	Optional. Defaults to 'external,interrupted_upload'.	Status filter for the objects returned by external service.
searchString	PlainText	Optional. Defaults to an empty string.	String to search in any of the fields.
searchFilterType	PlainText_20	Optional. Defaults to 'any'.	Search type. If 'any', search string is searched in any of the search fields. If type is 'all' search string should be present in all searched fields. If type is 'none', search string should not be present in any of the searched fields.
displayDate	PlainText_255	Optional. Defaults to 'CreationDate'.	A string describing the date field to display. Examples are CreationDate or LastModifiedDate or PublishedDate.
orderBy	SQLOrderByClause	Optional. Defaults to 'CreationDate DESC'.	The SQL 'order by' clause indicating which column is used as the returned data's sort key.
saveForImport	Boolean	Optional. Defaults to '0'.	When true, the query is stored in the session scope and passed for the Import job.

Context:

License Requirements	(none)
Permission Requirements	multimediaChannel:ManageMedia
Deny Context	(none)
Require Context	AuthoringEnabled
Author Lock	(not required)
Transaction Logging	Transaction logging is disabled for this method
Customization	Customization is not supported for this method.

Error Codes:

None

Notes:

None