REST API Reference

Back Next

TDM REST API Overview

You can use the Test Data Management REST API to perform Test Data Manager, test data warehouse, and self-service portal tasks.

You can use the following types of HTTP methods:

Method	Description
GET	Use the GET method to retrieve information as identified by the Uniform Resource Identifier (URI) request. GET methods use a request header, body with optional query filters. Responses include a response header and a response body.
POST	Use the POST method to run jobs. POST methods use a request header and a request body. Responses include a response header and a response body.
PATCH	Use the PATCH method to add, update, remove, or make partial updates to an existing resource.
DELETE	Use the DELETE method to delete a resource identified in the request URL.

You cannot use Test Data Management REST APIs in a Kerberos environment.

You can use the Test Data Management REST API to perform the following tasks in Test Data Management:

Projects: You can search for projects. You can assign and unassign rules on ports and export and import data domain assignments. You can import metadata from a Test Data Manager connection or a PowerCenter repository folder.
Connections: You can create, delete, or import a connection into Test Data Manager. You can view a list of connections. You can view schema and sources in a connection.
Plans: You can search for plans based on projects and plan IDs.
Test Data Manager Jobs: You can search for jobs based on job ID and generate and run jobs. You can create and run workflows.

You can use the test data warehouse REST API to perform the following test data warehouse tasks:

Test data warehouse Jobs: You can run data set reset and restore jobs and view the status and information of jobs based on job IDs.
Data sets: You can view a list of all data sets and all versions of a data set.

You can use the self-service portal REST API to perform the following tasks in the self-service portal:

Data packs: You can view a list of all data packs. You can also export the data in a data pack as a CSV file.
Self-service portal Jobs: You can search for and view the status of jobs and run jobs to reset and restore a data pack.

Watch

Comments