REST API Reference

Back Next

Viewing a summary report for a test case run

Use the following URI to download a summary report for a test case run:

GET /datavalidation-service/api/v1/report/summary/testcase/{testCaseId}/run/{testCaseRunId}

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

GET request: Use the test case ID and the test case run ID to download a summary report for a test case run.

When you open a test case, the numeric value that you see in the URI is the test case ID. For example, in the following image, the test case ID is
41846
:

When you open the report of a test case, the numeric value that you see in the URI after the
testCaseRunID
parameter is the test case run ID. For example, in the following image, the test case run ID is
25961
:
GET response: If the test case ID and test case run ID were found, the GET request returns the following response fields:

Field
Type
Description

testCaseRunId
String
Run ID of the test case.

testCaseId
String
ID of the test case.

rightConnWhereClause
String
WHERE clause used in the second connection.

leftConnWhereClause
String
WHERE clause used in the first connection.

finishDateTime
String
Date and time when the report was generated.

duration
String
Time taken for the report generation in milliseconds.

summary_report
String
You see the following details:
Name of the test case
Total number of records processed
Total number of records processed in the first connection
Total number of records processed in the second connection
Total number of missing records in the second table
ID of the test case
Total number of matched records
Matching result
Row count comparison result
Total number of unmatched records
Total number of extra records in the second table
Column matching status
Date when the test case was run
Date when the report was generated

columns
Array
You see the column mapping along with the column name, type, scale, precision, and details of the aggregation functions used.

functions_compared
String
Aggregation functions used for comparison.

total_comparisons
String
Total number of comparisons made.

total_failed_matches
String
Total number of failed matches.

connection_info
String
Connection name and table name of the first connection and second connection.

sampling
String
Sampling type and value.; If the test case ID or test case run ID was incorrect, the GET request returns a
500 Internal Server
response.

The GET request 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
testCaseRunId	String	Run ID of the test case.
testCaseId	String	ID of the test case.
rightConnWhereClause	String	WHERE clause used in the second connection.
leftConnWhereClause	String	WHERE clause used in the first connection.
finishDateTime	String	Date and time when the report was generated.
duration	String	Time taken for the report generation in milliseconds.
summary_report	String	You see the following details: Name of the test case Total number of records processed Total number of records processed in the first connection Total number of records processed in the second connection Total number of missing records in the second table ID of the test case Total number of matched records Matching result Row count comparison result Total number of unmatched records Total number of extra records in the second table Column matching status Date when the test case was run Date when the report was generated
columns	Array	You see the column mapping along with the column name, type, scale, precision, and details of the aggregation functions used.
functions_compared	String	Aggregation functions used for comparison.
total_comparisons	String	Total number of comparisons made.
total_failed_matches	String	Total number of failed matches.
connection_info	String	Connection name and table name of the first connection and second connection.
sampling	String	Sampling type and value.

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

Viewing a summary report for a test case run

Viewing a summary report for a test case run