listIntegrationTables

JSON hub "listIntegrationTable action lists all existing tables for a given database

The "listIntegrationTables" action lists the tables for a given database.

  • This action lists only integration tables. To list other tables, use the "listTables" action in the JSON DB API.
  • You can do the following:
    • You can return all integration tables by omitting all properties from the "params" object.
    • You can return tables that match a specific database and owner by specifying the optional "databaseNameFilter" and "ownerName" properties. These two properties must be used together.
    • You can return tables that match the partial table name specified in the optional "partialName" property. Using "partialName" also requires specifying the database and owner in the "databaseNameFilter" and "ownerName" properties. These three properties must be used together.

 

Request examples

List all integration tables

{
  "api":        "hub",
  "apiVersion": "1.0",
  "requestId":  "1",
  "action":     "listIntegrationTables",
  "params":     {},
  "authToken": "replaceWithAuthTokenFromCreateSession"
}
 
 

List integration tables with a specific database and owner

{
  "api":        "hub",
  "apiVersion": "1.0",  "requestId":  "2",
  "action":     "listIntegrationTables",
  "params":     {
    "databaseNameFilter": "faircom",
    "ownerName": "admin"
  },
  "authToken": "replaceWithAuthTokenFromCreateSession"
}
 
 

List integration tables using partial name

{
  "api":        "hub",
  "apiVersion": "1.0",
  "requestId":  "3",
  "action":     "listIntegrationTables",
  "params":     {
    "databaseNameFilter": "faircom",
    "ownerName": "admin",
    "partialName": "mqtt_msg_faircomadmin_t",
    "transformNameFilter": "myIntegrationTableTransform"
  },
  "authToken": "replaceWithAuthTokenFromCreateSession"
}
 
 

 

Response examples

Success

{
    "result": {
        "data": [
            {
                "databaseName": "faircom",
                "ownerName": "admin",
                "tableName": "mqtt_msg_faircomadmin_connections"
            },
            {
                "databaseName": "faircom",
                "ownerName": "admin",
                "tableName": "mqtt_msg_faircomadmin_subscribers"
            },
            {
                "databaseName": "faircom",
                "ownerName": "admin",
                "tableName": "mqtt_msg_faircomadmin_topics"
            }
        ]
    },
    "requestId": "1",
    "errorCode": 0,
    "errorMessage": "",
    "authToken": "replaceWithAuthTokenFromCreateSession"
}
 
 

 

Properties

Request properties ("params")

Property Description Default Type Limits (inclusive)

databaseNameFilter

The "databaseNameFilter" property causes the server to include tables that match the entire value of the specified database name, such as "faircom", when set to a non-empty string. 

  • When "databaseNameFilter" is set to an empty string, an action will return tables from all databases.
  • When the value of "databaseNameFilter" is a non-empty string, it must be set to a valid database name.
  • "databaseNameFilter" is case-insensitive.
  • When the "partialName" property is present, the "databaseNameFilter" and "partialName" properties must be set to valid database and owner names.
 Optional with default of ""

string

 1 to 64 bytes

ownerName

The "ownerName" property specifies the account that owns an object, such as a table or code package. See "createSession" and the "defaultOwnerName" property for more details. 

You specify this property when you want to use a different account instead of the default. Your session's account must have the appropriate privileges to access the code package. 

This property is useful because objects, such as tables and code packages, can have the same name in the same database as long as different accounts own each object. This feature allows you to create duplicate objects for different users on the same server and reuse the same JSON actions on those objects. For example, an administrator can copy objects from a production environment to her account so she can troubleshoot an issue using the same JSON actions, JavaScript, and SQL code.

It is an error to set "ownerName" to the empty string "".

If no default owner is specified during "createSession", the server sets the "defaultOwnerName" to the "defaultOwnerName" value specified in the services.json file.

 Optional with default of the session's "defaultOwnerName" property string 1 to 64 bytes

partialName

The "partialName" property returns code packages with code names that match the value of "partialName". The match starts at the name's beginning, making it a "starts with" match instead of a "substring" match. If the partial name is empty, null, or omitted, it matches all names.

 Optional with default of "" string 1 to 64 bytes

transformNameFilter

The "transformNameFilter" property specifies which assigned transform the response will be filtered by. If no integration tables are assigned to the transform, the action returns no tables. If omitted or set to null, the "listIntegrationTables" action will not filter by transform name.

 Optional with default of "" string 1 to 64 bytes

 

Response properties ("result")

Property Description Type Limits (inclusive)

data

The "data" property contains a response message. Its contents are defined by the action. It is an empty array when no results are available. The following is an example of the data property from a code package action.

  "result": {
    "data": [
      {
        "codeId": 6,
        "databaseName": "faircom",
        "ownerName": "admin",
        "codeName": "convertAndCategorizeTemperature",
        "codeVersion": 1,
        "clonedCodeId": 1,
        "codeStatus": "active",
        "codeLanguage": "javascript",
        "serviceName": "javascript",
        "codeType": "module",
        "description": "optional new description",
        "metadata": {},
        "createdBy": "ADMIN",
        "createdOn": "2025-08-25T21:48:38.109",
        "updatedBy": "ADMIN",
        "updatedOn": "2025-08-25T21:48:38.109",
        "comment": "Cloned from convertTemperature",
        "codeFormat": "utf8"
      },
    ]
 array of objects The action determines its contents.

data

.databaseName

The "databaseName" property specifies the database that contains the tables. 

Note In the API Explorer, "defaultDatabaseName" is set to "ctreeSQL" in the "createSession" action that happens at login.

  • If the "databaseName" property is omitted or set to null, the server will use the default database name specified at login.
  • If no default database is specified during "createSession", "databaseName" will be set to the "defaultDatabaseName" value that is specified in the services.json file.
  • This property's value is case insensitive. 
 string 1 to 64 bytes

data

.ownerName

 The "ownerName" property identifies the user who owns an object (see Object owner).  string 0 to 64 bytes

data

.tableName

The "tableName" property is a string containing the name of a table.

See table name in System limits for the table naming requirements and limitations.

 string 1 to 64 bytes

 

Was this article helpful?

Give feedback about this article

Related Articles