API_GetRecordInfo

Overview

Use API_GetRecordInfo to get the values and types of all the fields in a record. You invoke this call on a table-level dbid.

top

Request parameters

Parameter Value Required?

rid or key

The record ID of the record to be edited. You can obtain the record ID of any record in a query. (See API_DoQuery.)

If you use a key field OTHER than the record id (rid), you should use that field rather than rid when you call API_GetRecordInfo.

yes

ticket

A valid authentication ticket.

The authentication ticket is returned via an 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

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 Quick Base but it will be returned in the response.

no

top

Response values

Element Name Value

action

The originating request, for example, API_GetRecordInfo.

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.

rid

The record ID.

num_fields

The total number of fields in this record, including built-in fields.

update_id

The update ID, to be used in editing the field.

<field> aggregates

Several (num_field many) field aggregates will be returned. All record fields will be returned, even the standard built-in fields. The aggregate is structured as follows:

<field>
   <fid>9</fid>
   <name>URL</name>
   <type>URL</type>
   <value>www.example.com</value>
</field>

Some fields may have additional elements.

top

Sample XML Request

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

<qdbapi>
   <udata>mydata</udata>
   <ticket>auth_ticket</ticket>
   <apptoken>app_token</apptoken>
   <rid>2</rid>
</qdbapi>

top

URL alternative

https://target_domain/db/target_dbid?a=API_GetRecordInfo&rid=18
&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.

top

Sample response

<?xml version="1.0" ?>
<qdbapi>
<action>api_getrecordinfo</action>
<errcode>0</errcode>
<errtext>No error</errtext>
<udata>mydatamin</udata>
<rid>20</rid>
<num_fields>28</num_fields>
<update_id>1205780029699</update_id>
<field>
<fid>6</fid>
<name>Start Date</name>
<type>Date</type>
<value>1437609600000</value>
<printable>23-07-15</printable>
</field>
<field>
<fid>7</fid>
<name>File</name>
<type>File Attachment</type>
<value>BatchID.html</value>
</field>
.
.
.
</qbdapi>

 

Go back    |     |  

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