Don't forget to check out our JSON RESTful APIs, they can help you utilize and extend Quickbase with ease.
Overview
Use API_GetDBInfo to get metadata information, such as the last time the table was modified. For example, you might use this function to find out if the table has changed since you last used it, or to find out if a new record has been added to the table. You can invoke this call on either an application-level dbid or a table-level dbid.
Request parameters
| Parameter | Value | Required? |
|---|---|---|
|
ticket |
A valid authentication ticket. The authentication ticket is returned via the API_Authenticate call. |
yes, one of:
|
|
usertoken |
A user token – this is a ticket alternative, used for API access |
yes, one of:
|
|
apptoken |
A valid application token. |
yes, if the application requires application tokens |
|
udata |
A string value that you want returned. It will not be handled by Quickbase but it will be returned in the response. |
no |
Response values
| Element Name | Value |
|---|---|
|
action |
The originating request, for example, API_GetDBInfo. |
|
errcode |
Identifies the error code, if any. (See the Error Codes appendix for a list of possible error codes.) 0 indicates that no error was encountered. |
|
errtext |
Text that explains the error code. "No error" indicates that no error was encountered. |
|
udata |
Optional. Contains any udata value supplied in the request. |
|
dbname |
The name of the application or table. |
|
lastRecModTime |
The last time a user modified a record. |
|
lastModifiedTime |
The last time a user modified the table. |
|
createdTime |
The time the table was created. |
|
numRecords |
The number of records in the table. |
|
mgrID |
A number that uniquely identifies the table manager. |
|
mgrName |
The name of the table manager. |
|
version |
Reserved. |
|
time_zone |
A string value that defines the application's time zone. |
Sample XML Request
POST https://target_domain/db/target_dbid
HTTP/1.0
Content-Type: application/xml
Content-Length:
QUICKBASE-ACTION: API_GetDBInfo
<qdbapi>
<ticket>auth_ticket</ticket>
<apptoken>app_token</apptoken>
</qdbapi>
URL alternative
https://target_domain/db/target_dbid?a=API_GetDBInfo&ticket=auth_ticket&apptoken=app_token
where target_domain is the domain against which you are invoking this call, for example, quickbase.com. Read about this notation.
Sample response
<?xml version="1.0" ?>
<qdbapi>
<action>API_GetDBInfo</action>
<errcode>0</errcode>
<errtext>No error</errtext>
<dbname>test</dbname>
<lastRecModTime>1205806751959</lastRecModTime>
<lastModifiedTime>1205877093679</lastModifiedTime>
<createdTime>1204745351407</createdTime>
<numRecords>3</numRecords>
<mgrID>112149.bhsv</mgrID>
<mgrName>AppBoss</mgrName>
<version>2.0</version>
<time_zone>(UTC-08:00) Pacific Time (US & Canada)</time_zone>
</qdbapi>