Describe (Database) Method

Use this method to retrieve database’s description and the list of tables. We do not recommend treating the response as a fixed structure as we reserve the right to extend the output with more information at any time.

Request

GET https://www.teamdesk.net/secure/api/v2/{appid}/describe.{json|xml}

Describe Test API database

GET https://www.teamdesk.net/secure/api/v2/21995/describe.json

Response

{
    "id": "21995",
    "name": "API Test",
    "description": "This is a Test API daatabase",
    "culture": "en-US",
    // as defined in [IANA TimeZone Database](http://en.wikipedia.org/wiki/Tz_database)
    "timeZone": "America/Chicago",
    // an array or table descriptors
    "tables": [
        {
            "id": 115442,
            "recordName": "Test",// you can address the table by this name
            "recordsName": "Tests",
            "alias": "t_115442",// or by alias
            "showTab": true,
            "color": "#0061B0"
        }
        // more tables...
        //, { ... } 
    ]
}