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}}

/ data / entityAttachFile

  • Article
  • 2 minutes to read

Description

Use this method to attach one or more files to an entity record. You can send the content of the files as embedded content, or alternatively you can reference content that already exists on the server, accessible to your session via WebDAV.

API Details

  • Status:
  • The required privilege level to invoke this method is user
  • The supported database role for this method is none
System Rights Database Rights Mail Rights Calendar Rights
--- --- --- ---

Request Parameters

The entityAttachFile method takes the following input parameters.

Note

When sending a JSON request payload to the API, the order of parameters is not significant. However, for XML request payloads, parameters must be provided in the exact order specified in this documentation to comply with input validation requirements.

Name Type Attributes Description
application appNameType Optional Specify the name of the application this operation relates to. If not specified then “system” is assumed.
entity simpleIdType Required The name of the entity to which the file(s) will be attached.
keyValue xs:string Required The record ID of the record for the specified entity you wish to attach the file(s) to.
folder xs:string Optional File attachments can be stored in a logical folder structure which is unique for each entity record. You can specify the folder to place the file(s) into for this entity record. This folder must exist before trying to place files into it. If not specified the file will be stored at the root of the virtual structure for this entity.
localFile Array<embeddedFileAttachmentType> Optional The file to attach. Use this type if you are embedding the file content within the XMLMC message
serverFile Array<serverFileAttachmentType> Optional The file to attach. Use this type if you the file content is accessible to the server, for example a temporary file on the session
overwrite xs:boolean Optional
Default=false		 Specifies whether existing files (if any) have to be overwritten.
deleteSessionSource xs:boolean Optional
Default=false		 Set this to true to delete temporary file from session folder. This is only applicable if one of the serverFile references /session/… file for attachment.

Response Parameters

Name Type Attributes Description
contentLocation Array<xs:anyURI> Optional The location that the content of this file has been stored.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document