/
API Cookbook

API Cookbook

Syndeia 3.6 SP2 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.6.2 (2025-05). 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.6.2) and the release version of the cookbook.

Pre-requisites

  1. JupyterLab is up and running in your environment (e.g. local machine). See here for details.

  2. Syndeia Cloud 3.6 SP2 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.

  3. 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_36x_client_sdk-3.6.2-py_0.tar.bz2

      2. syndeia_cloud_36x_client_sdk-3.6.2-py_0_docs.zip

    2. Syndeia Cloud API Cookbook

      1. Syndeia_Cloud_3.6.2_API_Cookbook_2025-05-05.zip

  4. Review the Syndeia Cloud API Overview page in your Syndeia Cloud Web Dashboard. See here for details.

  5. 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. You will see the following Jupyter notebooks included with this release

    1. The General folder includes 2 notebooks:

      1. Hello_Syndeia_Cloud_3.6 provides a gentle introduction to using the Syndeia Cloud API.

      2. Syndeia_Cloud_3.6_Dash_Analytics builds on the above notebook and provides examples of analytics

    2. The Repositories folder includes notebooks demonstrating the tool/repository integrations in Syndeia Cloud

      1. Syndeia_Cloud_3.6_DOORS-NG_Regular_Projects demonstrates the use of Syndeia Cloud API to fetch data from regular (non-CM enabled) projects in DOORS NG

      2. Syndeia_Cloud_3.6_DOORS-NG_CM_Enabled_Projects demonstrates the use of Syndeia Cloud API to fetch data from CM-enabled projects in DOORS NG

      3. Syndeia_Cloud_3.6_Jama demonstrates the use of Syndeia Cloud API to fetch data from Jama Connect repositories

      4. Syndeia_Cloud_3.6_JIRA demonstrates the use of Syndeia Cloud API to fetch data from Jira repositories

      5. Syndeia_Cloud_3.6_Teamcenter.ipynb demonstrates the use of Syndeia Cloud API to fetch data from Teamcenter repositories

      6. Syndeia_Cloud_3.6_TestRail demonstrates the use of Syndeia Cloud API to fetch data from TestRail repositories

      7. Syndeia_Cloud_3.6_TWC demonstrates the use of Syndeia Cloud API to fetch data from Teamwork Cloud repositories

      8. Syndeia_Cloud_3.6_Windchill demonstrates the use of Syndeia Cloud API to fetch data from Windchill repositories

  3. 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

  1. Open the Hello_Syndeia_Cloud_3.6 notebook in JupyterLab and run each cell.

Example

The screenshot below shows a snippet from the General / Syndeia_Cloud_3.6_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.

image-20241021-210030.png