Link relation pa:import-asset-command

New in MC | Cloud UX 2020.4

Overview

Import an (AAF) asset which was previously uploaded by the pa:upload-file link relation.

HTTP method	POST
URI template variables
Query parameters	commandid	ID to use for the command
embed	(optional) embed imported loc:item resource
Request body		The information about the file to import: `{ "filename" : "uploaded_file_name", "imagename" : "image_file_name (optional)", "datatype" : "AAF or XMD (optional)" }` It must contain at least the filename property with the upload file name returned by the pa:upload-file link relation. It is assumed to be an AAF file, unless explicitely XMD is specified with the datatype property. Optionally the upload file name of a (jpg) headframe file can also be given with the imagename property.
HTTP response	200 OK	The import was successful.
400 Bad Request	Incorrect or missing POST request body.
415 Unsupported	Import command unsupported.
404 Not Found	The uploaded data file doesn’t exist or the service or an intermediate resource is not available.
500 Internal Error	Error during check-in.
Response body	command:command	A command:command resource with the current information about the long-running command. The client should use polling to learn of the progress and lifecycle of the command. Once lifecycle is "finished" (or "error"), the import is complete (or failed). If the (optional) query parameter embed was set to "item", the (successfully) finished command:command does embed the imported loc:item.
Available in		loc:item

HTTP method

POST

URI template variables

Query parameters

commandid

ID to use for the command

embed

(optional) embed imported loc:item resource

Request body

The information about the file to import:

 {
     "filename" : "uploaded_file_name",
     "imagename" : "image_file_name (optional)",
     "datatype" : "AAF or XMD (optional)"
 }

It must contain at least the filename property with the upload file name returned by the pa:upload-file link relation.

It is assumed to be an AAF file, unless explicitely XMD is specified with the datatype property.

Optionally the upload file name of a (jpg) headframe file can also be given with the imagename property.

HTTP response

200 OK

The import was successful.

400 Bad Request

Incorrect or missing POST request body.

415 Unsupported

Import command unsupported.

404 Not Found

The uploaded data file doesn’t exist or the service or an intermediate resource is not available.

500 Internal Error

Error during check-in.

Response body

A command:command resource with the current information about the long-running command.

The client should use polling to learn of the progress and lifecycle of the command.

Once lifecycle is "finished" (or "error"), the import is complete (or failed).

If the (optional) query parameter embed was set to "item", the (successfully) finished command:command does embed the imported loc:item.

Available in