API_FindDBByName

Overview

Use API_FindDBByName to find the application-level dbid of an application whose name you know. When you use this call, Quick Base searches only those applications to which you have access. Because you can have multiple applications with the same name, you should be aware that more than one application dbid can be returned.

If a Quick Base application consists of a single table, this call returns the child dbid of that table (NOT the application dbid). If you want to find the application-level dbid in this case, set the parentsOnly parameter to 1 for the request.

top

Request parameters

Parameter Value Required?

dbname

The name of the application you want to find

yes

ParentsOnly

Ensures an app ID is returned, regardless of whether the application contains a single table or not.

Note that, in applications that contain more than one table, Quick Base always returns the app dbid, regardless of whether you use this parameter or not. However, if an application contains only a single table, Quick Base returns the table DBID if you do not specify this parameter.

If you are not sure whether your app contains more than one table, or if you are sure it contains only a single table, set this parameter to 1 to make sure an app dbid is returned.

no

ticket

A valid authentication ticket.

The authentication ticket is returned via the API_Authenticate call.

yes

udata

A string value that you want returned. It will not be handled by Quick Base but it will be returned in the response.

no

top

Response values

Element Name Value

action

The originating request, for example, API_FindDBByName

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.

udata

Optional. Contains any udata value supplied in the request.

dbid

Ensures an app ID is returned, regardless of whether the application contains a single table or not.

Note that, in applications that contain more than one table, Quick Base always returns the app dbid, regardless of whether you using this parameter or not. However, if an application contains only a single table, Quick Base returns the table DBID if you do not specify this parameter.

If you are not sure whether your app contains more than one table, or if you are sure it contains only a single table, set this parameter to 1 to make sure an app dbid is returned.

dbname

The application name, echoed in the response.

top

Sample XML Request

POST https://target_domain/db/main HTTP/1.0
Content-Type: application/xml
Content-Length:
QUICKBASE-ACTION: API_FindDBByName

<qdbapi>
   <ticket>auth_ticket</ticket>
   <dbname>TestTable</dbname>
</qdbapi>

top

URL alternative

https://target_domain/db/main?a=API_FindDBByName&dbname=TestApp
&ticket=auth_ticket

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

top

Sample response

<?xml version="1.0" ?>
<qdbapi>
   <action>API_FindDBByName</action>
   <errcode>0</errcode>
   <errtext>No error</errtext>
   <dbid>bdcagynhs</dbid>
</qdbapi>

 

Go back    |     |  

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