Documentation

This is taking longer than usual. If nothing appears, refresh the page.

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

  • Article
  • 1 minutes to read

Description

This type represents a file with the file data embedded as BASE64 encoded content.

Properties

Name Type Occurrence Description
fileName fileNameType Required The name of the file as displayed to the user. (i.e. TheFile.txt).
fileData xs:base64Binary Optional The base64 encoded file’s content. This is optional for Embedded / Background Image, instead contentId param should be sent.
fileSize xs:unsignedInt Optional The size of the file in bytes. This is not required for request, but it’s useful when receiving file attachment information.
timeStamp xs:dateTime Optional The date/time the file was last modified.
contentType xs:string Optional MIME Type of the file
contentId xs:string Optional Content Id - used for sending HTML message(s) with Embedded / Background Image(s)
fileDescription fileDescriptionType Optional The description of the file. Currently this is only supported for Entity File Attachments and File Sharing.
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