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
NOTEBefore using any of the following endpoints, it's recommended that you familiarize yourself with pipeline concepts and terminology.
GET /v1/pipeline/{pipelineId}
gets the details of a single pipeline.POST /v1/pipeline/create
creates a new pipeline.POST /v1/pipeline/update/{pipelineId}
updates an existing pipeline.POST /v1/pipeline/process/{pipelineId}
processes a list of files by using a specified pipeline.POST /v1/pipeline/search/
searches for pipelines based on specified parameters.- (On deprecation track)
GET /v1/pipeline/list
paginates all pipeline details.
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
or2
).groupOperator
are comparators between groups at the same level (AND
orOR
).groups
are a list of trigger conditions that thegroupOperator
is applied to.status
indicates if a pipeline is active (null
) or not (disabled
).