Displaying the Details of the Tests

Use this API to display the details of a test pertaining to a chosen Component Type.

URL: http://<eG manager IP:port>/api/eg/orchestration/showtestsdetails

Method: POST

Content-Type: application/json

Inputs to be Specified
Parameters Key values Example

Headers

managerurl: Base URL of the eG Manager i.e., http://<IP address of the eG console:Port>

user: eG username or domain/eG username

pwd: Base64 encoded password

Example with Optional Key values:

{

"componenttype": "Citrix NetScaler VPX/MPX",

"componentname": "Netscaler176:NULL",

"testtype": "Performance",

"testname": "Application Flows"

}

Body

Optional:

{

"componenttype":"Component type",

"componentname":"Component name",

"testtype":"Performance / Configuration",

"testname":"Test name"

}

 

Success Response
Type Code Content

JSON

200

[

{

"componentType": "Citrix NetScaler VPX/MPX",

"componentName": "Netscaler176:NULL",

"testType": {

"performance": [

{

"testName": "Application Flows",

"details": {

"TESTPERIOD": "5 mins",

"HOST": "192.168.10.176",

"NETSCALER USERNAME": "$unconfigured",

"NETSCALER PASSWORD": "$unconfigured",

"SSL": "No",

"AGENTLESS": "y",

"OS": "win7",

"SSHPORT": "22"

}

}

],

"configuration": []

}

}

]

 

Failure Response
Type Code Content

JSON

401 UNAUTHORIZED

{

"Error": "The test is not available for this component type."

}

Figure 1 : Displaying the details of a test using Postman REST Client

Displaying the Details of the Tests using cURL

To display the details of a test through the REST API using cURL, the command should be specified in the following format:

curl --location --request POST "http://<eG Manager IP:Port>/api/eg/orchestration/showtestsdetails" -H "managerurl:http://<eG Manager IP:Port>" -H "user:<eG username or domain/eG username>" -H "pwd:Base64 encoded password" -H "Content-Type: application/json" --data-raw "{'componenttype':'Component type', 'componentname':'Component name', 'testtype':'Performance / Configuration', 'testname':'Test name'}"

Note that the command specified above contains both the Default and Optional key values. Figure 2 shows an example of displaying the details of a test using cURL.

Figure 2 : Displaying the details of a test using cURL