In this article
To see your Quickbase apps and pipelines represented textually, you first need to add them to a solution.
After they are added to a solution, you can use the Solution API call. The call works with solution IDs, not app IDs.
Visit the Quickbase developer portal to view the API documentation.
Solution API endpoints
|
Endpoint |
Capability |
|---|---|
|
Export a solution |
Provides the QBL definition for the supported schema of all apps in the Solution in the format of a yaml file. Solution owners or contributors can make an export call. |
|
Create a solution |
Apply a yaml file with a valid QBL definition to create a new solution and the apps it contains. The user making the create call will become solution owner and app manager of the newly created resources. |
|
Update a solution |
Apply a yaml with a valid QBL definition to an already existing Solution to update all schema in the solution to match the one in the yaml. Learn more about how Quickbase updates schema in Logical IDs. |
|
List solution changes |
Returns a list of changes that would occur if the provided QBL was applied to a given solution. |
|
Export solution to record |
Provides the QBL definition for the supported schema of all apps in the Solution in the format of a yaml file, then uploads the file to a record in a specified Quickbase table. Solution owners or contributors can make an export call. |
|
Create solution from record |
Apply a yaml file with a valid QBL definition from a record to create a new solution and the apps it contains. The user making the create call will become solution owner and app manager of the newly created resources. |
|
Update solution from record |
Apply a yaml with a valid QBL definition from a record to an already existing Solution to update all schema in the solution to match the one in the yaml. Learn more about how Quickbase updates schema in Logical IDs. |
|
List solution changes from record |
Returns a list of changes that would occur if the provided QBL from a record was applied to a given solution. |
The illustration below shows how you can use the export, create and update endpoints to manage changes to Quickbase solutions.
- Start with a solution, created in the Quickbase UI.
- Use the export API to get the QBL definition of the solution.
- Use the create API to make a copy of the solution.
- Use the export API to get the QBL definition of the solution copy.
- Use the update API to update the original solution with any changes made in the copy of the solution.
Impact on user and integration reads
The Solution APIs do not directly impact user and integration reads. However, the apps modified or created by the API may product reads if a user performs one of the actions listed in this article.
Unsupported schema
The Solution APIs do not handle unsupported schema. If your solution contains schema that is not yet supported by the Solution APIs, this is what happens with each API endpoint:
- Export: Only supported objects are included in the yaml. Unsupported objects are not impacted.
- Update: Only supported objects are updated. Unsupported objects are not deleted or changed.
- Create: Only supported schema and auto generated objects (e.g. List All report) are created in the new application.
-
List changes: Only supported objects are included in the yaml. Unsupported objects are not listed.
Note: The same conditions apply when using the export, update, create or list changes API from a record.
To understand what schema are currently supported for each version of QBL, visit the overview page for each version.
Realm setup
Realm admins control access to the solution APIs on the Policies page in the Admin Console.
By default, the setting to access the Solution APIs is off.
Learn more about permissions for the Solution APIs.
Implement versioning and rollbacks
You can use versioning, rollbacks and Solution APIs independently from one another. We recommend using them together to ensure you are developing your apps safely.
We recommend you store a versioning snapshot before making schema updates to your solutions. This will guarantee that updates can be reversed if needed.
Track updates to your applications
To understand when an application has been created or updated using the Solution APIs, you can:
- View an audit log event for every create, update or export API call made in the realm.
- Use a SCM tool to set up information reporting in there. If you are running the APIs through a pipeline, you can easily set up an alternative logging of events too, or look at the pipelines logs.