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

/ data / entityGetRecord

  • Article
  • 2 minutes to read

Description

This method is used to read an entity (business object) record. The server takes care of the database specific syntax. When getting a record using this method the Entity as well as the primary key value needs to be provided.

API Details

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

Request Parameters

The entityGetRecord 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 business entity you want to query.
keyValue xs:string Required The primary key value for the record you want to read.
formatValues xs:boolean Optional
Default=false		 Set this to ‘true’ if you want to format the values based on your Application settings, Otherwise, raw values read from the database will be returned
returnRawValues xs:boolean Optional
Default=false		 This is an optional parameter, the default value is ‘false’. If you specify true, then the result data will include raw values for columns that have been formatted. The raw values are returned as an attribute in the corresponding column value called “raw”. The raw value will only be present if: -

- The value has been formatted and is now different to the raw value
- The column is not a TEXT or BLOB data type
returnMeta xs:boolean Optional
Default=false		 Set this to ‘true’ if you want to return table meta data
returnRelatedData xs:boolean Optional
Default=false		 Set this to ‘true’ if you want to return related table data. The default value if not specified is ‘false’
returnOneToManyData xs:boolean Optional
Default=false		 Set this to ‘true’ if you want to return OneToMany related table records. The default value if not specified is ‘false’ and as a general rule the system would use a remote query and SQL table control to display One-To-Many related records. However, it is sometimes convenient to obtain this data in a single transaction, for example when creating a report of an entity’s record and its related data.
returnActivityStreamAccessToken xs:boolean Optional
Default=false		 Set this to ‘true’ if you want to get access token to view activity stream without following it with appropriate visibility instead of default public visibility.
selector entitySelectType Optional EXPERIMENTAL: Specify a restricted subset of columns to get. If not specified, then all columsn will be returned as before.

Response Parameters

Name Type Attributes Description
primaryEntityData primaryEntityQueryDatasetType Required Primary entity data.
relatedEntityData Array<relatedEntityQueryDatasetType> Optional Related entity data.
accessToken xs:string Optional Token to access the activity stream related to the specified primary record.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document