Pipelines Cookbook
Syndeia 3.7.1 offers an updated release of the Syndeia Cloud API Cookbook, a collection of demonstration examples and patterns for using the Syndeia Cloud REST API. The package includes a collection of Apache Airflow compatible Pipeline files using the Python client of the Syndeia Cloud REST API. The example Pipelines demonstrate
Using the Syndeia Cloud API to extract data from connected Repositories and construct reports
Using the Syndeia Cloud API to extract Artifacts from one connected Repository, transform the Artifacts, and create new related Artifacts in a different Repository
Version
The latest release of the Syndeia Cloud API Cookbook is 3.7.1 (2026-06). We release new versions of the API Cookbook on a regular basis. Each version includes new (and updates to existing) demonstrations and examples. The Syndeia Cloud API Cookbook package version indicates the Syndeia Cloud API version (3.7.1) and the release version of the cookbook.
Pre-requisites
Syndeia Cloud 3.7 (or 3.7.x) is up and running in your enterprise environment and accessible to you. You should be able to log in to Syndeia Cloud Web Dashboard with your username and password.
Syndeia Cloud 3.7 (or 3.7.x) is correctly configured with the Apache Airflow back end. You should be able to see the Pipelines page.
Download the following from the Syndeia Downloads page that was provided to you in response to your license/download request on our helpdesk
Syndeia Cloud API and Pipelines Cookbook
Syndeia_Cloud_3.7.1_API_and_Pipelines_Cookbook.zip
Review the Syndeia Cloud API Overview page in your Syndeia Cloud Web Dashboard. See here for details.
Review the Syndeia Cloud Swagger doc in your Syndeia Cloud Web Dashboard. See here for details.
Getting Started
(1) Install the Syndeia Cloud Python Client as described here.
(2) Unzip the Syndeia Cloud API Cookbook.
(3) Open the Pipelinesdirectory, you will see the following Pipeline files included with this release
Pipeline File | Description | Tags |
|---|---|---|
| This Pipeline demonstrates the use of the Syndeia Cloud API to extract a set of Tracker Items from a Codebeamer repository, construct a tabular report in Confluence, and send a notification using Slack. | Codebeamer, Confluence, Slack |
| This Pipeline demonstrates the use of the Syndeia Cloud API to extract a set of components from a GENESYS repository, create matching artifacts in Jama, and create Digital Thread Relations between the GENESYS artifacts and the newly-created Jama artifacts. | GENESYS, Jama |
| This Pipeline demonstrates the use of the Syndeia Cloud API to extract a set of components from a GENESYS repository, create matching parts in Windchill, and create Digital Thread Relations between GENESYS artifacts and the newly created Windchill artifacts. | GENESYS, Windchill |
| This Pipeline demonstrates the use of the Syndeia Cloud API to list all Repositories connected to Syndeia and log the results. | Syndeia |
| This Pipeline demonstrates the use of the Syndeia Cloud API to list all Repositories connected to Syndeia and present that data on a Slack message. | Syndeia, Slack |
| This Pipeline demonstrates the use of the Syndeia Cloud API to extract a requirement set from a Jama Connect repository, and query the Digital Thread to find connected TestRail test cases. The Pipeline then retrieves the latest test Runs for each Test Case and creates a report of test coverage and testing status. | Jama, TestRail, Confluence, Slack |
| This Pipeline demonstrates the use of the Syndeia Cloud API to extract a requirement specification from a Jama Connect repository and do the following:
| Jama, Codebeamer, Confluence, Slack |
| This Pipeline demonstrates the use of the Syndeia Cloud API to extract a requirement specification from a Jama Connect repository, create new Tasks in Jira for each requirement, and creates Digital Thread Relations between the source Jama artifacts and the newly created Jira artifacts. | Jama, Jira |
| This Pipeline demonstrates the use of the Syndeia Cloud API to extract a requirement specification from a Jama Connect repository and do the following:
| Jama, Jira, Confluence, Slack |
| This Pipeline demonstrates the use of the Syndeia Cloud API to extract a requirement specification from a Jama Connect repository, create new requirements in Teamcenter, and create Digital Thread Relations between the source Jama artifacts and the newly created Teamcenter artifacts. | Jama, Teamcenter |
| This Pipeline demonstrates the use of the Syndeia Cloud API to extract a part item structure from a Jama Connect repository, create new parts in Windchill, and create Digital Thread Relations between the source Jama artifacts and the newly created Windchill artifacts. | Jama, Windchill |
| This Pipeline demonstrates the use of the Syndeia Cloud API to extract a part structure from a Jama Connect Repository, extract a part structure from a Windchill repository, and weave the Digital Thread by matching Jama artifacts to Windchill artifacts. | Jama, Windchill |
| This Pipeline demonstrates the use of the Syndeia Cloud API to run JQL queries on a Jira project, generate a Confluence report with a table showing the results of the JQL queries, and send a Slack notification with a link to the Confluence report. | Jira, Confluence, Slack |
| This Pipeline demonstrates the use of the Syndeia Cloud API to extract all issues in a particular project within a Jira repository, query their Relations in the Digital Thread to determine which Relations might be outdated, construct a tabular report in Confluence, and send a Slack notification with a link to the Confluence report. | Jira, Confluence, Slack |
| This Pipeline demonstrates the use of the Syndeia Cloud API to extract a set of requirements from a Polarion repository, construct a tabular report in Confluence, and send a Slack notification with a link to the Confluence report. | Polarion, Confluence, Slack |
| This Pipeline demonstrates the use of the Syndeia Cloud API to extract a parts structure from a SOLIDWORKS PDM repository, construct a tabular report in Confluence, and send a Slack notification with a link to the Confluence report. | Solidworks, Confluence, Slack |
| This Pipeline demonstrates the use of the Syndeia Cloud API to extract a parts structure from a SysMLv2 repository, construct a tabular report in Confluence, and send a Slack notification with a link to the Confluence report. | SysMLv2, Confluence, Slack |
| This Pipeline demonstrates the use of the Syndeia Cloud API to extract a parts structure from a SysMLv2 repository and create a corresponding parts structure in a Jama repository. | SysMLv2, Jama |
| This Pipeline demonstrates the use of the Syndeia Cloud API to extract a parts structure from a SysMLv2 repository and create a corresponding parts structure in a Windchill repository. | SysMLv2, Windchill |
| This Pipeline demonstrates the use of the Syndeia Cloud API to extract a Block structure from a Teamwork Cloud repository and do the following:
| Teamwork Cloud, Jira, Confluence, Slack |
| This Pipeline demonstrates the use of the Syndeia Cloud API to extract a Requirements structure from a Teamwork Cloud Repository, create Jama Requirements based on the Teamwork Cloud Requirements, and create Digital Thread Relations between the Teamwork Cloud Requirements and the newly-created Jama artifacts. A Slack notification message is sent with a link to the Jama requirement set. | Teamwork Cloud, Jama |
| This Pipeline demonstrates the use of the Syndeia Cloud API to extract a Requirement structure from a Teamwork Cloud repository and do the following:
| Teamwork Cloud, Jira |
| This Pipeline demonstrates the use of the Syndeia Cloud API to extract a parts structure from a SysML project in Teamwork Cloud repository, construct a tabular report in Confluence, and send a Slack notification with a link to the Confluence report. | Teamwork Cloud, Confluence, Slack |
| This Pipeline demonstrates the use of the Syndeia Cloud API to extract a requirements specification from a SysML project in Teamwork Cloud repository, create new Tasks in Jira, and create Digital Thread Relations between the source SysML requirement artifacts and the newly created Jira artifacts. | Teamwork Cloud, Jira |
| This Pipeline demonstrates the use of the Syndeia Cloud API to extract a system structure from a SysML project in Teamwork Cloud repository, create new items and BOM structure in Teamcenter, and create Digital Thread Relations between the source SysML artifacts and the newly created Teamcenter artifacts. | Teamwork Cloud, Teamcenter |
| This Pipeline demonstrates the use of the Syndiea Cloud API to extract a Block structure from a Teamwork Cloud repository, extract a part structure from a Teamcenter repository, and matching Teamwork Cloud artifacts to Teamcenter artifacts. A report is created in Confluence listing each possible match, and a link is sent via Slack for human approval of the matches. If the matches are approved, Digital Thread relations are created between the Teamwork Cloud and Teamcenter artifacts. | Teamwork Cloud, Teamcenter, Slack |
| This Pipeline demonstrates the use of the Syndeia Cloud API to extract a Block structure from a Teamwork Cloud repository and do the following:
| Teamwork Cloud, Teamcenter, |
| This Pipeline demonstrates using Python code to determine what versions of the Syndeia Cloud Python Client and Apache Airflow are currently installed. It is a useful utility Pipeline for confirming correct installation. | Utility, Slack |