rows

The row content of a table is returned using this option. The options allow the user to search for specific rows including ranges of rows as well as change the ordering of the results returned.

The row content of a table can be listed by using the list=rows option.

Searching for specific rows based on different keys is possible with the specific key input. Rows will be returned if the search string is contained in any of the columns of the specified key. To return everything starting with a certain string, use the “start” parameter to specify what the data will start with. Ex: If searching for all rows with the NAME column starting with "A", the "start" parameter would be just an "A" and the “stringlen” parameter would be 1.

Utilizes HTTP GET method.

http://hostname:port/rdm/dbname/tablename/?list=rows[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:

Name	Description
key=name	Specify the name of the key by which to order the retrieved rows.
ref=name	Specify the name of the reference. If the table specified with this option is a referenced table, the rows of the referencing table will be returned whose foreign key value matches the primary key value of the referenced table's row specified with the key and value options. If the table specified with this option is a referencing table, the single row of the referenced table will be returned whose primary key value matches the value specified with the key and value options.
value=value	Specify the value of the primary or foreign key to retrieve the rows from a referencing or referenced table. This option should be used with the ref and key options.
start=value	Specify the start value of the key range when retrieving rows based on a key. The key name should be specified with the key option.
end=value	Specify the end value of the key range when retrieving rows based on a key. The key name should be specified with the key option.
stringlen=value	If the specified key is a string column or a multi-column key whose last column is a string column, specify the length of the partial string on which to do a key search.
order={asc|desc}	Specify the order in which to retrieve rows. If order is not specified, the default order is ascending.
limit=number	Specify the maximum number of rows to retrieve.
position=number	Specify the ordinal position of the first row to retrieve. For example, if 5 is specified with this option, the first four rows will be skipped.

Example 1

http://localhost:21553/rdm/BICYCLE_DB/Manufacturer/?list=rows

List referenced rows

The row content of a table for table referenced from/by another row can be listed by using the list=rows option.

If the specified table is the primary table in the relationship all of the rows in the foreign table that reference the primary row will be displayed.

If the specified table is the foreign table in the relationship the primary table row that is referenced by the foreign row will be displayed.

http://hostname:port/rdm/dbname/tablename/?list=rows&ref=refname&key=keyname[&value=keyvalue][&limit=maxrows][&order/desc/asc]

Example 1

http://localhost:21553/rdm/bicycle_db/MANUFACTURER?list=rows&key=rowid&value=1&ref=BICYCLE_MANUFACTURER_ID

{
    "db": "bicycle_db",
    "ref": "BICYCLE_MANUFACTURER_ID",
    "table": "BICYCLE",
    "key": "rowid",
    "owner key value": "1",
    "row":  [
        {
            "MANUFACTURER_ID": "1",
            "MODEL": "Domane",
            "TYPE": "Road"
        },
        {
            "MANUFACTURER_ID": "1",
            "MODEL": "FX",
            "TYPE": "Hybrid"
        }
    ]
}

Example 2

http://localhost:21553/rdm/bicycle_db/BICYCLE?list=rows&key=rowid&value=1&ref=BICYCLE_MANUFACTURER_ID

{
    "db": "bicycle_db",
    "ref": "BICYCLE_MANUFACTURER_ID",
    "table": "MANUFACTURER",
    "key": "rowid",
    "owner key value": "1",
    "row":  [
        {
            "ID": "1",
            "NAME": "Trek Bicycle Corporation",
            "STATE": "WI"
        }
    ]
}