tables

A list of the databases hosted on a TFS can be retrieve using the database list. The table list can optionally list the tables in the database and the columns, keys, and references in the tables. The default is to list only table names.

Utilizes HTTP GET method.

http://hostname:port/rdm/dbname?list=tables[options[options]...]

The name of the database to be queried is dbname and it is case-sensitive if the TFS being queried is running on a file system where file names are case-sensitive. The databases API call to the TFS will return the correct case for the database names that are available to query.

The supported [options] are:

&columns=boolean	Display column names for each table (default is OFF)
&keys=boolean	Display keys for each table (default is OFF)
&refs=boolean	Display references for each table (default is OFF)

boolean values are:

true | false	True or False
1 | 0	1 or 0
on | off	On or Off

Example 1

List the table names in the BICYCLE_DB database.

http://localhost:21553/rdm/BICYCLE_DB/?list=tables

Results

{
    "database": "BICYCLE_DB",
    "tables":  [
        {
            "name": "MANUFACTURER"
        },
        {
            "name": "BICYCLE"
        }
    ]
}

Example 2

http://localhost:21553/rdm/BICYCLE_DB/?list=tables&columns=on

Results

{
    "database": "BICYCLE_DB",
    "tables":  [
        {
            "name": "MANUFACTURER",
            "columns":  [
                {
                    "name": "NAME",
                    "type": "char"
                },
                {
                    "name": "STATE",
                    "type": "char"
                }
            ]
        },
        {
            "name": "BICYCLE",
            "columns":  [
                {
                    "name": "ID",
                    "type": "RDM_ROWID_T"
                },
                {
                    "name": "MAKE",
                    "type": "char"
                },
                {
                    "name": "MODEL",
                    "type": "char"
                },
                {
                    "name": "TYPE",
                    "type": "char"
                }
            ]
        }
    ]
}