databases

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

Utilizes HTTP GET method.

http://hostname:port/rdmadmin/?list=databases[options[options]...]

The supported [options] are:

&tables=boolean	Display table names (default is OFF)
&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

If you are not displaying the list of tables you cannot display the columns, keys, and references in the tables.

Example 1

List only the database names.

http://localhost:21553/rdmadmin/?list=databases

Returns

{

    "databases":  [
        {
            "name": "BICYCLE_DB"
        },
        {
            "name": "BOOKSHOP"
        },
        {
            "name": "NSFAWARDS"
        }
    ]
}

Example 2

List the all the databases, tables, columns, keys and references.

http://localhost:21553/rdmadmin/?list=databases&tables=on&columns=off&keys=off&refs=off

Returns

{

    "databases":  [
        {
            "name": "BICYCLE_DB",
            "tables":  [
                {
                    "name": "MANUFACTURER"
                },
                {
                    "name": "BICYCLE"
                }
            ]
        },
        {
            "name": "BOOKSHOP",
            "tables":  [
                {
                    "name": "ACCTMGR"
                },
                {
                    "name": "PATRON"
                },
                {
                    "name": "AUTHOR"
                },
                {
                    "name": "GENRES"
                },
                {
                    "name": "SUBJECTS"
                },
                {
                    "name": "BOOK"
                },
                {
                    "name": "RELATED_NAME"
                },
                {
                    "name": "GENRES_BOOKS"
                },
                {
                    "name": "SUBJECTS_BOOKS"
                },
                {
                    "name": "NOTE"
                },
                {
                    "name": "NOTE_LINE"
                },
                {
                    "name": "SALE"
                },
                {
                    "name": "AUCTION"
                },
                {
                    "name": "BID"
                }
            ]
        },
        {
            "name": "NSFAWARDS",
            "tables":  [
                {
                    "name": "PERSON"
                },
                {
                    "name": "SPONSOR"
                },
                {
                    "name": "NSFORG"
                },
                {
                    "name": "NSFPROG"
                },
                {
                    "name": "NSFAPP"
                },
                {
                    "name": "AWARD"
                },
                {
                    "name": "INVESTIGATOR"
                },
                {
                    "name": "FIELD_APPS"
                },
                {
                    "name": "PROGREFS"
                }
            ]
        }
    ]
}