API_GetAncestorInfo

Overview

This call must be invoked on the app dbid (not on a table dbid) to get ancestor information about the current application. To use this call, you must have at least read permissions on the table.

The first generation copy of an application returns the same DBID for both oldestancestorappid and ancestorappid.  The grandchild of a template  (and subsequent generations) shows the immediate parent app as the ancestorappid and the original template as the oldestancestorappid.

top

Request parameters

Parameter Value Required?

ticket

A valid authentication ticket.

The authentication ticket is returned via the API_Authenticate call.

yes, one of:

  • ticket
  • username/password
  • user token

usertoken

The user token is an alternative means of authentication, used for API access. User tokens cannot be used to access the Quick Base UI.

yes, one of:

  • ticket
  • username/password
  • user token

apptoken

Supply a valid application token.

yes, if the application requires application tokens

top

Response values

Element Name Value

action

Echoes the originating request, for example, API_AddField.

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.

ancestorappid

dbid for the ancestor app.

oldestancestorappid

dbid for the master application from which the current application was ultimately copied. For immediate copies, the ancestorappid and the oldestancestorappid are the same.

top

Sample XML Request

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

<qdbapi>
   <ticket>auth_ticket</ticket>
   <apptoken>app_token</apptoken>
</qdbapi>

top

URL Alternative

https://target_domain/db/target_dbid?a=API_GetAncestorInfo
&ticket=auth_ticket&apptoken=app_token

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_getancestorinfo</action>
    <errcode>0</errcode>
    <errtext>No error</errtext>
    <ancestorappid>bbyhxrmsv</ancestorappid>
    <oldestancestorappid>bbyhxrmsv</oldestancestorappid>
  </qdbapi>

 

Go back    |     |  

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