REST API Reference

Back Next

Creating a test suite

Use the following URI to create a test suite:

POST /datavalidation-service/api/v1/testsuite

Use the IDS-SESSION-ID header in the POST request.

POST request: Use the following fields in the POST request:

Field
Required?
Description

name
Yes
Name of the test suite.

description
No
Description of the test suite.

frsDocLocation
Yes
The location to save the test suite.
To save the test suite in a project, use the following syntax:

"{\"type\":\"Project\",\"id\":\"<project_ID>\",\"path\":\"<project_name>\"}",

To save the test suite in a folder, use the following syntax:

"{\"type\":\"Folder\",\"id\":\"<folder_ID>\",\"path\":\"<folder_name>\"}",

When you open a project, the numeric value that you see in the URL is the project ID. Similarly, when you open a folder, the numeric value that you see in the URL is the folder ID.

By default, the test suite is saved under the
Default
project.

testCases
Yes
For each test case that you want to include in the test suite, enter the following details:
testCaseId
. ID of the test case.
name
. Name of the test case.
folder
. Folder where the test case is saved.
project
. Project where the test case is saved.
POST request sample: The following snippet shows a POST request sample to create a test suite:
{ "name": "CDVTestSuite", "frsDocLocation": "{\"type\":\"Project\",\"id\":\"ifwKGemVFMOcWFKC9WvqU8\",\"path\":\"CDV\"}", "testCases": [ { "name": "TestReqFieldsWithoutVerboseMode", "folder": "", "project": "CDV", "testCaseId": "53201" }, { "name": "TestReqFieldsWithoutKeepDIAssetsTrimStringIgnoreCase", "folder": "", "project": "CDV", "testCaseId": "53203" } ] }
POST response: If the test suite was created successfully, the POST request returns a
200 Successful operation
response and returns the following response fields:

Field
Type
Description

id
String
ID of the test suite.

frsDocId
String
ID of the test suite in the Informatica repository.

testSuiteName
String
Name of the test suite.

If the test suite creation failed, the POST request returns a
500 Internal Server Error
response. It also returns the following response fields:

Field
Type
Description

code
String
Code of the error message.

message
String
Error message.

debugMessage
String
Message that can be used for debugging the issue.

details
String
Detailed information about the error message.

Field	Required?	Description
name	Yes	Name of the test suite.
description	No	Description of the test suite.
frsDocLocation	Yes	The location to save the test suite. To save the test suite in a project, use the following syntax: "{\"type\":\"Project\",\"id\":\"<project_ID>\",\"path\":\"<project_name>\"}", To save the test suite in a folder, use the following syntax: "{\"type\":\"Folder\",\"id\":\"<folder_ID>\",\"path\":\"<folder_name>\"}", When you open a project, the numeric value that you see in the URL is the project ID. Similarly, when you open a folder, the numeric value that you see in the URL is the folder ID. By default, the test suite is saved under the Default project.
testCases	Yes	For each test case that you want to include in the test suite, enter the following details: testCaseId . ID of the test case. name . Name of the test case. folder . Folder where the test case is saved. project . Project where the test case is saved.

Field	Type	Description
id	String	ID of the test suite.
frsDocId	String	ID of the test suite in the Informatica repository.
testSuiteName	String	Name of the test suite.

Field	Type	Description
code	String	Code of the error message.
message	String	Error message.
debugMessage	String	Message that can be used for debugging the issue.
details	String	Detailed information about the error message.

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

Creating a test suite

Creating a test suite