Understanding the API call reference

The Quick Base API can be invoked in either of two ways.

Note that there are many samples throughout this guide for both XML and URL requests. The parts of these sample calls that reference specific information, such as authentication ticket, application token, user token, app or table dbid, and customer domain are represented by italicized sample text, as shown below:

For most API calls, Quick Base returns a response in XML format. For certain API calls that are embedded in a web page or Word document, Quick Base returns HTML responses.

Understanding the XML Samples

Each sample can be divided into two sections: the POST request method and the actual API call.

POST request method

An example of the POST request method appears below.

POST https://target_domain/db/target_dbid
Content-Type: application/xml
Content-Length:
QUICKBASE-ACTION:API_AddField

The first three lines shown above are standard HTTP headers for the POST request method. The first line specifies that the secure HTTPS protocol should be used and contains the URL for the POST. The URL includes the target_domain, or the domain against which you are invoking the call (for example, team.quickbase.com). The URL also includes the target_ dbid, which identifies the app or table the call should address.

The last line is a custom Quick Base header containing the API call.

API call

The second part of each sample illustrates the syntax for the API call. The elements between the <qdbapi> tags are the parameters; these are documented for each API call.

<qdbapi>
   <label>label</label>
   <type>type</type>
   <mode>mode</mode> <!-- optional unless lookup or formula-->
   <ticket>auth_ticket</ticket>
   <apptoken>app_token</apptoken>
   <udata>whatever</udata> <!--optional pass-thru data -->
</qdbapi>

Order of parameters in API calls (XML or URL)

Quick Base accepts API call parameters in any order,  whether the call is made via XML or a URL.

Using key fields

By default, each table has the built-in Record ID# (rid) field, which provides the unique key for that record within the table. You can use another field as the key field if you'd like,  as long as the new field type supports the Unique property.

If you use a field other than the Record ID# as the key field, you may be able to replace the &rid parameter in many of the API calls with the &key parameter. The following API calls support this substitution:

 

Go back    |     |  

© 1999-2017 QuickBase, Inc. All rights reserved. Legal Notices.