Pipelines: QBL v0.9

This article contains information about a QBL (Quickbase language) object. QBL objects are the supported Quickbase schema elements you see textually represented in the YAML file generated by Quickbase when you export a solution. Each object has associated properties. Supported schema may differ by QBL version.

QBL support for pipelines is currently in open beta. This beta version introduces temporary behaviors that will evolve in future releases.

To use this version, specify 0.9 when making requests with the API. No other activation is required.

General behavior

• Pipelines can only be exported and created through Solution APIs as part of a solution.
• If the import or export of any resource in a solution fails, the request is stopped, and all resources revert to their original state.

Permissions

All Solution API permissions apply. Additional permissions apply to these APIs:

• Export: Users who are owners or contributors of a solution can export it, regardless of their individual access to specific resources within the solution.
• Import: The user performing the import must have realm permissions to create solutions and will become the owner of all resources in the newly created solution.

Supported channels

QBL v0.9 only supports these pipeline channels:

• Quickbase
• Callable pipelines
• Clock
• Text
• Bucket

Pipelines containing unsupported channels are not included in the export.

Solution API rules for pipelines

This section explains rules for each solution API, including authentication handling, reference handling, and general behaviors.

Export

Authentication:

• Each account connection is exported with the account ID included in the QBL.

References:

• Recognizable references within the solution are exported as Logical IDs in the QBL, including:
  • Quickbase app references
  • Quickbase table references
  • Quickbase field references
  • Callable pipeline references
• References outside the solution retain their real IDs.
• Jinja expressions are exported as plain strings.
• Quickbase auth tokens are not exported, even for user token-authenticated pipelines.

Create

• The user performing the import will become the owner of the pipeline.
• Imported pipelines default to the "off" state.
• Imported pipelines retain the original schedule.

Authentication:

• Quickbase steps requiring authentication automatically use the realm default account of the user executing the create request.
• Tokenless authentication is applied for the user performing the create request. This version does not support creating steps with token-authenticated accounts.
• Pipeline creation is only permitted if the user has the necessary permissions to create pipelines.
• If a pipeline is created in a different realm from the original export, references within the solution are adjusted to match the new realm’s default account.

Update

• The pipeline owner remains unchanged after update.
• The state of the pipeline (on/off) remains unchanged.
• Pipeline updates may adjust the following if specified in QBL:
  • Name
  • Description
  • Type
  • Schedule

Authentication:

• Existing steps with authenticated tokenless accounts retain their current authentication. 
• Existing steps with token-authenticated accounts are updated with the realm default account of the user executing the update.
• Newly created steps during an update use the realm default account of the user executing the update.

Pipelines properties

The following tables list information about the properties of this object. 

Pipeline

Pipeline account

Pipeline step