REST API Reference

Back Next

Viewing a test suite

Use the following URI to view a test suite:

GET /datavalidation-service/api/v1/testsuite/{testSuiteId}

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

GET request: Use the test suite ID to view a test suite.

When you open a test suite, the numeric value that you see in the URI is the test suite ID. For example, in the following image, the test suite ID is
1063
:
GET response: If the test suite ID was found, the GET request returns a
200 Successful operation
response and returns the following response fields:

Field
Type
Description

name
String
Name of the test suite.

description
String
Description of the test suite.

frsDocLocation
String
Location where the test suite is saved.

testCases
Array
For each test case within the test suite, you see 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.

testSuiteId
String
ID of the test suite.

orgId
String
ID of the organization that contains the test suite.

createDateTime
String
Date and time when the test suite was created.

updateDateTime
String
Date and time when the test suite was last updated.

If the test suite creation failed, the GET 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	Type	Description
name	String	Name of the test suite.
description	String	Description of the test suite.
frsDocLocation	String	Location where the test suite is saved.
testCases	Array	For each test case within the test suite, you see 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.
testSuiteId	String	ID of the test suite.
orgId	String	ID of the organization that contains the test suite.
createDateTime	String	Date and time when the test suite was created.
updateDateTime	String	Date and time when the test suite was last updated.

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.