Tetra Data Pipeline REST API endpoints provide the ability to programmatically create multiple pipelines with different parameters from a single protocol. They can also help you programmatically process a list of files by using a specific pipeline, search for pipelines by specific parameters, and more.

Endpoints

📘
NOTE
Before using any of the following endpoints, it's recommended that you familiarize yourself with pipeline concepts and terminology.

Get TDP Deployment Information

Get Platform Information returns information about the current Tetra Data Platform (TDP) deployment.

Search Pipelines

Search Pipelines searches for pipelines based on specified parameters.
Get Details of a Single Pipeline gets the details of a single pipeline.
List Pipeline Revision History gets a pipeline's revision history.
Get Pipeline Revision Contents gets the contents of each pipeline's revision contents.

Create and Update Pipelines

Create New Pipeline creates a new pipeline.
Update Existing Pipeline updates an existing pipeline.
Set Pipeline Status sets the status of a pipeline.

Process Files

Process List of Files with Pipeline processes a list of files by using a specified pipeline.
Create a Bulk Processing Job creates a bulk processing job for reprocessing selected files.

Common Request Parameters

The following are common request parameters for Tetra Data Pipeline API endpoints:

triggerCondition matches pipeline files to a pipeline trigger.
groupLevel indicates which hierarchical level the operator and group belong to (1 or 2).
groupOperator are comparators between groups at the same level (ANDorOR).
groups are a list of trigger conditions that the groupOperator is applied to.
status indicates if a pipeline is active (null) or not (disabled).