JavaScript Tools for Quickbase

These are some basic tools for the Quickbase API.

Simply include the following in your .html file:

<script src="https://cdn.jsdelivr.net/gh/johnhewi/QB_Lite@a10899a49b07a4769ee74e4dd4651fb844774f6e/QB_Lite.js"></script>

Use a user token (str) and realm url (str) to instantiate a client object:

const client_object = new client(user_token, realm_url) 

You can use two additional optional parameters. numberOfAttempts(int) and timout(int). NumberOfAttempts is how many additional attempts will be made if a post results in a 429 error, "Too Many Requests." It will stop attempting once a post is successful. Timeout is how many milliseconds the application will wait before attempting again. These are both set to 0 by default.

const client_object = new client(user_token, realm_url, numberOfAttempts, timeout)

const client_object = new client("dyym73_iiu7_9_2ywlpz9s425us1l09qf2ubjpee", "myrealm.quickbase.com", 3, 1000)

This would create a client object with the given user token and realm, would make 3 additional attempts if it gets a 429 error (and stop attempting once it gets a 200 success) and wait 1000 milliseconds (1 second) between attempts.

This is the method for querying Quickbase. It takes as parameters the table ID(str), the query in Quickbase Query Language (str), and an array of the field id's (int) that you want in the returned record objects. It returns the found record objects.

client_object.query(table_id, query, array) 

let returned_records = client_object.query("bfa42nsiwn", "{3.GT.0}", [3,5,7])

This would return all the records in the table with table ID "bfa42nsiwn" where field ID 3 is greater than 0. (this would return all the records in the table.) The fields returned would be 3, 5, 7. The records will be returned as an array of dictionary objects. The keys are the field ID numbers and the values are themselves a dictionary, with a key named "value" to access the returned value:

{
  3: { value: "returned value here" },
  5: { value: "returned value here" },
  7: { value: "returned value here" },
}
    

This allows you to search for records matching any of an array of values. It takes as parameters the table ID (str), the field ID number (int) of the field you want to search, an array of values you are searching for (number or str), and an array of the field ID numbers you want returned for each record(int) It returns an array of record objects.

client_object.multiquery(table_id, searchfield, queryArray, selectArray)

let returned_records = client_object.multiquery("bfa42nsiwn", 6, ["Tacoma", "4Runner", "Corolla"], [3, 6, 9])

This would return all records from table with table ID "bfa42nsiwn" where field ID 6 matches any of the following: "Tacoma", "4Runner" or "Corolla". The fields returned in each record would be 3, 6 and 9.

This method allows you to either create or edit records. If the key field is given and exists in the table, that record will be updated. If key field is not given, a record will be created. If the key field is given but does not exist in the table, a record will be created with the given key field value. (unless the key field is the default Record ID, field #3, in which case Quickbase will return an error)

It takes as parameters the table ID (str) and an array of record objects you wish to create or edit. It returns a dictionary of arrays of the RID's of the records created, unchanged and edited.

client_object.post(table_id, record_array)

let records_to_create = 
[
  {
    6: { value: "Tacoma" },
    7: { value: 30000 }
  },
  {
    6: { value: "Corolla" },
    7: { value: 20000 }
  }  
]

let records_created = client_object.post("bfa42nsiwn", records_to_create)

This creates the records in the array records_to_create in table "bfa42nsiwn". In this example, the two records created have RID's 41 and 42, and records_created would equal the returned dictionary:

{
  createdRecordIds: [41, 42]
  unchangedRecordIds: []
  updatedRecordIds: []
}

This method allows you to delete records that satisfy a query in Quickbase Query Language. It takes as parameters the table ID (str) the query (str) and returns the total number of records deleted.(int)

client_object.delete(table_id, query)

let number_of_records_deleted = client_object.delete("bfa42nsiwn", "{6.EX.'Wrangler'}")

This would delete all records in table "bfa42nsiwn" where field ID 6 matches "Corolla". If only one record was deleted, it would return a value of 1.

This method allows you to delete records matching any of an array of values. It takes as parameters the table ID (str), the field ID number (int) of the field you want to search and an array of values you are searching for (number or str). It returns the total number of records deleted.(int)

client_object.multidelete(table_id, field_id, value_array)

let number_of_records_deleted = client_object.multidelete("bfa42nsiwn", 6, ["Expedition", "Pinto", "Yukon"])

This would delete any records in table "bfa42nsiwn" where field ID 6 matches any of the following: "Expedition", "Pinto" or "Yukon". If 3 records were deleted, it would return a value of 3.

This method allows you to get the options for a multiple choice field. It takes as parameters the table ID (str) and a field ID number (int). It returns an array of the options for the multiple choice field.

client_object.getchoices(table_id, field_id)

let choices = client_object.getchoices("bfa42nsiwn", 8)

This would return an array of the options for field ID 8 in table "bfa42nsiwn". If the multiple choice options in that field were "Toyota," "Lexus" and "Land Cruiser," it would return the following array:

choices = [
  "Toyota",
  "Lexus",
  "Land Cruiser"
]

This function allows you to build a compound query string for use in the Quickbase Query Language. It takes as parameters the field you wish to search(int), a Quickbase Query Language argument such as "EX" or "GT"(str), a logical operator like "AND" or "OR"(str) and an array of values(str or num) to include in the query. If the value in the array is a string, the function will automatically put single quotes around it. It returns a query string.

queryStringBuilder(searchfield, argument, operator, valueArray)

let query = client_object.queryStringBuilder(8, "XEX", "AND", ["Ford", "Ram", "GMC"])

This would return the query string:

{8.XEX'Ford'}AND{8.XEX'Ram'}AND{8.XEX'GMC'}