Don't forget to check out our JSON RESTful APIs, they can help you utilize and extend Quickbase with ease.
Overview
Quickbase allows you to import data from one or more of your application tables into another application table. You can import tables from within your application, or from another application. (For complete information on this feature, see the Quickbase online help.)
If you'll need to execute the same import multiple times, you can save a specific import and execute it any time you need to run it. To run a saved import, invoke API_RunImport on a table dbid whose ID you specify in this call. Note that you can’t use API_GetSchema to get the saved import's ID because API_GetSchema doesn’t return the saved import.
To access the saved import ID:
-
Open the application into which you want to import data.
-
On the app Home page, click Import/Export on the Page bar.
-
Select the Import into a table from another table radio button.
-
Click Import from Another Table.
-
Click the name of the saved import you want to use. In the URL shown in the browser you will see this parameter: &id=X. X is the ID you need to supply to this call.
Request parameters
Parameter | Value | Required? |
---|---|---|
id |
The ID of the saved import that you want to execute. |
yes |
ticket |
A valid authentication ticket. The authentication ticket is returned via the API_Authenticate call. |
yes, one of:
|
usertoken |
The user token is an alternative means of authentication, used for API access. User tokens cannot be used to access the Quickbase UI. |
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 |
Echoes the originating request, for example, API_RunImport. |
errcode |
If successful, this will be 0. If there is a failure, there will be a code returned here. See Appendix A for a list of codes. |
errtext |
If successful, this will be “No error”. If there is a failure this contains more detail on the nature of the failure. |
import_status |
Describes the result of the import you just executed, for example “3 new records were created”. |
udata |
Optional. Contains any udata value supplied in the request. |
Sample XML Request
POST https://target_domain/db/target_dbid
HTTP/1.0
Content-Type: application/xml
Content-Length:
QUICKBASE-ACTION: API_RunImport
<qdbapi>
<ticket>auth_ticket</ticket>
<apptoken>app_token</apptoken>
<id>10</id>
</qdbapi>
URL alternative
https://target_domain/db/target_dbid?a=API_RunImport&id=10
&apptoken=app_token&ticket=auth_ticket
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_RunImport</action>
<errcode>0</errcode>
<errtext>No error</errtext>
<import_status>3 new records were created.</import_status>
</qdbapi>