search cancel

TDM examples on how to execute an existing Portal Generator

book

Article ID: 239493

calendar_today

Updated On:

Products

CA Test Data Manager (Data Finder / Grid Tools)

Issue/Introduction

We are having a hard time figuring out how to make Test Data Manager API calls.
We need to be able to do the following process

  • Login
  • Get a list of projects and versions
  • Get a list of generators
  • execute the generator
  • check the status of the generator 
  • download the zip file of the generator.

Can you please provide an example of the above use case with Postman?

Cause

In the example provided, we will provide examples of the following calls

  • login and get a bearer token
  • get a list of Project ID
  • get a list of version  ID within the project
  • get a list of generators in the version
  • get a configuration for the generator
  • Publish a generator to CSV 
  • Publish a generator to a database 
  • Check the status of the job
  • get a list of published jobs
  • Download the zip file from a completed job

Environment

TDM 4.9.1.X 4.10.X
TDM Web Portal
Test Data Manager

Resolution

Please install PostMan on a machine that has direct access to the TDM Portal.  
review and walk through the below examples in the documentation

Use APIs to Manage Test Data Models (broadcom.com)

 

Attached is a Zip file with a PostMan Collection JSON file that can be imported to a current version of Postman.
You will need to change the variables in the Collection variables to match your existing environment for the URL and ID information.

 

Additional Information

https://www.postman.com/

Webex recording with a detailed explanation of calls included in the example is attached

Additional explanation on some of the variables used in the samples:

ProjectID - Not displayed in the Web UI at all
- the call I provided Get the Project ID will give you  a list of all projects in the system

ProjectVersionID - Not displayed in the Web UI at all
- the call I provided Get the Version ID will give you  a list of all projects in the system

GeneratorIDCSV - this is just the generator ID that can be seen in the Web UI on the Generator listing screen

The call to get this is Get Test Data Generator for the Identified Project and Version

ConfigID - Not displayed in the Web UI at all
- the call I provided Get ALL configurations for a generator CSV will give you  a list of all projects in the system

JobID - Can be on the submitted request page. In this use case, you would have to go to the generator section

 

GeneratorPublishNameCSV - this is the name of the publishing job. it can be anything you want. it ends up being displayed on the submitted requests page. In the Web UI, this is created automatically by the application.

 

Attachments

TDM_examples_KB_239493_1650028903870.zip get_app
1649940782236__TDM_API Exmple_Data Generator.zip get_app