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

API Services / data

  • Article
  • 2 minutes to read

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 This method is used to add a record to an entity (business object). The server takes care of the database…
entityAddRecords This method is used to add a one or more records to an entity (business object). The server takes care of the…
entityAttachBrowse This method returns a list of folders and files for a specific entity record and folder. It is possible to get…
entityAttachFile Use this method to attach one or more files to an entity record. You can send the content of the files as…
entityBrowseRecords2 This method should be used instead of entityBrowseRecords. This method is used to browse or search for a list of…
entityDeleteRecord This method is used to delete a record for the specified entity (business object). The server takes care of the…
entityGetActivityStreamAccessToken Invoke this operation to request access token for the activity streams of type entity. This token contains visibility …
entityGetBrowseMetaData This method is used to obtain the meta data that describes the data for data::entityBrowseRecords operation.
entityGetRecord This method is used to read an entity (business object) record. The server takes care of the database specific…
entityUpdateRecord This method is used to update a record within the specified entity (business object). In order…
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document