API

Syndicate content
How to Understand the XML Samples

How to Understand the XML Samples

This document has the XML samples in this kind of format:

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

October 13th, 2009 - 2:10 PM
Format Parameter: Structured vs. Unstructured

One useful feature youll want to use in the API_DoQuery call is the <fmt>structured</fmt> parameter. By default the query returns are not structured. Basically, youll just get the table name, any DBVars, and the record data with the fields you specified, all with the field names, like this:

October 13th, 2009 - 2:10 PM
Sample Queries

Sample Queries

To query a particular field:

{'7'.XCT.'Fred'}

To query any field:

{'0'.OAF.'3/31/01'}

October 13th, 2009 - 2:10 PM
Uploading and Downloading Files

Uploading and Downloading Files

QuickBase applications can support file attachment storage and file attachment access through the APIs file upload and download feature. Files are attached through a record field that has the type File.

October 13th, 2009 - 2:10 PM
Uploading Files

Uploading Files

Files are uploaded as file attachments to a record during an API_AddRecord or API_EditRecord call. The file field you use for file attachments must be of type File.

October 13th, 2009 - 2:10 PM
Using Key Fields

By default, each table has the built-in field called RecordID (rid), that provides the unique key for that record within the table. If you want to use another field as the key field, you may do so, provided that the field type supports the Unique property, which must be checked to insure that there are no duplicates.

October 13th, 2009 - 2:10 PM
The Components of a Query

A query typically includes the following parameters:

October 13th, 2009 - 2:10 PM
How to Supply the Query Parameter

The query parameter is the main parameter in a query because it determines which records will come back. In contrast, the other parameters affect the look of the query results or further narrow the query results in some way.

There are two ways to provide the query string:

October 13th, 2009 - 2:10 PM
Constructing the Query String

When you construct a query you must build at least one query string. A query string is composed of a field ID (fid), comparison operator, and the value to be compared against (see the table below for a list of available operators). Each of these components of the query string are separated by a period, and the whole query string enclosed in curly braces, like this:

October 13th, 2009 - 2:10 PM
Handling Special Characters for a Query Field Value

Handling Special Characters for a Query Field Value

What happens if you are querying for a value that has double quotes, for example, Joe B. Briggs? You need to double the quotes on each side, like this:

Joe B. Briggs

October 13th, 2009 - 2:10 PM

© 1997-2014 Intuit Inc. All Rights Reserved.

Online Database VeriSign Secured Web Based Software TRUSTe Certification Online Database SSAE Audit