API

Syndicate content
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
Downloading Files

Downloading Files

There are two ways to download a file.

The first and easiest way to download an attached file can be used if you know the database ID, the record ID, the Field ID of the file field you are attaching to, and the version ID.

October 13th, 2009 - 2:10 PM
HTTP API Language Reference

HTTP API Language Reference

This chapter provides detailed descriptions of each API call in the HTTP API.

October 13th, 2009 - 2:10 PM
Order of Parameters in API Calls (XML or URL)

Order of Parameters in API Calls (XML or URL)

QuickBase accepts API call parameters in any order whether the call comes in as an XML POST or as a URL GET.

October 13th, 2009 - 2:10 PM
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
Column List (clist) Parameter

The clist specifies which columns will be included in each returned record and how they are ordered in the returned record aggregate. Heres what a clist looks like:

<clist>4.7.9.11</clist>

or in URL-ese:

October 13th, 2009 - 2:10 PM
How to Return ALL of the columns

Specify the value a in the clist param to get all the columns returned.

October 13th, 2009 - 2:10 PM
Sort List (slist) Parameter

Sort List (slist) Parameter

The slist determines the order in which the returned records are displayed. Heres what an slist looks like:

<slist>7</slist>

October 13th, 2009 - 2:10 PM
Options Parameter

You use the options parameter to further control the return of records. You can use any or all of the options, separating the options with a period. Here are the available options:

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