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

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!

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

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

/ data / entityUpdateRecord

  • Article
  • 3 minutes to read

Description

This method is used to update a record within the specified entity (business object).

In order to update the primary entity record, the primaryEntityData input parameter must include the values needed to uniquely identify the record to be updated. If the record to be updated can not be identified then this operation will fail.

As well as updating the primary entity record it is also possible to add new or update existing related entity records in the same transaction. For each record you wish to add or update you need to provide a relatedEntityData parameter. In order to update a related entity record, the relatedEntityData input parameter must include the values needed to uniquely identify the record to be updated.

Where the database in use supports transactions, if any record update fails then the whole transaction will fail and no changes will be made to the database.

API Details

  • Status:
  • The required privilege level to invoke this method is user
  • The supported database role for this method is none
  • Transactional database functions are used during this method when supported by the target database.
System Rights Database Rights Mail Rights Calendar Rights
--- --- --- ---

Request Parameters

The entityUpdateRecord method takes the following input parameters. It is important to note that the parameters must be passed to the method in the same order as they appear here in order to satisfy the requirement of the input validation checks.

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 you want to update a record for.
returnModifiedData xs:boolean Optional
Default=false		 Set this to ‘true’ if you want to return a copy of all modified data
formatValues xs:boolean Optional
Default=false		 Set this to ‘true’ if you want to format the returned modified 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 returned modified 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
primaryEntityData entityPrimaryDatasetType Required Primary entity data. Its values support CDATA.
relatedEntityData Array<entityUpdateDatasetType> Optional Related entity data. Its values support CDATA.
indexHoldOffTime indexHoldOffTimeType Optional
Default=30		 The amount of time (in seconds) to hold-off adding to the index. If zero is specified then this operation will add the document to the index and return when it has completed. IMPORTANT NOTE: In practice, even if you specify a index hold-off time of zero this operation is still asynchronous which means the update may be deferred if there are other transactions pending and being applied too. If you specify a value greater than zero then the document is added to an in-memory queue and returns to the called, the document is then held in the queue for the number of seconds specified before being committed to the index. This effectively makes the operation asynchronous. It should be noted that when using a indexHoldOffTime the document you are adding to the index will not be found in any subsequent search until the indexHoldOffTime has been reached.

Response Parameters

Name Type Attributes Description
primaryEntityData anyDataType Optional Primary entity data.
relatedEntityData Array<anyDataType> Optional Related entity data.
auditTransactionId xs:string Optional The GUID of the API request used to record data audit trail records
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document