About this resource
Representation of a single preview and thumbnail of a FileVersion
Properties
| Property | Description | Type |
|---|---|---|
| createdOn | Gets the created on. | datetime |
| id | Gets the Id of this preview. | guid |
| isManual | Returns true if this preview has been added manually. false is returned if the preview was created automatically by any of the media engines. | boolean |
| isMaster | Returns true if this is the master preview. | boolean |
| name | Gets or sets the name of this preview. This name does not have to be unique, is not required and can be maximum 50 characters long. | string |
| pageNumber | Gets or sets the page number of this preview. This is used to indicate of which page of a multi-page document this preview was created. | int32 |
| tag | Gets the value of the Tag of this object. This property will not be returned by default. In order to include the property in the response, add a header with the name 'select-filepreview' and the value 'Tag' to your request. | string |
Relations
Actions
| Method | Action | Description | Response codes |
|---|---|---|---|
| PATCH /filepreview/{filePreviewId}/rotationAngle | edit | Edits a rotation angle of preview file. |
Examples
Uploading a file preview
To upload a file preview you can use different ways.
See Uploading Files overview section for details.
Adding or updating a file preview
After a file preview upload process is finished, you will receive a file upload token.
You can use this token to add or update a file preview.
See the examples on creating a record and
editing a record for more details on how to do it.
Keep in mind, the file upload token can be consumed only once.
404 Not Found error response is returned if you try consuming that token more than once.
When adding a file version of a supported format, a preview can be generated automatically. If you want to edit
the metadata of this automatically generated preview in the same request you send to create the version,
you can do this by specifying the same file upload token used to add the file version as id of the preview.
This will not be considered consuming the token, but is only used as convention to address the autogenerated file preview.