API_GetDBPage

Don't forget to come by and check out our new RESTful JSON APIs, they can help you utilize and extend Quickbase with ease.

 

Overview

Use API_GetDBPage to retrieve a stored page in Quickbase. Quickbase allows you to store various types of pages, ranging from user-guide pages for your application to Exact Forms, used to automate insertion of data into Word documents using a special Word template from Quickbase. (See the Quickbase online help for more information about DB pages.)

top

Request parameters

ParameterValueRequired?

pageID

The ID of the page. You can also use the pagename.

yes

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

no

top

Response values

The requested page is returned in HTML.

top

XML Request

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

<qdbapi>
   <udata>mydata</udata>
   <ticket>auth_ticket</ticket>
   <apptoken>app_token</apptoken>
   <pageID>3</pageID>
</qdbapi>

top

URL alternative

https://target_domain/db/target_dbid?a=API_GetDBPage&pageid=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.