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 / entityDeleteRecord

  • Article
  • 2 minutes to read

Description

This method is used to delete a record for the specified entity (business object). The server takes care of the database specific SQL syntax. When deleting a record using this operation, related data will also be deleted (depending on entity configuration settings).

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 entityDeleteRecord 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 you want to update a record for.
keyValue Array<xs:string> Required The key value for record(s) in the primary entity that you wish to delete.
preserveOneToOneData xs:boolean Optional
Default=false		 Set this to ‘true’ if you want to prevent oneToOne related data from being deleted. The default value if not specified is ‘false’
preserveOneToManyData xs:boolean Optional
Default=false		 Set this to ‘true’ if you want to prevent oneTomany related data from being deleted. The default value if not specified is ‘false’
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
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