Documentation

This is taking longer than usual. If nothing appears, refresh the page.

Documentation

Enter at least two characters to search
    {{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}}

Keep typing  - a search needs at least two characters

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 Tables / Search Columns

  • Article
  • 2 minutes to read

Operation Information

Search and retrieve all columns for a specific data table. Returns success, a total count, and the first 5 results as flat scalar fields (iBridge does not support array/object response parameters).

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type API Key.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose API Key in the Type pick list;
  • Give the API Key KeySafe key a Title (this is the name / identifier for the API Key account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
ApiKey string Authentication Key
API Endpoint string Optional API Endpoint

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked API Key account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Data Table ID dataTableId string The unique identifier of the data table. Yes None provided

Output Parameters

Display Name ID Type Description
Success success boolean True when the n8n API returned a 2xx status code.
Count count integer Number of items returned by the search. May exceed the 5 flattened results below.
Status Code statusCode integer HTTP status code returned by the n8n API.
Message message string Error message returned when the request was not successful.
Column 1 ID columnId1 string The column 1 id.
Column 1 Name columnName1 string The column 1 name.
Column 1 Type columnType1 string The column 1 type.
Column 2 ID columnId2 string The column 2 id.
Column 2 Name columnName2 string The column 2 name.
Column 2 Type columnType2 string The column 2 type.
Column 3 ID columnId3 string The column 3 id.
Column 3 Name columnName3 string The column 3 name.
Column 3 Type columnType3 string The column 3 type.
Column 4 ID columnId4 string The column 4 id.
Column 4 Name columnName4 string The column 4 name.
Column 4 Type columnType4 string The column 4 type.
Column 5 ID columnId5 string The column 5 id.
Column 5 Name columnName5 string The column 5 name.
Column 5 Type columnType5 string The column 5 type.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document