Assign Asset Preview Image

"Generate a request to upload an image or PDF file to be the new preview for one or more Assets. Supported preview image formats include: GIF, JPG, PNG, and TIFF.\n\nIf a PDF file is uploaded to be the preview for a document Asset, then the PDF will also be displayed in the Asset Detail page as the multi-page PDF preview.\n\nAfter submitting the request to replace an Asset preview, \n\nThe user replacing the Asset previews must be granted the Replace Mezzanine and Upload User Role Permissions and View Security Template Permission on the Assets being updated.\n\nFor Federated Assets, if user provides optional contentPaths key in the request body, then files referenced in the contentPaths > properties are used as renditions."

Average Response Time: 953ms

SecurityApiKeyAuth or BasicAuth
Request
header Parameters
X-API-Key
required
string

Customer-specific API key required to invoke API.

Authorization
required
string

Provided by Authentication Token creation operation

AccessToken
required
string

JWT token provided by Authentication Token creation operation.

Content-Type
required
string
Value: "application/json"
Request Body schema: application/json
required

The Request Body must be a JSON object.

fileIds
Array of strings <uuid>
filename
string
filesize
integer
contentPaths
object

This property is used only for federated assets

Responses
200

Successful operation

400

Invalid status value

401

Unauthorized. Missing Authorization or AccessToken or expired token

403

Forbidden. Missing X-API-key

post/asset/content/preview
Request samples
application/json
{
  • "fileIds": [
    ],
  • "filename": "Preview.jpg",
  • "filesize": 1024,
  • "contentPaths": {
    }
}
Response samples
application/json
{
  • "message": "Message sent successfully",
  • "status": "string"
}