About this resource
Representation of a specific version of a File
Properties
Property | Description | Type |
---|---|---|
aiInfluenced | Indicates if this version has content generated by AI. | string (values: unknown, no, yes) |
annotationInfo | Gets the annotation info of this file version. This property will not be returned by default. In order to include the property in the response, add a header with the name 'select-fileversion' and the value 'AnnotationInfo' to your request. | FileVersionAnnotationInfo |
comment | Gets the comment on this file version. | string |
content | Gets the value of the Content of this object. The value of this property should be a valid XML. An empty string will be automatically converted to null. This property will not be returned by default. In order to include the property in the response, add a header with the name 'select-fileversion' and the value 'Content' to your request. | string |
crc32 | Gets the CRC32 checksum of this file version. This checksum is not immediately calculated when ingesting, so it might not yet be available. | int32 |
createdOn | Gets the creation datetime in UTC time. | datetime |
duplicateInfo | Gets the duplicate info of this file version. This property will not be returned by default. In order to include the property in the response, add a header with the name 'select-fileversion' and the value 'DuplicateInfo' to your request. | FileVersionDuplicateInfo |
fileCreatedOn | Gets creation datetime of the physical asset file, in UTC time. | datetime |
fileExtension | Gets the file extension of this file version. An empty string will be returned if this file version does not have a file extension. | string |
fileModifiedOn | Gets the date/time in UTC time on which the file version was last modified. | datetime |
fileName | Gets the file name of this file version. | string |
fileSize | Get the file size of this file version. | int64 |
fileState | Gets the state of the file. | string (values: available, processing) |
id | Gets the id of the file version. | guid |
isLatest | Indicates if this version is the latest. | boolean |
metadata | Gets a collection containing the metadata of this file version. This property will not be returned by default. In order to include the property in the response, add a header with the name 'select-fileversion' and the value 'Metadata' to your request. | Dictionary of pairs with string keys and FileVersionMetadata values |
preventDownload | Indicates whether the download of this file version is prevented. | boolean |
publicationItems | Gets a collection of all the items used in this publication. This property will not be returned by default. In order to include the property in the response, add a header with the name 'select-fileversion' and the value 'PublicationItems' to your request. | Collection of PublicationItem items |
publications | Gets a collection of all the publications this file version is an item of. This property will not be returned by default. In order to include the property in the response, add a header with the name 'select-fileversion' and the value 'Publications' to your request. | Collection of guid items |
tag | Gets the value for the Tag of this object. The value of this property should be a valid XML. An empty string will be automatically converted to null. This property will not be returned by default. In order to include the property in the response, add a header with the name 'select-fileversion' and the value 'Tag' to your request. | string |
versionLabel | Gets the text that describes this file version. It is not required, can be a maximum of 50 characters long and has to be unique for all the file versions. | string |
versionNumber | Gets the version number of this version. The first version is always version 1. This number is automatically incremented when a new version is added. | int32 |
watermarkId | Gets or sets the watermark id. | guid |
watermarkType | Gets or sets the watermark type. | string (values: none, inheritfromfile, usespecified, usesetting) |
Relations
Method | Name | Select-key | Resource type | Description |
---|---|---|---|---|
GET | self | Provides a link to this resource. | ||
GET | filetype | select-FileVersion: filetype | FileType | Gets the file type of this file version. |
GET | filepreviews | select-FileVersion: filepreviews | FilePreviewCollection | Gets a collection containing all the file previews of this file version. |
GET | masterfilepreview | select-FileVersion: masterfilepreview | FilePreview | Gets the master file preview of this file version. |
GET | preview | select-FileVersion: preview | Image | Gets the master preview image of this file version. |
GET | thumbnail | select-FileVersion: thumbnail | Image | Gets the master thumbnail of this file version. |
GET | additionalfiles | select-FileVersion: additionalfiles | AdditionalFileCollection | Gets a collection containing all the additional files of this file version. |
GET | renditions | select-FileVersion: renditions | RenditionCollection | Gets a collection containing all the renditions of this file version. |
GET | publiclinks | select-FileVersion: publiclinks | PublicLinkCollection | Gets a collection containing all the renditions of this file version. |
GET | watermark | select-FileVersion: watermark | Watermark | Gets the watermark. |
GET | publicuris | select-FileVersion: publicuris | PublicUriCollection | Gets the public uri links |
GET | permissions | select-FileVersion: permissions | FileVersionPermissions | Gets permissions the user has on this file version |
GET | usedin | LinkedVersionInfoCollection | Gets the publications this version is used in. | |
GET | contains | LinkedVersionInfoCollection | Gets the publication items that are on this version. | |
GET | createdby | select-FileVersion: createdby | User | Gets or sets the user that created this resource. |
Examples
Adding or updating a file version
After a file upload process is finished, you will receive a file upload token.
You can use this token to add or update a record's file or file version.
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.
Applying a watermark to a file version
A watermark can be applied to a file version and can be configured through the
creation of a record and/or
editing of a record. For more info, see the
Watermark resource page.
Setting publication items
Every fileversion can be a publication or a publication item.
By adding the header property "select-fileversion: PublicationItems" publication items of the current fileversion will be returned.
By adding the header property "select-fileversion: PublicationItems" publication items of the current fileversion will be returned.
GET /fileversion/id select-fileversion: PublicationItemsThe publicationitems property on the fileversion resource can be set through a PUT or POST (this will create a record with PublicationItems) request on /record/record-id. The fileversion specified in TargetFileVersionId must exist.
PUT /record/8735a5a3e75a4bc0a2a1a3cd0069b669 { "files": { "addOrUpdate": [ { "id": "da75e95e-e306-4f1d-baeb-a5980109c930", "versions": { "addOrUpdate": [ { "id": "471CD6A8-29A9-441E-BD09-623903201248", "publicationitems": [ { "isManual": false, "pageNumber": 1, "targetFileVersionId": "A49312A6-1F8F-4762-B4A5-246828F33597" }, { "isManual": false, "pageNumber": 2, "targetFileVersionId": "3ED5CA3C-87AC-4779-82D0-358D9124157F" } ] } ] } } ] } }
NOTE: the "isManual" property is not mandatory, but it is recommended to set this property to true when manually setting publicationitems. If not specified the value is defined by ADAM.
Setting publication items will always overwrite the complete collection.
See the examples on creating a record and editing a record for more details on how to set publication items on a record.