Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Complex Types - serverFileAttachmentType

  • Article
  • 2 minutes to read

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