quick_base

QuickBase - the Ruby gem for the Quick Base API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build quick_base.gemspec

Then either install the gem locally:

gem install ./quick_base-1.0.0.gem

(for development, run gem install --dev ./quick_base-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'quick_base', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO, then add the following in the Gemfile:

gem 'quick_base', :git => 'https://github.com/YOUR_GIT_USERNAME/YOUR_GIT_REPO.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'quick_base'

api_instance = QuickBase::AppsApi.new

qb_realm_hostname = 'qb_realm_hostname_example' # String | Your Quick Base domain, for example demo.quickbase.com

authorization = 'authorization_example' # String | The Quick Base authentication scheme you are using to authenticate the request, as described on the [authorization page](../auth).

opts = { 
  user_agent: 'user_agent_example', # String | 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.
  generated: QuickBase::Generated.new # Generated | 
}

begin
  #Create an app
  result = api_instance.create_app(qb_realm_hostname, authorization, opts)
  p result
rescue QuickBase::ApiError => e
  puts "Exception when calling AppsApi->create_app: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.quickbase.com/v1

Class	Method	HTTP request	Description
QuickBase::AppsApi	create_app	POST /apps	Create an app
QuickBase::AppsApi	delete_app	DELETE /apps/{appId}	Delete an app
QuickBase::AppsApi	get_app	GET /apps/{appId}	Get an app
QuickBase::AppsApi	update_app	POST /apps/{appId}	Update an app
QuickBase::AuthApi	get_temp_token_dbid	GET /auth/temporary/{dbid}	Get a temporary token for a dbid
QuickBase::FieldsApi	create_field	POST /fields	Create a field
QuickBase::FieldsApi	delete_fields	DELETE /fields	Delete field(s)
QuickBase::FieldsApi	get_field	GET /fields/{fieldId}	Get field
QuickBase::FieldsApi	get_field_usage	GET /fields/usage/{fieldId}	Get usage for a field
QuickBase::FieldsApi	get_fields	GET /fields	Get fields for a table
QuickBase::FieldsApi	get_fields_usage	GET /fields/usage	Get usage for all fields
QuickBase::FieldsApi	update_field	POST /fields/{fieldId}	Update a field
QuickBase::FilesApi	delete_file	DELETE /files/{tableId}/{recordId}/{fieldId}/{versionNumber}	Delete file
QuickBase::FilesApi	download_file	GET /files/{tableId}/{recordId}/{fieldId}/{versionNumber}	Download file
QuickBase::RecordsApi	delete_records	DELETE /records	Delete record(s)
QuickBase::RecordsApi	run_query	POST /records/query	Query for data
QuickBase::RecordsApi	upsert	POST /records	Insert/Update record(s)
QuickBase::ReportsApi	get_report	GET /reports/{reportId}	Get a report
QuickBase::ReportsApi	get_table_reports	GET /reports	Get reports for a table
QuickBase::ReportsApi	run_report	POST /reports/{reportId}/run	Run a report
QuickBase::TablesApi	create_relationship	POST /tables/{tableId}/relationship	Create a relationship
QuickBase::TablesApi	create_table	POST /tables	Create a table
QuickBase::TablesApi	delete_relationship	DELETE /tables/{tableId}/relationship/{relationshipId}	Delete a relationship
QuickBase::TablesApi	delete_table	DELETE /tables/{tableId}	Delete a table
QuickBase::TablesApi	get_app_tables	GET /tables	Get tables for an app
QuickBase::TablesApi	get_relationships	GET /tables/{tableId}/relationships	Get all relationships
QuickBase::TablesApi	get_table	GET /tables/{tableId}	Get a table
QuickBase::TablesApi	update_relationship	POST /tables/{tableId}/relationship/{relationshipId}	Update a relationship
QuickBase::TablesApi	update_table	POST /tables/{tableId}	Update a table

Documentation for Models

• QuickBase::AppsVariables
• QuickBase::FieldsPermissions
• QuickBase::FieldsProperties
• QuickBase::FieldsfieldIdProperties
• QuickBase::FieldsusageField
• QuickBase::FieldsusageUsage
• QuickBase::FieldsusageUsageActions
• QuickBase::FieldsusageUsageAppHomePages
• QuickBase::FieldsusageUsageDefaultReports
• QuickBase::FieldsusageUsageExactForms
• QuickBase::FieldsusageUsageFields
• QuickBase::FieldsusageUsageForms
• QuickBase::FieldsusageUsageNotifications
• QuickBase::FieldsusageUsagePersonalReports
• QuickBase::FieldsusageUsageRelationships
• QuickBase::FieldsusageUsageReminders
• QuickBase::FieldsusageUsageReports
• QuickBase::FieldsusageUsageRoles
• QuickBase::FieldsusageUsageWebhooks
• QuickBase::Generated
• QuickBase::Generated1
• QuickBase::Generated10
• QuickBase::Generated11
• QuickBase::Generated12
• QuickBase::Generated2
• QuickBase::Generated3
• QuickBase::Generated4
• QuickBase::Generated5
• QuickBase::Generated6
• QuickBase::Generated7
• QuickBase::Generated8
• QuickBase::Generated9
• QuickBase::InlineResponse200
• QuickBase::InlineResponse2001
• QuickBase::InlineResponse2002
• QuickBase::InlineResponse2003
• QuickBase::RecordsqueryGroupBy
• QuickBase::RecordsqueryOptions
• QuickBase::ReportsQuery
• QuickBase::ReportsQueryFormulaFields
• QuickBase::TablestableIdrelationshipForeignKeyField
• QuickBase::TablestableIdrelationshipSummaryFields

Documentation for Authorization

All endpoints do not require authorization.