Service Info: data
Service 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.
Available Operations
The following operations are available for the data service. You can click on each operation to see detailed information about that operation.
| Operation | Description |
|---|---|
| addRecord | Use this method to add one or more records to a table within the specified database. This operation is transactional and requires that all records submitted for addition must be successfully added, otherwise any changes will be rolled back. |
| autoValueGetNext | This operation gets the next value from the specified autoValue. |
| copyRecord | This method is used to copy a record from any database being managed by Hornbill ESP. The server takes care of the database specific syntax, when copying a record using this method the source table needs to have a primary key column(s) and you need to provide a key value in order to select a record. |
| deleteRecord | This operation allows you to delete a record from a table. The table you want to delete a record from must have a primary key associated with it which may be a single or multi-column primary key. |
| doesFlowcodeExist | Returns whether the specified FlowCode operation exists or not. |
| doesRecordExist | This method is used to check if a record exists in any database being managed by Hornbill ESP. The server takes care of the database specific syntax, To check a record using this method the source table needs to have a primary key column(s) and you need to provide a key value in order to select a record. If the specified table was not found it throws an error. |
| entityAddRecord | This method is used to add a record to an entity (business object). The server takes care of the database specific SQL syntax. |
| entityAddRecords | This method is used to add a one or more records to an entity (business object). The server takes care of the database specific SQL operations. |
| entityAttachBrowse | This method returns a list of folders and files for a specific entity record and folder. It is possible to get information about single file, too. |
| entityAttachCleanup | This operation will remove files from the entity attachment store that have been marked for deletion when data::entityFileRemove was invoked. This is an asynchronous operation that starts a background task. This operation can be called manually but is typically called by a scheduled job configured by the system administrator to run at given days/times when the system is likely to be less busy. |
| entityAttachDoesExist | This method checks if the requested entity file attachments exists |
| entityAttachFile | Use this method to attach one or more files to an entity record. You can send the content of the files as embedded content, or alternatively you can reference content that already exists on the server, accessible to your session via WebDAV. |
| entityAttachFolderCreate | This method allows you to create an attachment folder for the specified entity and record. |
| entityAttachFolderDelete | This method allows you to delete a virtual folder for file attachments. |
| entityAttachGetDeletedFiles | Lists deleted files. |
| entityAttachGetDeletedInfo | This method retrieves information about a deleted entity file attachment |
| entityAttachGetInfo | This method retrieves information about the requested entity file attachments |
| entityAttachGetStats | This method returns statistics about the file attached to the given entity, either for all records or for some of them. |
| entityAttachMove | This method allows you to move a file attachment to a different virtual folder. |
| entityAttachRecover | Recovers a previously deleted file. The containing folder (and its parent folders) will be created if it does not exists. |
| entityAttachRemove | This method allows you to remove one or more entity record's file attachments. This operation marks the file for removal, the actual file will be deleted in the background or when entityFileCleanup is called. This operation will remove all specified files. If one or more of the specified files does not exist this will be ignored. Only when no files specified are not found will an error be returned. |
| entityAttachUpdateInfo | This method allows you to modify some information related to an entity file attachment |
| entityBrowseRecords | DEPRECATED: INSTEAD USE data::entityBrowseRecords2 This method is used to browse or search for a list of entity records within the specified entity. This is typically used for providing the user a list of records in order to choose one and is often front-ended with a restrictive browse or search GUI, for example, within a search form to find and select a customer. |
| entityBrowseRecords2 | This method should be used instead of entityBrowseRecords. This method is used to browse or search for a list of entity records within the specified entity. |
| entityDeleteRecord | 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). |
| entityDoesRecordExist | This method is used to check if an entity (business object) record exists. The server takes care of the database specific syntax. To check a record using this method the Entity as well as the primary key value needs to be provided. If the specified entity was not found it throws an error. |
| entityGetActivityStreamAccessToken | Invoke this operation to request access token for the activity streams of type entity. This token contains visibility of the user over this activity stream. Please note these access tokens are time limited. |
| entityGetBrowseMetaData | This method is used to obtain the meta data that describes the data for data::entityBrowseRecords operation. |
| entityGetIndexInfo | This method retrieves information about what is indexed for the given entity, giving you the ability to populate the parameters of indexer::indexSearch to search that entity. |
| entityGetMailTemplateParams | Returns all the parameters that can be used in entity related mail templates |
| entityGetMetaData | This method is used to obtain the entity (business object) meta data. |
| entityGetNameList | This method is used to obtain a list of entity records for the named entity. This is typically used for providing the user a list of names in order to select an entity for example, within a drop-down selection box. |
| entityGetRecord | 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. |
| entityLinkCreate | Creates link between entities of the same type through linking table. |
| entityLinkDelete | Deletes an existing link between entities of the same type from the linking table. |
| entityLinkQuery | Queries existing links between entities of the same type from the linking table. |
| entityLinkUpdate | Updates values of an existing link between entities of the same type in the linking table. |
| entityNameLookup | This method is used to obtain a single name record by ID. This is typically used for providing the display value for a default selected within a drop-down selection box without the need to load the full list first. |
| entitySearch | This method searches an index for entities matching the query string. |
| entityUpdateRecord | 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. |
| formatValue | This operation allows you to format a raw value using the specified formatter. |
| getDatabaseList | This operation gets a list of application assigned databases (not system databases). |
| getDatabaseSchema | This operation gets a list of table descriptions. |
| getRecord | This method is used to read a record from any database being managed by Hornbill ESP. The server takes care of the database specific syntax, when getting a record using this method the source table needs to have a primary key column(s) and you need to provide a key value in order to select a record. |
| getRecordCount | This method is used to get a count of records from the specified table with an optional where clause. |
| getTableColValue | This operation gets a column value from a table by resolving a key from another column. |
| getTableInfo | This operation gets a description of the specified table. |
| getTableList | This operation gets a list of the tables that your current application has access to. |
| getUserList | Invoke this operation to obtain active user(s) information. |
| listAddItem | Invoke this operation to add a new item and optionally add item name translations for the specified list. |
| listAddItemTranslation | Invoke this operation to add item name translations for the existing item in the list. |
| listDelete | Invoke this operation to delete the list. |
| listDeleteItem | Invoke this operation to delete a list item and its associated item translation(s) for the specified list. |
| listDeleteItemTranslation | Invoke this operation to delete a specific items translation |
| listGetItem | Invoke this operation to get an item and its associated item translation(s) for the specified list. |
| listGetItems | This operation returns the items associated with the specified list. |
| listGetList | This operation returns the list(s) that are available. |
| listUpdateItem | Invoke this operation to update an existing item's value or default item name for the specified list. |
| listUpdateItemTranslation | Invoke this operation to update an existing item's name or associated language for the specified list. |
| profileCodeAdd | This operation adds a new profile code. |
| profileCodeDelete | This operation deletes a profile code. |
| profileCodeGet | This operation looks up full information about the specified profile code. |
| profileCodeGetList | This operation returns the list of codes with their children for a given profile code group. |
| profileCodeLookup | This operation looks up information about the specified profile code. |
| profileCodeRename | This operation allows you to change the code for the specified item. |
| profileCodeSetGetInfo | This operation get the profile code set properties. |
| profileCodeSetGetList | This operation returns the list of the profile code set. |
| profileCodeUpdate | This operation updates information for and existing profile code. |
| profileGetCodeGroupId | This operation gets the unique ID for the top-level item for the specified code group. |
| queryAnalyze | This operation allows you to invoke a pre-defined query to analyse the resultant SQL as well as the expected result set meta data. This operation will only be allowed to execute SELECT statements. |
| queryExec | This operation allows you to invoke a stored query. This operation will only be allowed to execute SELECT statements. |
| queryExecAndExport | This operation allows you to invoke a stored query and export the results in the specified file format. |
| recordClearCache | This method is used to clear the cache for a record, or all records for a specified table |
| sqlQuery | This operation allows you to issue an SQL query to one of the databases managed by
Hornbill ESP. The optional result set can be raw data or can be formatted in the
context of the user and application specific settings. NOTE: This operation should generally be avoided, you should instead use the data::queryExec method to invoke a pre-defined query. |
| sqlQueryAndExport | This operation allows you to execute a query and export the results in the specified file format. |
| updateRecord | This method is used to update one or more existing records in the specified database. The server abstracts the data from the database specific syntax. Given the data, The ESP server builds the appropriate SQL statements. Updating a record in the database using this method will fire the appropriate FlowCode event(s). This operation requires that all record updates are successful. If any update fails then the operation rolls-back any changes made to the database and returns an appropriate error to the caller. |
| upsertRecord | Use this method to add/update one or more records to a table within the specified database. This operation is transactional and requires that all records submitted for addition must be successfully added, otherwise any changes will be rolled back. |
| validateRecordName | This method is used to validate a record by a column value. |
| validateValue | This operation allows you to take a value typically provided by user input and validate it against the specified validator. |