Skip to content

A PHP library for the Quick Base JSON REST API utilizing the OpenAPI definitions.

License

Notifications You must be signed in to change notification settings

rossity/php-quickbase

Repository files navigation

Rossity/PhpQuickbase

A Quick Base RESTful API implementation of their OpenAPI spec.

Installation & Usage

Requirements

PHP 7.2 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/rossity/php-quickbase.git"
    }
  ],
  "require": {
    "rossity/php-quickbase": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/Rossity/PhpQuickbase/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');




$apiInstance = new Rossity\PhpQuickbase\Api\AppsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$appId = 'appId_example'; // string | The unique identifier of an app
$qBRealmHostname = 'qBRealmHostname_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).
$userAgent = 'userAgent_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 = new \Rossity\PhpQuickbase\Model\InlineObject3(); // \Rossity\PhpQuickbase\Model\InlineObject3

try {
    $result = $apiInstance->copyApp($appId, $qBRealmHostname, $authorization, $userAgent, $generated);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AppsApi->copyApp: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

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

Class Method HTTP request Description
AppsApi copyApp POST /apps/{appId}/copy Copy an app
AppsApi createApp POST /apps Create an app
AppsApi deleteApp DELETE /apps/{appId} Delete an app
AppsApi getApp GET /apps/{appId} Get an app
AppsApi getAppEvents GET /apps/{appId}/events Get app events
AppsApi updateApp POST /apps/{appId} Update an app
AuthApi getTempTokenDBID GET /auth/temporary/{dbid} Get a temporary token for a dbid
FieldsApi createField POST /fields Create a field
FieldsApi deleteFields DELETE /fields Delete field(s)
FieldsApi getField GET /fields/{fieldId} Get field
FieldsApi getFieldUsage GET /fields/usage/{fieldId} Get usage for a field
FieldsApi getFields GET /fields Get fields for a table
FieldsApi getFieldsUsage GET /fields/usage Get usage for all fields
FieldsApi updateField POST /fields/{fieldId} Update a field
FilesApi deleteFile DELETE /files/{tableId}/{recordId}/{fieldId}/{versionNumber} Delete file
FilesApi downloadFile GET /files/{tableId}/{recordId}/{fieldId}/{versionNumber} Download file
RecordsApi deleteRecords DELETE /records Delete record(s)
RecordsApi runQuery POST /records/query Query for data
RecordsApi upsert POST /records Insert/Update record(s)
ReportsApi getReport GET /reports/{reportId} Get a report
ReportsApi getTableReports GET /reports Get reports for a table
ReportsApi runReport POST /reports/{reportId}/run Run a report
TablesApi createRelationship POST /tables/{tableId}/relationship Create a relationship
TablesApi createTable POST /tables Create a table
TablesApi deleteRelationship DELETE /tables/{tableId}/relationship/{relationshipId} Delete a relationship
TablesApi deleteTable DELETE /tables/{tableId} Delete a table
TablesApi getAppTables GET /tables Get tables for an app
TablesApi getRelationships GET /tables/{tableId}/relationships Get all relationships
TablesApi getTable GET /tables/{tableId} Get a table
TablesApi updateRelationship POST /tables/{tableId}/relationship/{relationshipId} Update a relationship
TablesApi updateTable POST /tables/{tableId} Update a table
UserTokenApi cloneUserToken POST /usertoken/clone Clone a user token
UserTokenApi deactivateUserToken POST /usertoken/deactivate Deactivate a user token
UserTokenApi deleteUserToken DELETE /usertoken Delete a user token

Models

Authorization

All endpoints do not require authorization.

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

About this package

  • API version: 1.0.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

About

A PHP library for the Quick Base JSON REST API utilizing the OpenAPI definitions.

Resources

License

Stars

Watchers

Forks

Packages

No packages published