Multimedia.getInfoForUpload (Method)

Returns a struct containing values like token to upload a multimedia file to external service.

Returns:

Struct

Arguments:

Name Type Required Description
multimediaID MultimediaID Required ID of the multimedia file.
channelID MultimediaChannelID Required ID of a multimedia channel.
metadata Struct Required Metadata like title, caption, description of a multimedia file.
commonspotRefID MultimediaReferenceID_EmptyString Optional. Defaults to an empty string. CommonSpot reference ID to be stored at the external multimedia service.
subsiteID SubsiteID_0 Optional. Defaults to '0'. ID of the subsite where this upload is going.
commandName String_255 Optional. Defaults to 'getUploadInfo'. Name of the Command to call in the Multimedia Service API.

Context:

License Requirements (none)
Permission Requirements subsite:UploadMultimedia
Deny Context (none)
Require Context Authoring
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