Documentation

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

API Services / data

Description

This service provides the operations needed to query, access and update and insert data from the system and application databases managed by Hornbill ESP. All operations for this service require an established session created using credentials with appropriate rights assigned.

Methods

Method Status Type HTTP Method Description
entityAddRecord Status: production Type: rpc HTTP Verb: post This method is used to add a record to an entity (business object). The server takes care of the database…
entityAddRecords Status: production Type: rpc HTTP Verb: post This method is used to add a one or more records to an entity (business object). The server takes care of the…
entityAttachBrowse Status: production Type: rpc HTTP Verb: post This method returns a list of folders and files for a specific entity record and folder. It is possible to get…
entityAttachFile Status: production Type: rpc HTTP Verb: post Use this method to attach one or more files to an entity record. You can send the content of the files as…
entityBrowseRecords2 Status: production Type: rpc HTTP Verb: post This method should be used instead of entityBrowseRecords. This method is used to browse or search for a list of…
entityDeleteRecord Status: production Type: rpc HTTP Verb: post This method is used to delete a record for the specified entity (business object). The server takes care of the…
entityGetActivityStreamAccessToken Status: production Type: rpc HTTP Verb: post Invoke this operation to request access token for the activity streams of type entity. This token contains visibility …
entityGetBrowseMetaData Status: production Type: rpc HTTP Verb: post This method is used to obtain the meta data that describes the data for data::entityBrowseRecords operation.
entityGetRecord Status: production Type: rpc HTTP Verb: post This method is used to read an entity (business object) record. The server takes care of the database specific…
entityUpdateRecord Status: production Type: rpc HTTP Verb: post This method is used to update a record within the specified entity (business object). In order…
In This Document