Syndeia 3.7 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 Jupyter notebooks using the Python client of the Syndeia Cloud REST API. The notebooks demonstrate using Syndeia Cloud API to (1) connect, query, and fetch data from integrated repositories, e.g. Jira, Jama Connect, and Teamwork Cloud; and (2) build and query digital thread for a system where artifacts from multiple repositories are connected together. The Python client for the Syndeia Cloud API is available as a Conda package.

Version

The latest release of the Syndeia Cloud API Cookbook is 3.7 (2025-12). 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) and the release version of the cookbook.

Pre-requisites

JupyterLab is up and running in your environment (e.g. local machine). See here for details.
Syndeia Cloud 3.7 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.
Download the following from the Syndeia Downloads page that was provided to you in response to your license/download request on our helpdesk
1. Syndeia Cloud Python client
  1. syndeia_cloud_37x_client_sdk-3.7-py_0.tar.bz2
  2. syndeia_cloud_37x_client_sdk-3.7-py_0_docs.zip
2. Syndeia Cloud API Cookbook
  1. Syndeia_Cloud_3.7.0_API_Cookbook_2025-12.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 Notebooks directory, you will see the following Jupyter notebooks included with this release

API Cookbook Directory/File	Description

API Cookbook Directory/File	Description
General
`Hello_Syndeia_Cloud.ipynb`	This Notebook provides a gentle introduction to using the Syndeia Cloud API.
`Syndeia_Cloud_Dash_Analytics.ipynb`	This Notebook builds on the above notebook and provides examples of analytics.
Azure_DevOps
`Syndeia_Cloud_Azure_DevOps.ipynb`	This Notebook demonstrates the use of Syndeia Cloud API to fetch data from Azure DevOps repositories
`Syndeia_Cloud_Azure_DevOps_Artifact_Relation_CRUD.ipynb`	This Notebook demonstrates the use of Syndeia Cloud API to create and modify items in Azure DevOps repositories
Codebeamer
`Syndeia_Cloud_Codebeamer.ipynb`	This Notebook demonstrates the use of Syndeia Cloud API to fetch data from Codebeamer repositories
`Syndeia_Cloud_Codebeamer_Artifact_Relation_CRUD.ipynb`	This Notebook demonstrates the use of Syndeia Cloud API to create and modify items in Codebeamer repositories
DOORS-NG
`Syndeia_Cloud_DOORS-NG_Regular_Projects.ipynb`	This Notebook demonstrates the use of Syndeia Cloud API to fetch data from regular (non-CM enabled) projects in DOORS-NG
`Syndeia_Cloud_DOORS-NG_CM_Enabled_Projects.ipynb`	This Notebook demonstrates the use of Syndeia Cloud API to fetch data from CM-enabled projects in DOORS-NG
GENESYS
`Syndeia_Cloud_GENESYS.ipynb`	This Notebook demonstrates the use of Syndeia Cloud API to fetch data from GENESYS Repositories
Jama
`Syndeia_Cloud_Jama.ipynb`	This Notebook demonstrates the use of Syndeia Cloud API to fetch data from Jama Connect repositories
Jira
`Syndeia_Cloud_Jira.ipynb`	This Notebook demonstrates the use of Syndeia Cloud API to fetch data from Jira repositories
`Syndeia_Cloud_Jira_Artifact_Relation_CRUD.ipynb`	This Notebook demonstrates the use of Syndeia Cloud API to create and modify items in Jira repositories
Polarion
`Syndeia_Cloud_Polarion.ipynb`	This Notebook demonstrates the use of Syndeia Cloud API to fetch data from Polarion repositories
`Syndeia_Cloud_Polarion_Artifact_Relation_CRUD.ipynb`	This Notebook demonstrates the use of Syndeia Cloud API to create and modify items in Polarion repositories
SOLIDWORKS_PDM
`Syndeia_Cloud_SOLIDWORKS_PDM.ipynb`	This Notebook demonstrates the use of Syndeia Cloud API to fetch data from Solidworks PDM Pro repositories
Teamcenter
`Syndeia_Cloud_Teamcenter.ipynb`	This Notebook demonstrates the use of Syndeia Cloud API to fetch data from Teamcenter repositories
`Syndeia_Cloud_Teamcenter_Artifact_Relation_CRUD.ipynb`	This Notebook demonstrates the use of Syndeia Cloud API to create and modify items in Teamcenter repositories
Teamwork_Cloud
`Syndeia_Cloud_Teamwork_Cloud.ipynb`	This Notebook demonstrates the use of Syndeia Cloud API to fetch data from Teamwork Cloud repositories
TestRail
`Syndeia_Cloud_TestRail.ipynb`	This Notebook demonstrates the use of Syndeia Cloud API to fetch data from TestRail repositories
Windchill
`Syndeia_Cloud_Windchill.ipynb`	This Notebook demonstrates the use of Syndeia Cloud API to fetch data from Windchill repositories
`Syndeia_Cloud_Windchill_Artifact_Relation_CRUD.ipynb`	This Notebook demonstrates the use of Syndeia Cloud API to create and update items in Windchill repositories

(4) You may need to install several Data Science libraries into your chosen python Conda environment. We know that at least the following are likely. Install all reported missing imports, as needed.

conda install pandas
conda install plotly
conda install jinja2
conda install nbformat

(5) Open the Hello_Syndeia_Cloud.ipynb notebook in JupyterLab and run each cell.

Example

Figure 1 below shows a snippet from the General / Notebooks / Syndeia_Cloud_Dash_Analytics.ipynbJupyter (ipynb) notebook in the Syndeia Cloud API Cookbook. It shows a table of Jira issues linked to other artifacts (e.g. SysML, Teamcenter, Jama Connect, and other repos) in a Spacecraft Digital Thread Project. The color coding in based on the status of the Jira issues.

Figure 1 - Example of data display from Syndeia_Cloud_Dash_Analytics.ipynb