Skip to main content

Advanced Record Lookup Pipe

With the advanced record lookup pipe you can query a specific data table with advanced functionality such as different output formats, aggregate functions and even format changes. 

Think of this pipe as if you can write and filter any table based on any dynamic values you pass. Similar to how you can write a custom SQL command to filter records. 

Example use cases: 

  • Display data based on very dynamic filtering
  • Dynamically change how this data is displayed in realtime
  • Change output types to Tables/JSON. 

Global Parameters

Once you have the Pipe installed, add your API credentials, which can be found in your app settings, into the Global Parameters tab. 

All API calls below must contain the authorization details in the global parameters. 

This pipe is partially-configurable and the Parameter, Response, and Headers tab can all be easily adjusted according to your specifications. For example, if it suits your app's requirements, you can replace dynamic parameters in the Request tab with hard-coded data. For more information on customizing pipes, see the article on Adding Custom Pipes.

Please Note: If you are hard-coding your parameters, remember to set the parameters' required option to 'off' in the Parameters tab (if you won't be using them). Otherwise, you will get an error, and the pipe will not be triggered.

API Calls

The Advanced Record Lookup pipe contains the following API calls:

Additionally, you can add the following operations to any of the API calls:

Basic Record Search

Returns an array of all records in the table with the specified fields.

Parameters
  • Table ID - Enter the Table ID of the Tadabase table you would like to search.
  • Response Fields - Enter the Field IDs of the fields you would like to be included in the response. Field IDs must be in quotes and separated with commas. 

Response

The following responses have already been added.

  • Status
  • Records (array) - Array responses can only be displayed using custom components or JavaScript. 
  • Total Number of Records

Record Search with a Single Filter

Returns an array of all records in the table that match the given condition.

Parameters
  • Table ID - Enter the Table ID of the Tadabase table you would like to search.
  • Response Fields - Enter the Field IDs of the fields you would like to be included in the response. Field IDs must be in quotes and separated with commas. 
  • Field ID - Enter the Field ID of the field you would like to filter by.
  • Filter Condition (i.e., "is" or "is not")
  • Value - Enter the value by which the condition is true.

In the example below, the API call returns an array of all records in the table where field_46 is equal to "Active".

Response

The following responses have already been added.

  • Status
  • Records (array) - Array responses can only be displayed using custom components or JavaScript. 
  • Total Number of Records

Record Search with 2 Filters

Returns an array of all records in the table that match the given conditions.

Parameters
  • Table ID - Enter the Table ID of the Tadabase table you would like to search.
  • Response Fields - Enter the Field IDs of the fields you would like to be included in the response. Field IDs must be in quotes and separated with commas. 
  • Filter Field ID 1 - Enter the Field ID of the field you would like to filter by.
  • Filter Condition 1 (i.e., "is" or "is not")
  • Filter Value 1 - Enter the value by which the condition is true.
  • Filter Field ID 2- Enter the Field ID of the field you would like to filter by.
  • Filter Condition 2 (i.e., "is" or "is not")
  • Filter Value 2- Enter the value by which the condition is true.
  • Filter Operator - Filter according to both conditions or either one? Options: AND or OR. Default: AND

In the example below, the API call returns an array of all records in the table where field_46 is equal to "Active" and the field 43 is equal to In Progress

Response

The following responses have already been added.

  • Status
  • Records (array) - Array responses can only be displayed using custom components or JavaScript. 
  • Total Number of Records

Basic Record Search with Uppercase Function

Returns an array of all records in the table that match the given conditions.

Parameters
  • Table ID - Enter the Table ID of the Tadabase table you would like to search.
  • Response Fields - Enter the Field IDs of the fields you would like to be included in the response. Field IDs must be in quotes and separated with commas. 
  • Field to Uppercase - Enter the Field ID of the field you would like to convert to uppercase.

In the example below, the API call returns an array of all records in the table with an  additional field of field_41_uppercase which contains the uppercased value of field_41.

Response

The following responses have already been added.

  • Status
  • Records (array) - Array responses can be displayed using custom components or JavaScript. 
  • Total Number of Records

Back to top