Module quickbase
ballerinax/quickbase Ballerina library
1.3.1
Overview
This is a generated connector from Quickbase API v1 OpenAPI Specification.
The Quickbase JSON RESTful API provides secure access to Quickbase apps and allow users to manage access using Quickbase roles. Users can automate the app lifecycle using the Quickbase API.
Prerequisites
- Create Quickbase account.
- Choose a subscription that matches with your requirements
- Obtain user token and provide the token as the value of
Authorizationheader within an API call.- Follow this guide for more details on obtaining user tokens.
Quickstart
To use the Quickbase connector in your Ballerina application, update the .bal file as follows:
Step 1: Import connector
import ballerinax/quickbase;
Step 2: Create a new connector instance
Initialize the connector instance.
quickbase:Client baseClient = check new Client();
Step 3: Invoke connector operation
- Obtain current weather data by city name.
configurable string & readonly userToken = ?; string appId = "bpqe82s1"; string qbRealmHost = "demo.quickbase.com"; json appData = check baseClient->getApp(appId, qbRealmHost, userToken);
- Use
bal runcommand to compile and run the Ballerina program.
Clients
quickbase: Client
Isolated
This is a generated connector from Quickbase API v1 OpenAPI Specification. The Quickbase JSON RESTful API provides secure access to Quickbase apps and allow users to manage access using Quickbase roles. Users can automate the app lifecycle using the Quickbase API.
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
To use the Quickbase RESTful API, you need to authenticate with either a permanent user token or a temporary one if you are writing a utility client-side. Please refer the guide here for more details.
init (ClientConfiguration clientConfig, string serviceUrl)- clientConfig ClientConfiguration {} - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.quickbase.com/v1/" - URL of the target service
createApp
Isolated FunctionRemote Function
function createApp(string qbRealmHostname, string authorization, AppsBody payload, string? userAgent) returns json|errorCreate an app
Parameters
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- payload AppsBody - App details
- userAgent string? (default ()) - Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting.
Return Type
- json|error - Success
getApp
Isolated FunctionRemote Function
function getApp(string appId, string qbRealmHostname, string authorization, string? userAgent) returns json|errorGet an app
Parameters
- appId string - The unique identifier of an app
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- userAgent string? (default ()) - Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting.
Return Type
- json|error - Success
updateApp
Isolated FunctionRemote Function
function updateApp(string appId, string qbRealmHostname, string authorization, AppsAppidBody payload, string? userAgent) returns json|errorUpdate an app
Parameters
- appId string - The unique identifier of an app
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- payload AppsAppidBody - App details
- userAgent string? (default ()) - Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting.
Return Type
- json|error - Success
getAppEvents
Isolated FunctionRemote Function
function getAppEvents(string appId, string qbRealmHostname, string authorization, string? userAgent) returns InlineResponse200[]|errorGet app events
Parameters
- appId string - The unique identifier of an app
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- userAgent string? (default ()) - Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting.
Return Type
- InlineResponse200[]|error - Success
copyApp
Isolated FunctionRemote Function
function copyApp(string appId, string qbRealmHostname, string authorization, AppidCopyBody payload, string? userAgent) returns json|errorCopy an app
Parameters
- appId string - The unique identifier of an app
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- payload AppidCopyBody - App details
- userAgent string? (default ()) - Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting.
Return Type
- json|error - Success
getAppTables
Isolated FunctionRemote Function
function getAppTables(string appId, string qbRealmHostname, string authorization, string? userAgent) returns InlineResponse2001[]|errorGet tables for an app
Parameters
- appId string - The unique identifier of an app
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- userAgent string? (default ()) - This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.
Return Type
- InlineResponse2001[]|error - Success
createTable
Isolated FunctionRemote Function
function createTable(string appId, string qbRealmHostname, string authorization, TablesBody payload, string? userAgent) returns json|errorCreate a table
Parameters
- appId string - The unique identifier of an app
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- payload TablesBody - Table details
- userAgent string? (default ()) - This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.
Return Type
- json|error - Success
getTable
Isolated FunctionRemote Function
function getTable(string tableId, string appId, string qbRealmHostname, string authorization, string? userAgent) returns json|errorGet a table
Parameters
- tableId string - The unique identifier (dbid) of the table.
- appId string - The unique identifier of an app
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- userAgent string? (default ()) - This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.
Return Type
- json|error - Success
updateTable
Isolated FunctionRemote Function
function updateTable(string tableId, string appId, string qbRealmHostname, string authorization, TablesTableidBody payload, string? userAgent) returns json|errorUpdate a table
Parameters
- tableId string - The unique identifier (dbid) of the table.
- appId string - The unique identifier of an app
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- payload TablesTableidBody - Table details
- userAgent string? (default ()) - This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.
Return Type
- json|error - Success
deleteTable
Isolated FunctionRemote Function
function deleteTable(string tableId, string appId, string qbRealmHostname, string authorization, string? userAgent) returns json|errorDelete a table
Parameters
- tableId string - The unique identifier (dbid) of the table.
- appId string - The unique identifier of an app
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- userAgent string? (default ()) - This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.
Return Type
- json|error - Success
getRelationships
Isolated FunctionRemote Function
function getRelationships(string tableId, string qbRealmHostname, string authorization, int? skip, string? userAgent) returns json|errorGet all relationships
Parameters
- tableId string - The unique identifier (dbid) of the table.
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- skip int? (default ()) - The number of relationships to skip.
- userAgent string? (default ()) - This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.
Return Type
- json|error - Success
createRelationship
Isolated FunctionRemote Function
function createRelationship(string tableId, string qbRealmHostname, string authorization, TableidRelationshipBody payload, string? userAgent) returns json|errorCreate a relationship
Parameters
- tableId string - The unique identifier (dbid) of the table. This will be the child table.
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- payload TableidRelationshipBody - Relationship details
- userAgent string? (default ()) - This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.
Return Type
- json|error - Success
updateRelationship
Isolated FunctionRemote Function
function updateRelationship(string tableId, decimal relationshipId, string qbRealmHostname, string authorization, RelationshipRelationshipidBody payload, string? userAgent) returns json|errorUpdate a relationship
Parameters
- tableId string - The unique identifier (dbid) of the table. This will be the child table.
- relationshipId decimal - The relationship id. This is the field id of the reference field on the child table.
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- payload RelationshipRelationshipidBody - Relationship details
- userAgent string? (default ()) - This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.
Return Type
- json|error - Success
deleteRelationship
Isolated FunctionRemote Function
function deleteRelationship(string tableId, decimal relationshipId, string qbRealmHostname, string authorization, string? userAgent) returns json|errorDelete a relationship
Parameters
- tableId string - The unique identifier (dbid) of the table. This will be the child table.
- relationshipId decimal - The relationship id. This is the field id of the reference field on the child table.
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- userAgent string? (default ()) - This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.
Return Type
- json|error - Success
getTableReports
Isolated FunctionRemote Function
function getTableReports(string tableId, string qbRealmHostname, string authorization, string? userAgent) returns InlineResponse2002[]|errorGet reports for a table
Parameters
- tableId string - The unique identifier of the table.
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- userAgent string? (default ()) - This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.
Return Type
- InlineResponse2002[]|error - Success
getReport
Isolated FunctionRemote Function
function getReport(string reportId, string tableId, string qbRealmHostname, string authorization, string? userAgent) returns json|errorGet a report
Parameters
- reportId string - The identifier of the report, unique to the table.
- tableId string - The unique identifier of table.
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- userAgent string? (default ()) - This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.
Return Type
- json|error - Success
runReport
Isolated FunctionRemote Function
function runReport(string reportId, string tableId, string qbRealmHostname, string authorization, json payload, int? skip, int? top, string? userAgent) returns json|errorRun a report
Parameters
- reportId string - The identifier of the report, unique to the table.
- tableId string - The identifier of the table for the report.
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- payload json - Report details
- skip int? (default ()) - The number of records to skip. You can set this value when paginating through a set of results.
- top int? (default ()) - The maximum number of records to return. You can override the default Quickbase pagination to get more or fewer results. If your requested value here exceeds the dynamic maximums, we will return a subset of results and the rest can be gathered in subsequent API calls.
- userAgent string? (default ()) - This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.
Return Type
- json|error - Success
getFields
Isolated FunctionRemote Function
function getFields(string tableId, string qbRealmHostname, string authorization, boolean includeFieldPerms, string? userAgent) returns InlineResponse2003[]|errorGet fields for a table
Parameters
- tableId string - The unique identifier (dbid) of the table.
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- includeFieldPerms boolean (default false) - Set to 'true' if you'd like to get back the custom permissions for the field(s).
- userAgent string? (default ()) - This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.
Return Type
- InlineResponse2003[]|error - Success
createField
Isolated FunctionRemote Function
function createField(string tableId, string qbRealmHostname, string authorization, FieldsBody payload, string? userAgent) returns json|errorCreate a field
Parameters
- tableId string - The unique identifier of the table.
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- payload FieldsBody - Field details
- userAgent string? (default ()) - This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.
Return Type
- json|error - Success
getField
Isolated FunctionRemote Function
function getField(int fieldId, string tableId, string qbRealmHostname, string authorization, boolean includeFieldPerms, string? userAgent) returns json|errorGet field
Parameters
- fieldId int - The unique identifier (fid) of the field.
- tableId string - The unique identifier (dbid) of the table.
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- includeFieldPerms boolean (default false) - Set to 'true' if you'd like to get back the custom permissions for the field(s).
- userAgent string? (default ()) - This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.
Return Type
- json|error - Success
updateField
Isolated FunctionRemote Function
function updateField(int fieldId, string tableId, string qbRealmHostname, string authorization, FieldsFieldidBody payload, string? userAgent) returns json|errorUpdate a field
Parameters
- fieldId int - The unique identifier (fid) of the field.
- tableId string - The unique identifier of the table.
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- payload FieldsFieldidBody - Field details
- userAgent string? (default ()) - This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.
Return Type
- json|error - Success
getFieldsUsage
Isolated FunctionRemote Function
function getFieldsUsage(string tableId, string qbRealmHostname, string authorization, int? skip, int? top, string? userAgent) returns InlineResponse2004[]|errorGet usage for all fields
Parameters
- tableId string - The unique identifier (dbid) of the table.
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- skip int? (default ()) - The number of fields to skip from the list.
- top int? (default ()) - The maximum number of fields to return.
- userAgent string? (default ()) - This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.
Return Type
- InlineResponse2004[]|error - Success
getFieldUsage
Isolated FunctionRemote Function
function getFieldUsage(int fieldId, string tableId, string qbRealmHostname, string authorization, string? userAgent) returns InlineResponse2004[]|errorGet usage for a field
Parameters
- fieldId int - The unique identifier (fid) of the field.
- tableId string - The unique identifier (dbid) of the table.
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- userAgent string? (default ()) - This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.
Return Type
- InlineResponse2004[]|error - Success
runFormula
Isolated FunctionRemote Function
function runFormula(string qbRealmHostname, string authorization, FormulaRunBody payload, string? userAgent) returns json|errorRun a formula
Parameters
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- payload FormulaRunBody - Formula details
- userAgent string? (default ()) - This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.
Return Type
- json|error - Success
upsert
Isolated FunctionRemote Function
function upsert(string qbRealmHostname, string authorization, RecordsBody payload, string? userAgent) returns json|errorInsert/Update record(s)
Parameters
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- payload RecordsBody - Record details
- userAgent string? (default ()) - This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.
Return Type
- json|error - Success
runQuery
Isolated FunctionRemote Function
function runQuery(string qbRealmHostname, string authorization, RecordsQueryBody payload, string? userAgent) returns json|errorQuery for data
Parameters
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- payload RecordsQueryBody - Query details
- userAgent string? (default ()) - This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.
Return Type
- json|error - Success
getTempTokenDBID
Isolated FunctionRemote Function
function getTempTokenDBID(string dbid, string qbRealmHostname, string? userAgent, string? qbAppToken) returns json|errorGet a temporary token for a dbid
Parameters
- dbid string - The unique identifier of an app or table.
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- userAgent string? (default ()) - This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.
- qbAppToken string? (default ()) - Your Quickbase app token
Return Type
- json|error - This token is used in the authorization header value (similar to the QB-USER-TOKEN), except it uses the QB-TEMP-TOKEN prefix header['Authorization'] = 'QB-TEMP-TOKEN {token}'
cloneUserToken
Isolated FunctionRemote Function
function cloneUserToken(string qbRealmHostname, string authorization, UsertokenCloneBody payload, string? userAgent) returns json|errorClone a user token
Parameters
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- payload UsertokenCloneBody - Token details
- userAgent string? (default ()) - Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting.
Return Type
- json|error - Success
deactivateUserToken
Isolated FunctionRemote Function
function deactivateUserToken(string qbRealmHostname, string authorization, string? userAgent) returns json|errorDeactivate a user token
Parameters
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- userAgent string? (default ()) - Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting.
Return Type
- json|error - Success
deleteUserToken
Isolated FunctionRemote Function
function deleteUserToken(string qbRealmHostname, string authorization, string? userAgent) returns json|errorDelete a user token
Parameters
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- userAgent string? (default ()) - Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting.
Return Type
- json|error - Success
downloadFile
Isolated FunctionRemote Function
function downloadFile(string tableId, int recordId, int fieldId, int versionNumber, string qbRealmHostname, string authorization, string? userAgent) returns json|errorDownload file
Parameters
- tableId string - The unique identifier of the table.
- recordId int - The unique identifier of the record.
- fieldId int - The unique identifier of the field.
- versionNumber int - The file attachment version number.
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- userAgent string? (default ()) - Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting.
Return Type
- json|error - Success
deleteFile
Isolated FunctionRemote Function
function deleteFile(string tableId, int recordId, int fieldId, int versionNumber, string qbRealmHostname, string authorization, string? userAgent) returns json|errorDelete file
Parameters
- tableId string - The unique identifier of the table.
- recordId int - The unique identifier of the record.
- fieldId int - The unique identifier of the field.
- versionNumber int - The file attachment version number.
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- userAgent string? (default ()) - Information is entered by the person or utility invoking the API. Choose between the default in your toolkit or custom create it. Being as descriptive as possible will help in identification and troubleshooting.
Return Type
- json|error - Successfully Deleted the File Attachment
denyUsers
Isolated FunctionRemote Function
function denyUsers(string qbRealmHostname, string authorization, string[] payload, string? userAgent) returns json|errorDeny users
Parameters
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- payload string[] - A list of user IDs that need to be denied
- userAgent string? (default ()) - This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.
Return Type
- json|error - Success
denyUsersFromGroups
Isolated FunctionRemote Function
function denyUsersFromGroups(boolean shouldDeleteFromGroups, string qbRealmHostname, string authorization, string[] payload, string? userAgent) returns json|errorDeny and remove users from groups
Parameters
- shouldDeleteFromGroups boolean - Specifies if the users should also be removed from all groups.
- qbRealmHostname string - Your Quickbase domain, for example demo.quickbase.com
- authorization string - The Quickbase authentication scheme you are using to authenticate the request, as described on the authorization page.
- payload string[] - A list of user IDs that need to be denied
- userAgent string? (default ()) - This is entered by the person or utility invoking the API. You might custom create this or use the default one of your toolkit. Being descriptive here may offer more identification and troubleshooting capabilities.
Return Type
- json|error - Success
Records
quickbase: AppidCopyBody
Fields
- name string - The name of the newly copied app
- description string? - The description of the newly copied app
- properties AppsappidcopyProperties? - The configuration properties for performing the app copy
quickbase: AppsAppidBody
The example below shows all the properties that can be changed with this request. Additional properties that you can see with the corresponding GET request cannot be set through this API. See individual property descriptions below for details on how to set or change each.
Fields
- variables AppsVariables[]? - The app variables. See About Application Variables
- name string? - The name for the app.
- description string? - The description for the app.
quickbase: AppsappidcopyProperties
The configuration properties for performing the app copy
Fields
- assignUserToken boolean? - Whether to add the user token used to make this request to the new app
- excludeFiles boolean? - If keepData is true, whether to copy the file attachments as well. If keepData is false, this property is ignored
- keepData boolean? - Whether to copy the app's data along with the schema
- usersAndRoles boolean? - If true, users will be copied along with their assigned roles. If false, users and roles will be copied but roles will not be assigned
quickbase: AppsappideventsOwner
The user that owns the event.
Fields
- name string? - User full name.
- id string? - User Id.
- email string? - User email.
- userName string? - User Name as updated in user properties. Optional, appears if not the same as user email.
quickbase: AppsBody
The example below shows all the properties that can be set with this request. Additional properties that you can see, with the corresponding GET request, cannot be set through this API. See individual property descriptions below for details on how to set or change each.
Fields
- assignToken boolean? - Set to true if you would like to assign the app to the user token you used to create the application. The default is false.
- variables AppsVariables[]? - The app variables. See About Application Variables
- name string - The app name. You are allowed to create multiple apps with the same name, in the same realm, because they will have different dbid values. We urge you to be careful about doing this.
- description string? - The description for the app. If this property is left out, the app description will be blank.
quickbase: AppsVariables
Fields
- name string - The name for the variable.
- value string - The value for the variable.
quickbase: FieldsBody
The example below shows all the properties that can be changed with this request. Additional properties that you can see with the corresponding GET request cannot be set through this API.
Fields
- audited boolean? - Indicates if the field is being tracked as part of Quickbase Audit Logs. You can only set this property to "true" if the app has audit logs enabled. See Enable data change logs under Quickbase Audit Logs.
- fieldHelp string? - The configured help text shown to users within the product.
- bold boolean? - Indicates if the field is configured to display in bold in the product.
- properties FieldsProperties1? - Specific field properties.
- appearsByDefault boolean? - Indicates if the field is marked as a default in reports.
- fieldType string - The field types, click on any of the field type links for more info.
- permissions FieldsPermissions[]? - Field Permissions for different roles.
- addToForms boolean? - Whether the field you are adding should appear on forms.
- label string - The label (name) of the field.
- findEnabled boolean? - Indicates if the field is marked as searchable.
- noWrap boolean? - Indicates if the field is configured to not wrap when displayed in the product.
quickbase: FieldsFieldidBody
The example below shows all the properties that can be changed with this request. Additional properties that you can see with the corresponding GET request cannot be set through this API.
Fields
- audited boolean? - Indicates if the field is being tracked as part of Quickbase Audit Logs. You can only set this property to "true" if the app has audit logs enabled. See Enable data change logs under Quickbase Audit Logs.
- fieldHelp string? - The configured help text shown to users within the product.
- bold boolean? - Indicates if the field is configured to display in bold in the product.
- required boolean? - Indicates if the field is required (i.e. if every record must have a non-null value in this field). If you attempt to change a field from not-required to required, and the table currently contains records that have null values in that field, you will get an error indicating that there are null values of the field. In this case you need to find and update those records with null values of the field before changing the field to required.
- properties FieldsfieldidProperties? - Specific field properties.
- appearsByDefault boolean? - Indicates if the field is marked as a default in reports.
- unique boolean? - Indicates if every record in the table must contain a unique value of this field. If you attempt to change a field from not-unique to unique, and the table currently contains records with the same value of this field, you will get an error. In this case you need to find and update those records with duplicate values of the field before changing the field to unique.
- permissions FieldsPermissions[]? - Field Permissions for different roles.
- addToForms boolean? - Whether the field you are adding should appear on forms.
- label string? - The label (name) of the field.
- findEnabled boolean? - Indicates if the field is marked as searchable.
- noWrap boolean? - Indicates if the field is configured to not wrap when displayed in the product.
quickbase: FieldsfieldidProperties
Specific field properties.
Fields
- comments string? - The comments entered on the field properties by an administrator.
- doesTotal boolean? - Whether this field totals in reports within the product.
- autoSave boolean? - Whether the link field will auto save.
- defaultValueLuid int? - Default user id value.
- maxVersions int? - The maximum number of versions configured for a file attachment.
- format int? - The format to display time.
- carryChoices boolean? - Whether the field should carry its multiple choice fields when copied.
- maxLength int? - The maximum number of characters allowed for entry in Quickbase for this field.
- linkText string? - The configured text value that replaces the URL that users see within the product.
- parentFieldId int? - The id of the parent composite field, when applicable.
- displayTimezone boolean? - Indicates whether to display the timezone within the product.
- summaryTargetFieldId int? - The id of the field that is used to aggregate values from the child, when applicable. This displays 0 if the summary function doesn’t require a field selection (like count).
- allowNewChoices boolean? - Indicates if users can add new choices to a selection list.
- defaultToday boolean? - Indicates if the field value is defaulted today for new records.
- units string? - The units label.
- lookupTargetFieldId int? - The id of the field that is the target on the parent table for this lookup.
- summaryFunction string? - The accumulation type for the summary field.
- sourceFieldId int? - The id of the source field.
- doesAverage boolean? - Whether this field averages in reports within the product.
- formula string? - The formula of the field as configured in Quickbase.
- decimalPlaces int? - The number of decimal places displayed in the product for this field.
- displayMonth string? - How to display months.
- seeVersions boolean? - Indicates if the user can see other versions, aside from the most recent, of a file attachment within the product.
- numLines int? - The number of lines shown in Quickbase for this text field.
- defaultKind string? - The user default type.
- displayEmail string? - How the email is displayed.
- coverText string? - An alternate user friendly text that can be used to display a link in the browser.
- currencySymbol string? - The current symbol used when displaying field values within the product.
- summaryQuery string? - The summary query.
- targetFieldId int? - The id of the target field.
- displayUser string? - The configured option for how users display within the product.
- blankIsZero boolean? - Whether a blank value is treated the same as 0 in calculations within the product.
- exact boolean? - Whether an exact match is required for a report link.
- defaultDomain string? - Default email domain.
- defaultValue string? - The default value configured for a field when a new record is added.
- abbreviate boolean? - Don't show the URL protocol when showing the URL.
- numberFormat int? - The format used for displaying numeric values in the product (decimal, separators, digit group).
- targetTableName string? - The field's target table name.
- appearsAs string? - The link text, if empty, the url will be used as link text.
- width int? - The field's html input width in the product.
- currencyFormat string? - The currency format used when displaying field values within the product.
- displayImages boolean? - Indicates whether images will display for file attachments on forms and reports within the product.
- displayDayOfWeek boolean? - Indicates whether to display the day of the week within the product.
- summaryReferenceFieldId int? - The id of the field that is the reference in the relationship for this summary.
- commaStart int? - The number of digits before commas display in the product, when applicable.
- choices string[]? - An array of entries that exist for a field that offers choices to the user. Note that these choices refer to the valid values of any records added in the future. You are allowed to remove values from the list of choices even if there are existing records with those values in this field. They will be displayed in red when users look at the data in the browser but there is no other effect. While updating a field with this property, the old choices are removed and replaced by the new choices.
- targetTableId string? - The id of the target table.
- displayRelative boolean? - Whether to display time as relative.
- compositeFields string[]? - An array of the fields that make up a composite field (e.g., address).
- summaryTableId string? - The table the summary field references fields from.
- displayTime boolean? - Indicates whether to display the time, in addition to the date.
- versionMode string? - Version modes for files. Keep all versions vs keep last version.
- snapFieldId int? - The id of the field that is used to snapshot values from, when applicable.
- hours24 boolean? - Indicates whether or not to display time in the 24-hour format within the product.
- sortAlpha boolean? - Whether to sort alphabetically, default sort is by record ID.
- sortAsGiven boolean? - Indicates if the listed entries sort as entered vs alphabetically.
- hasExtension boolean? - Whether this field has a phone extension.
- useNewWindow boolean? - Indicates if the URL should open a new window when a user clicks it within the product.
- appendOnly boolean? - Whether this field is append only.
- displayAsLink boolean? - Indicates if a field that is part of the relationship should be shown as a hyperlink to the parent record within the product.
- lookupReferenceFieldId int? - The id of the field that is the reference in the relationship for this lookup.
quickbase: FieldsPermissions
Fields
- role string? - The role associated with a given permission for the field
- permissionType string? - The permission given to the role for this field
- roleId int? - The Id of the given role
quickbase: FieldsProperties
Additional properties for the field. Please see Field type details page for more details on the properties for each field type.
Fields
- comments string? - The comments entered on the field properties by an administrator.
- doesTotal boolean? - Whether this field totals in reports within the product.
- autoSave boolean? - Whether the link field will auto save.
- defaultValueLuid int? - Default user id value.
- maxVersions int? - The maximum number of versions configured for a file attachment.
- carryChoices boolean? - Whether the field should carry its multiple choice fields when copied.
- format int? - The format to display time.
- maxLength int? - The maximum number of characters allowed for entry in Quickbase for this field.
- linkText string? - The configured text value that replaces the URL that users see within the product.
- parentFieldId int? - The id of the parent composite field, when applicable.
- displayTimezone boolean? - Indicates whether to display the timezone within the product.
- summaryTargetFieldId int? - The id of the field that is used to aggregate values from the child, when applicable. This displays 0 if the summary function doesn’t require a field selection (like count).
- allowNewChoices boolean? - Indicates if users can add new choices to a selection list.
- masterChoiceFieldId int? - The id of the field that is the reference in the relationship.
- defaultToday boolean? - Indicates if the field value is defaulted today for new records.
- units string? - The units label.
- lookupTargetFieldId int? - The id of the field that is the target on the master table for this lookup.
- summaryFunction string? - The summary accumulation function type.
- sourceFieldId int? - The id of the source field.
- masterTableTag string? - The table alias for the master table in the relationship this field is part of.
- doesAverage boolean? - Whether this field averages in reports within the product.
- formula string? - The formula of the field as configured in Quickbase.
- decimalPlaces int? - The number of decimal places displayed in the product for this field.
- seeVersions boolean? - Indicates if the user can see other versions, aside from the most recent, of a file attachment within the product.
- displayMonth string? - How to display months.
- numLines int? - The number of lines shown in Quickbase for this text field.
- displayEmail string? - How the email is displayed.
- defaultKind string? - The user default type.
- coverText string? - An alternate user friendly text that can be used to display a link in the browser.
- currencySymbol string? - The current symbol used when displaying field values within the product.
- masterChoiceTableId int? - The id of the table that is the master in this relationship.
- targetFieldId int? - The id of the target field.
- displayUser string? - The configured option for how users display within the product.
- blankIsZero boolean? - Whether a blank value is treated the same as 0 in calculations within the product.
- exact boolean? - Whether an exact match is required for a report link.
- startField int? - The start field id.
- defaultDomain string? - Default email domain.
- defaultValue string? - The default value configured for a field when a new record is added.
- choicesLuid string[]? - List of user choices.
- abbreviate boolean? - Don't show the URL protocol when showing the URL.
- xmlTag string? - The field's xml tag.
- targetTableName string? - The field's target table name.
- numberFormat int? - The format used for displaying numeric values in the product (decimal, separators, digit group).
- appearsAs string? - The link text, if empty, the url will be used as link text.
- width int? - The field's html input width in the product.
- currencyFormat string? - The currency format used when displaying field values within the product.
- displayImages boolean? - Indicates whether images will display for file attachments on forms and reports within the product.
- foreignKey boolean? - Indicates if the field is a foreign key (or reference field) in a relationship.
- displayDayOfWeek boolean? - Indicates whether to display the day of the week within the product.
- summaryReferenceFieldId int? - The id of the field that is the reference in the relationship for this summary.
- commaStart int? - The number of digits before commas display in the product, when applicable.
- choices string[]? - An array of entries that exist for a field that offers choices to the user.
- targetTableId string? - The id of the target table.
- displayRelative boolean? - Whether to display time as relative.
- compositeFields string[]? - An array of the fields that make up a composite field (e.g., address).
- versionMode string? - Version modes for files. Keep all versions vs keep last version.
- displayTime boolean? - Indicates whether to display the time, in addition to the date.
- durationField int? - The duration field id.
- snapFieldId int? - The id of the field that is used to snapshot values from, when applicable.
- hours24 boolean? - Indicates whether or not to display time in the 24-hour format within the product.
- sortAlpha boolean? - Whether to sort alphabetically, default sort is by record ID.
- sortAsGiven boolean? - Indicates if the listed entries sort as entered vs alphabetically.
- hasExtension boolean? - Whether this field has a phone extension.
- workWeek int? - The work week type.
- useNewWindow boolean? - Indicates if the URL should open a new window when a user clicks it within the product.
- appendOnly boolean? - Whether this field is append only.
- displayAsLink boolean? - Indicates if a field that is part of the relationship should be shown as a hyperlink to the parent record within the product.
- allowHTML boolean? - Whether this field allows html.
- lookupReferenceFieldId int? - The id of the field that is the reference in the relationship for this lookup.
quickbase: FieldsProperties1
Specific field properties.
Fields
- comments string? - The comments entered on the field properties by an administrator.
- doesTotal boolean? - Whether this field totals in reports within the product.
- autoSave boolean? - Whether the link field will auto save.
- defaultValueLuid int? - Default user id value.
- maxVersions int? - The maximum number of versions configured for a file attachment.
- format int? - The format to display time.
- carryChoices boolean? - Whether the field should carry its multiple choice fields when copied.
- maxLength int? - The maximum number of characters allowed for entry in Quickbase for this field.
- linkText string? - The configured text value that replaces the URL that users see within the product.
- parentFieldId int? - The id of the parent composite field, when applicable.
- displayTimezone boolean? - Indicates whether to display the timezone within the product.
- allowNewChoices boolean? - Indicates if users can add new choices to a selection list.
- defaultToday boolean? - Indicates if the field value is defaulted today for new records.
- units string? - The units label.
- sourceFieldId int? - The id of the source field.
- doesAverage boolean? - Whether this field averages in reports within the product.
- formula string? - The formula of the field as configured in Quickbase.
- decimalPlaces int? - The number of decimal places displayed in the product for this field.
- displayMonth string? - How to display months.
- seeVersions boolean? - Indicates if the user can see other versions, aside from the most recent, of a file attachment within the product.
- numLines int? - The number of lines shown in Quickbase for this text field.
- defaultKind string? - The user default type.
- displayEmail string? - How the email is displayed.
- coverText string? - An alternate user friendly text that can be used to display a link in the browser.
- currencySymbol string? - The current symbol used when displaying field values within the product.
- targetFieldId int? - The id of the target field.
- displayUser string? - The configured option for how users display within the product.
- blankIsZero boolean? - Whether a blank value is treated the same as 0 in calculations within the product.
- exact boolean? - Whether an exact match is required for a report link.
- defaultDomain string? - Default email domain.
- defaultValue string? - The default value configured for a field when a new record is added.
- abbreviate boolean? - Don't show the URL protocol when showing the URL.
- numberFormat int? - The format used for displaying numeric values in the product (decimal, separators, digit group).
- targetTableName string? - The field's target table name.
- appearsAs string? - The link text, if empty, the url will be used as link text.
- width int? - The field's html input width in the product.
- currencyFormat string? - The currency format used when displaying field values within the product.
- displayImages boolean? - Indicates whether images will display for file attachments on forms and reports within the product.
- displayDayOfWeek boolean? - Indicates whether to display the day of the week within the product.
- commaStart int? - The number of digits before commas display in the product, when applicable.
- choices string[]? - An array of entries that exist for a field that offers choices to the user. Note that these choices refer to the valid values of any records added in the future. You are allowed to remove values from the list of choices even if there are existing records with those values in this field. They will be displayed in red when users look at the data in the browser but there is no other effect. While updating a field with this property, the old choices are removed and replaced by the new choices.
- targetTableId string? - The id of the target table.
- displayRelative boolean? - Whether to display time as relative.
- compositeFields string[]? - An array of the fields that make up a composite field (e.g., address).
- displayTime boolean? - Indicates whether to display the time, in addition to the date.
- versionMode string? - Version modes for files. Keep all versions vs keep last version.
- snapFieldId int? - The id of the field that is used to snapshot values from, when applicable.
- hours24 boolean? - Indicates whether or not to display time in the 24-hour format within the product.
- sortAlpha boolean? - Whether to sort alphabetically, default sort is by record ID.
- sortAsGiven boolean? - Indicates if the listed entries sort as entered vs alphabetically.
- hasExtension boolean? - Whether this field has a phone extension.
- useNewWindow boolean? - Indicates if the URL should open a new window when a user clicks it within the product.
- appendOnly boolean? - Whether this field is append only.
- displayAsLink boolean? - Indicates if a field that is part of the relationship should be shown as a hyperlink to the parent record within the product.
quickbase: FieldsusageField
Basic information about the field.
Fields
- name string - Field name.
- id int - Field id.
- 'type string - Field type.
quickbase: FieldsusageUsage
Usage Information about the field.
Fields
- defaultReports FieldsusageUsageDefaultreports - The number of default reports where the given field is referenced.
- notifications FieldsusageUsageNotifications - The number of notifications where the given field is referenced.
- reminders FieldsusageUsageReminders - The number of reminders where the given field is referenced.
- forms FieldsusageUsageForms - The number of forms where the given field is referenced.
- actions FieldsusageUsageActions - The number of quickbase actions where the given field is referenced.
- personalReports FieldsusageUsagePersonalreports - The number of personal reports where the given field is referenced.
- roles FieldsusageUsageRoles - The number of roles where the given field is referenced.
- reports FieldsusageUsageReports - The number of reports where the given field is referenced.
- fields FieldsusageUsageFields - The number of fields where the given field is referenced.
- relationships FieldsusageUsageRelationships - The number of relationships where the given field is referenced.
- webhooks FieldsusageUsageWebhooks - The number of webhooks where the given field is referenced.
- appHomePages FieldsusageUsageApphomepages - The number of app home pages where the given field is referenced.
- exactForms FieldsusageUsageExactforms - The number of exact forms where the given field is referenced.
quickbase: FieldsusageUsageActions
The number of quickbase actions where the given field is referenced.
Fields
- count int - the number of times a field has been used for the given item.
quickbase: FieldsusageUsageApphomepages
The number of app home pages where the given field is referenced.
Fields
- count int - the number of times a field has been used for the given item.
quickbase: FieldsusageUsageDefaultreports
The number of default reports where the given field is referenced.
Fields
- count int - the number of times a field has been used for the given item.
quickbase: FieldsusageUsageExactforms
The number of exact forms where the given field is referenced.
Fields
- count int - the number of times a field has been used for the given item.
quickbase: FieldsusageUsageFields
The number of fields where the given field is referenced.
Fields
- count int - the number of times a field has been used for the given item.
quickbase: FieldsusageUsageForms
The number of forms where the given field is referenced.
Fields
- count int - the number of times a field has been used for the given item.
quickbase: FieldsusageUsageNotifications
The number of notifications where the given field is referenced.
Fields
- count int - the number of times a field has been used for the given item.
quickbase: FieldsusageUsagePersonalreports
The number of personal reports where the given field is referenced.
Fields
- count int - the number of times a field has been used for the given item.
quickbase: FieldsusageUsageRelationships
The number of relationships where the given field is referenced.
Fields
- count int - the number of times a field has been used for the given item.
quickbase: FieldsusageUsageReminders
The number of reminders where the given field is referenced.
Fields
- count int - the number of times a field has been used for the given item.
quickbase: FieldsusageUsageReports
The number of reports where the given field is referenced.
Fields
- count int - the number of times a field has been used for the given item.
quickbase: FieldsusageUsageRoles
The number of roles where the given field is referenced.
Fields
- count int - the number of times a field has been used for the given item.
quickbase: FieldsusageUsageWebhooks
The number of webhooks where the given field is referenced.
Fields
- count int - the number of times a field has been used for the given item.
quickbase: FormulaRunBody
The following example will execute a Sum() for '20' and the value in a record with id 1 for the field with label 'NumericField'. Since this API is able to run any type of formula, all results will be returned as a string.
Fields
- formula string - The formula to run. This must be a valid Quickbase formula.
- rid int? - The record ID to run the formula against. Only necessary for formulas that are run in the context of a record. For example, the formula User() does not need a record ID.
- 'from string - The unique identifier (dbid) of the table.
quickbase: InlineResponse200
Fields
- isActive boolean? - Indication of whether current event is active.
- 'type string? - Type of an event.
- name string? - The name of the event. This property is not returned for automations.
- url string? - The url to automation that can be accessed from the browser. Only returned for automations.
- owner AppsappideventsOwner? - The user that owns the event.
- tableId string? - The unique identifier of the table to which event belongs to.
quickbase: InlineResponse2001
Fields
- name string? - The name of the table.
- id string? - The unique identifier (dbid) of the table.
- alias string? - The automatically-created table alias for the table.
- description string? - The description of the table, as configured by an application administrator.
- created string? - The time and date when the table was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).
- updated string? - The time and date when the table schema or data was last updated, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone).
- nextRecordId int? - The incremental Record ID that will be used when the next record is created, as determined when the API call was ran.
- nextFieldId int? - The incremental Field ID that will be used when the next field is created, as determined when the API call was ran.
- defaultSortFieldId int? - The id of the field that is configured for default sorting.
- defaultSortOrder string? - The configuration of the default sort order on the table.
- keyFieldId int? - The id of the field that is configured to be the key on this table, which is usually the Quickbase Record ID.
- singleRecordName string? - The builder-configured singular noun of the table.
- pluralRecordName string? - The builder-configured plural noun of the table.
- sizeLimit string? - The size limit for the table.
- spaceUsed string? - The amount of space currently being used by the table.
- spaceRemaining string? - The amount of space remaining for use by the table.
quickbase: InlineResponse2002
Fields
- id string? - The identifier of the report, unique to the table.
- name string? - The configured name of the report.
- 'type string? - The type of report in Quickbase (e.g., chart).
- description string? - The configured description of a report.
- ownerId int? - Optional, showed only for personal reports. The user ID of report owner.
- query ReportsQuery? - The query definition as configured in Quickbase that gets executed when the report is run.
- properties record {}? - A list of properties specific to the report type. To see a detailed description of the properties for each report type, See Report Types.
- usedLast string? - The instant at which a report was last used.
- usedCount int? - The number of times a report has been used.
quickbase: InlineResponse2003
Fields
- id int - The id of the field, unique to this table.
- mode string? - For derived fields, this will be 'lookup', 'summary', or 'formula', to indicate the type of derived field. For non-derived fields, this will be blank.
- label string? - The label (name) of the field.
- noWrap boolean? - Indicates if the field is configured to not wrap when displayed in the product.
- bold boolean? - Indicates if the field is configured to display in bold in the product.
- required boolean? - Indicates if the field is marked required.
- appearsByDefault boolean? - Indicates if the field is marked as a default in reports.
- findEnabled boolean? - Indicates if the field is marked as searchable.
- unique boolean? - Indicates if the field is marked unique.
- doesDataCopy boolean? - Indicates if the field data will copy when a user copies the record.
- fieldHelp string? - The configured help text shown to users within the product.
- audited boolean? - Indicates if the field is being tracked as part of Quickbase Audit Logs.
- properties FieldsProperties? - Additional properties for the field. Please see Field type details page for more details on the properties for each field type.
- permissions FieldsPermissions[]? - Field Permissions for different roles.
quickbase: InlineResponse2004
Fields
- 'field FieldsusageField - Basic information about the field.
- usage FieldsusageUsage - Usage Information about the field.
quickbase: RecordsBody
Fields
- to string - The table identifier.
- data string[]? - Record data array.
- mergeFieldId int? - The merge field id.
- fieldsToReturn int[]? - Specify an array of field ids that will return data for any updates or added record. Record ID (FID 3) is always returned if any field ID is requested.
quickbase: RecordsQueryBody
If grouping or sorting is not set, records will not be sorted.
Fields
- options RecordsqueryOptions? - Additional query options.
- 'where string? - The filter, using the Quickbase query language, which determines the records to return. If this parameter is omitted, the query will return all records.
- groupBy RecordsqueryGroupby[]? - An array that contains the fields to group the records by.
- sortBy record {}? - By default, queries will be sorted by the given sort fields or the default sort if the query does not provide any. Set to false to avoid sorting when the order of the data returned is not important. Returning data without sorting can improve performance.
- 'select string[]? - An array of field ids for the fields that should be returned in the response. If empty, the default columns on the table will be returned.
- 'from string - The table identifier.
quickbase: RecordsqueryGroupby
Fields
- fieldId int? - The unique identifier of a field in a table.
- grouping string? - Group by based on ascending order (ASC), descending order (DESC) or equal values (equal-values)
quickbase: RecordsqueryOptions
Additional query options.
Fields
- skip int? - The number of records to skip.
- compareWithAppLocalTime boolean? - Whether to run the query against a date time field with respect to the application's local time. The query is run with UTC time by default.
- top int? - The maximum number of records to display.
quickbase: RelationshipRelationshipidBody
Fields
- summaryFields TablestableidrelationshipSummaryfields[]? - An array of objects, each representing a configuration of one field from the child table, that will become summary fields on the parent table. When you specify the 'COUNT' accumulation type, you have to specify 0 as the summaryFid (or not set it in the request). 'DISTINCT-COUNT' requires that summaryFid be set to an actual fid.
- lookupFieldIds int[]? - An array of field ids on the parent table that will become lookup fields on the child table.
quickbase: ReportsQuery
The query definition as configured in Quickbase that gets executed when the report is run.
Fields
- tableId string? - The table identifier for the report.
- filter string? - Filter used to query for data.
- formulaFields ReportsQueryFormulafields[]? - Calculated formula fields.
quickbase: ReportsQueryFormulafields
Fields
- id int? - Formula field identifier.
- label string? - Formula field label.
- fieldType string? - Resulting formula value type.
- formula string? - Formula text.
- decimalPrecision int? - For numeric formula the number precision.
quickbase: TableidRelationshipBody
Fields
- summaryFields TablestableidrelationshipSummaryfields[]? - Array of summary field objects which will turn into summary fields in the parent table. When you specify the 'COUNT' accumulation type, you have to specify 0 as the summaryFid (or not set it in the request). 'DISTINCT-COUNT' requires that summaryFid be set to an actual fid.
- lookupFieldIds int[]? - Array of field ids in the parent table that will become lookup fields in the child table.
- parentTableId string - The parent table id for the relationship.
- foreignKeyField TablestableidrelationshipForeignkeyfield? - This property is optional. If it is not provided, the foreign key field will be created with the label ‘Related <record>’, where <record> is the name of a record in the parent table.
quickbase: TablesBody
The example below shows all the properties that can be changed with this request. Additional properties that you can see with the corresponding GET request cannot be set through this API.
Fields
- name string - The name for the table.
- pluralRecordName string? - The plural noun for records in the table. If this value is not passed the default value is 'Records'.
- singleRecordName string? - The singular noun for records in the table. If this value is not passed the default value is 'Record'.
- description string? - The description for the table. If this value is not passed the default value is blank.
quickbase: TablesTableidBody
The example below shows all the properties that can be changed with this request. Additional properties that you can see with the corresponding GET request cannot be set through this API.
Fields
- name string? - The name for the table.
- pluralRecordName string? - The plural noun for records in the table. If this value is not passed the default value is 'Records'.
- singleRecordName string? - The singular noun for records in the table. If this value is not passed the default value is 'Record'.
- description string? - The description for the table. If this value is not passed the default value is blank.
quickbase: TablestableidrelationshipForeignkeyfield
This property is optional. If it is not provided, the foreign key field will be created with the label ‘Related
Fields
- label string? - The label for the foreign key field.
quickbase: TablestableidrelationshipSummaryfields
Fields
- summaryFid decimal? - The field id to summarize.
- label string? - The label for the summary field.
- accumulationType string - The accumulation type for the summary field.
- 'where string? - The filter, using the Quickbase query language, which determines the records to return.
quickbase: UsertokenCloneBody
Fields
- name string? - The new name for the cloned user token.
- description string? - The description for the cloned user token.