API_GetAppDTMInfo

Overview

Use API_GetAppDTMInfo to get  the timestamp of the last time change throughout the application. You must invoke this call on an application dbid, not on a table dbid.

This is a fast, unobtrusive way to get the time of the last change in an application schema or in records within its tables. No ticket or app token is required for this call, nor does this call result in the application being loaded into memory in QuickBase.

The response to this call contains a parameter indicating the next time you will be allowed to make this call again.

top

Request parameters

Parameter Value Required?

dbid

The application dbid.

yes

top

Response values

Element Name Value

action

The originating request, for example, API_GetAppDTMInfo.

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.

RequestTime

The time at which the server received this request.

All times expressed as milliseconds since January 1st 1970 00:00:00, UTC.

RequestNextAllowedTime

The earliest time that another API_GetDBDTMInfo request for the same Application DB ID is permitted. All times expressed as milliseconds since January 1st 1970 00:00:00, UTC.

If another request is received before this time, an errcode of 77 is returned, with an errtext of "API request limit exceeded".

app

Aggregate containing the last time the application schema was modified (lastModifiedTime) and the last time the application’s main table was written to (lastRecModTime).

Invoke this call on an application dbid. The aggregate is structured as follows:

<app id="the app dbid here">
   <lastModifiedTime>milliseconds</lastModifiedTime>
   <lastRecModTime>milliseconds</lastRecModTime>
</app>

All times expressed as milliseconds since January 1st 1970 00:00:00, UTC.

tables

Aggregate containing one or more table sub-aggregates. The table sub-aggregate contains the following:

<table id="the table dbid here">
   <lastModifiedTime>milliseconds</lastModifiedTime>
   <lastRecModTime>milliseconds</lastRecModTime>
</table>

where lastModifiedTime refers to any changes made to the table schema and lastRecModTime refers to any writes to the table in terms of records added or modified.

All times expressed as milliseconds since January 1st 1970 00:00:00, UTC.

top

URL alternative

https://target_domain/db/main?a=API_GetAppDTMInfo&dbid=target_dbid

where target_domain is the domain against which you are invoking this call, for example, intuit.quickbase.com. Read about this notation.

top

Sample response (using app dbid)

<?xml version="1.0" ?>
<qdbapi>
<action>API_GetAppDTMInfo</action>
<errcode>0</errcode>
<errtext>No error</errtext>
<RequestTime>1227660044062</RequestTime>
<RequestNextAllowedTime>1227660049062</RequestNextAllowedTime>
<app id="bdzk2ecg5">
<lastModifiedTime>1227657049750</lastModifiedTime>
<lastRecModTime>1227647748330</lastRecModTime>
</app>
<tables>
<table id="bdzk2ecg6">
<lastModifiedTime>1227647748440</lastModifiedTime>
<lastRecModTime>1227647748330</lastRecModTime>
</table>
<table id="bdzma8u8r">
<lastModifiedTime>1227657006030</lastModifiedTime>
<lastRecModTime>1227657006030</lastRecModTime>
</table>
<table id="bdzma97vj">
<lastModifiedTime>1227657049720</lastModifiedTime>
<lastRecModTime>1227657049720</lastRecModTime>
</table>
</tables>
</qdbapi>

top

Sample response (using table dbid)

<?xml version="1.0" ?>
<qdbapi>
<action>API_GetAppDTMInfo</action>
<errcode>0</errcode>
<errtext>No error</errtext>
<RequestTime>1227726628024</RequestTime>
<RequestNextAllowedTime>1227726633024</RequestNextAllowedTime>
<tables>
<table id="bdzpdhxua">
<lastModifiedTime>1227726509647</lastModifiedTime>
<lastRecModTime>1227726509647</lastRecModTime>
</table>
</tables>
</qdbapi>

top   

© 1999-2014 Intuit Inc. All rights reserved. Legal Notices.