How can we help?
{{docApp.searchError}}
{{product.name}}
Searching in {{docApp.searchFilterBySpecificBookTitle}}
{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}}
in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.
You have an odd number of " characters in your search terms - each one needs closing with a matching " character!
-
{{resultItem.title}}
{{resultItem.url}}
{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}
{{docApp.libraryHomeViewProduct.description}}
{{group.title || group.id}}
{{group.description}}
Description
This type represents a file.
Properties
| Name | Type | Occurrence | Description |
|---|---|---|---|
fileId |
xs:integer |
Optional | The unique identifier of the file. |
fileName |
fileNameType |
Required | The name of the file as displayed to the user. (i.e. TheFile.txt). |
fileSource |
xs:string |
Optional | The fully qualified path to the file content. This can be any file accessible to the session or reports folder thru WebDAV service, or any other accessible web resource. For example ‘/session/myfile.doc’ or ‘http://www.hornbill.com/thefile.pdf’ or For example ‘/secure-content/inline/ |
fileSize |
xs:unsignedInt |
Optional | The size of the file in bytes. This is not required for related write operations, but provides information when receiving file attachment information. |
mimeType |
xs:string |
Optional | The MIME type that identifies the content data. If not specified on write operations, the server will use the filename extension to establish the mime type |
timeStamp |
xs:dateTime |
Optional | The date/time the file was last modified. |
contentId |
xs:string |
Optional | This contains the CAFS contentId. |
cafsAccessToken |
xs:string |
Optional | The access token needed to access the file content from the CAFS. |
embeddedContentId |
xs:string |
Optional | If this file is an embedded content item, such as an embedded image, then this is the ID that identifies the content within the MIME message encoding |
deletionDateTime |
xs:dateTime |
Optional | Date and time of deletion (if deleted) |
folder |
xs:string |
Optional | The containing folder (fully qualified folder path) |
fileDescription |
fileDescriptionType |
Optional | The description of the file. Currently this is only supported for Entity File Attachments and File Sharing. |
thumbnailSource |
xs:string |
Optional | The fully qualified path to the file’s thumbnail content (if any). This can be any file accessible to the session or reports folder thru WebDAV service, or any other accessible web resource. For example ‘/session/myfile.doc’ or any fully qualified https source image or For example ‘/secure-content/inline/ |
thumbnailStatus |
attachmentThumbnailStatusType |
Optional | The readiness of a server-generated thumbnail for this attachment. Only emitted for attachments belonging to a thumbnail-generating group (currently ‘imageCollage’). When ‘pending’ the thumbnailSource will not be populated and the client should render a placeholder; when ‘ready’ the thumbnailSource will reference the generated thumbnail. |
targetGroup |
xs:anyURI |
Optional | Optional grouping identifier for two or more attachments belonging to the same logical collection on the parent object (e.g. an image collage). Replaces the legacy ‘tgrp:’ prefix bodge previously carried in fileDescription. |
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}
In This Document