Where is there a list of the URL functions?

  • 0
  • 1
  • Question
  • Updated 3 months ago
  • Answered
I have searched the API Guide, online help, formula reference and the Internet and do not see what I am hoping to find. I am learning to write URL formulas and notice there are many functions in the URL (not sure what these are called). For instance I see ?a=, dr, rdr=, ?act= etc... Is there an index of these "functions" if that is the correct term and their meaning? Are there others I have not seen?     
Photo of Jim Harrison

Jim Harrison

  • 1,770 Points 1k badge 2x thumb

Posted 10 months ago

  • 0
  • 1
Photo of QuickBaseCoach App Dev./Training

QuickBaseCoach App Dev./Training, Champion

  • 52,786 Points 50k badge 2x thumb
I'm pretty sure that there is not any centralized official source.  I think that we just individually collect these as we see them in URLs where the native interface uses them as we navigate, and then mimic them in our formula URLs.  I agree that it would be nice to see Quick Base put up a Quick Base Table of them.
Photo of Ⲇanom the ultimate (Dan Diebolt)

Ⲇanom the ultimate (Dan Diebolt), Champion

  • 27,694 Points 20k badge 2x thumb
QuickBase has two sets of URL "actions". Those actions like "a=dr" (display record), "a=er" (edit record) and "a=nwr" (new record) are "native" actions meaning that they appear in the Address Bar and represent the primary actions of the normal GUI interface. I don't know of any public list of these actions but they are so visible that everyone uses them in crafting formula URLs and hyperlinks.

The second set of actions are associated with the HTTP API and they typically are referenced as "act=API_AddRecord" or "act=API_EditRecord". The documentation for the HTTP API is here:

https://help.quickbase.com/api-guide/index.html

For the most part the HTTP API methods (with only a couple of exceptions) are not displayed in the Address Bar as they don't represent human readable content (they display XML in most cases). This set of URLs are used for scripting automation of some sort either from an external server or via script in your browser. 

One difference between the two sets of "actions" is that the HTTP API urls are documented whereas the native actions are not "documented" (even though they are 100% visible and used by every user).

They two types of "actions" come together sometimes in complicated formula URLs that string together several actions and avoid ever displaying XML by including the rdr parameter which immediately redirects away from an XML response to a human readable page.

Mark Shnier is probably the best person to describe the chaining of these two types of URL actions together as he sort of standardized the formula URL into this "canonical form":

var text URLONE = ...;
var text URLTWO = ...;
var text URLTHREE = ...;
$URLONE
& "&rdr=" & URLEncode($URLTWO)
& URLEncode("&rdr=" & URLEncode($URLTHREE))

There is much more to be said so I would continue the discussion if you have additional questions or if their are other perspectives.
Photo of Jim Harrison

Jim Harrison

  • 1,770 Points 1k badge 2x thumb
I read this twice because it was good.This information should be on page two of the manual.

I have been searching through the API and don't see any reference to 'act' or any others mentioned, I will keep looking unless you can point me to the page you're referencing. If it's spread across the API reference like peanut butter then that is not the list I am looking for. 

The one thing I would like is to have a list of both the HTTP and "Native" actions. So I will start one here. 

List of Native QB Actions: 
dr - display record
rdr - redirect
er - edit record
nwr - new record
- delete record

Question:
Is ?a the only syntax that comes after the standard URLRoot() & "db/" & Dbid() & "? 
Photo of QuickBaseCoach App Dev./Training

QuickBaseCoach App Dev./Training, Champion

  • 52,766 Points 50k badge 2x thumb
There is an app that I put into the Exchange called URL Formulas for Dummies.  There is some help text there too.

also when calling an API it seems you can can use 

act=API_AddRecord ....
or
a=API_AddRecord ...

I always use the full "act" out of habit.
Photo of Jim Harrison

Jim Harrison

  • 1,770 Points 1k badge 2x thumb
I know, you're the reason for my questions. :) 
Photo of Michael Ybarra

Michael Ybarra

  • 62 Points
I want to thank you all for this thread. Dan's explanation brought a lot of things together for me.