Skip to main content
Version: 2023.3

Get Test Execution Services

Description

Gets all registered Test Execution Services, including each server's details (server id, address, test type, capacity, etc.).

URL

http://{Job Scheduling API IP}:{port#}/api/ExecutionServer

HTTP method

GET

Request

Headers

Example header format:

Authorization: Basic <authorization token returned from the login method>

Content-Type: application/json

Response

Response example
[
{
"id": "94f4ab95-5c58-46b1-adce-fab88f9196e4",
"name": "My TES1",
"testTypeId": "59aabbe8-dc0b-48c4-81af-d76f915b47b1",
"testTypeName": "Robot",
"address": "http://test-exec-srv.test-exec-srv-2.default.svc.cluster.local:8250",
"capacity": 200,
"description": "Cloudshell Execution Service for running Robot tests",
"runningJobsCount": 0,
"leasedJobsCount": 0,
"isOnline": true,
"isIncluded": true,
"excludedByUsername": null,
"excludedByName": null,
"excludeReason": null,
"spaces": []
},
]
Response summary
ParameterDescription/Comments
idTest Execution Service id. (guid)
nameTest Execution Service name. (string)
testTypeIdId of the test type. (guid)
testTypeNameTest Execution Service supported test type. (string)
For example, Robot.
addressTest Execution Service address. (string)
capacityMaximum supported number of concurrent job executions. (numeric)
descriptionTest Execution Service description, if defined. (string)
runningJobsCountNumber of jobs currently running on the Test Execution Service.
Note that the sum total of the leasedJobsCount and runningJobsCount cannot exceed the defined capacity. (numeric)
leasedJobsCountJob slots allocated to a suite execution while the job’s sandbox is being created. (numeric)
Note that the sum total of the leasedJobsCount and runningJobsCount cannot exceed the defined capacity.
isOnlineWhether the Test Execution Service is currently online. (bool)
isIncludedWhether the Test Execution Service is currently included. (bool)
excludedByUsername(Applies only if the Test Execution Service is currently excluded) CloudShell username who excluded the Test Execution Service. (string)
excludedByName(Applies only if the Test Execution Service is currently excluded) First and last name of the CloudShell user who excluded the Test Execution Service. (string)
excludeReason(Applies only if the Test Execution Service is currently excluded) Reason provided for excluding the Test Execution Service. (string)
spacesDomains in which this Test Execution Service is used. (string)