StarterTemplate ASP.NET Host

<back to all web services

RequestHostByIdV2

TestHost Service

The following routes are available for this service:
GET/service/automation/v2/hosts/{HostId}Returns a test host by its IDThe authenticating user must have Read access to Test Hosts. The specified test host must exist.
Parameters:
NameParameterData TypeRequiredDescription
HostIdpathintYesThe ID of the host computer

To override the Content-type in your clients HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/RequestHostByIdV2 HTTP/1.1 
Host: rest.qacomplete.smartbear.com 
Content-Type: application/xml
Content-Length: length

<RequestHostByIdV2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.AutomationService.DTO.V2.TestHost">
  <HostId xmlns="http://schemas.datacontract.org/2004/07/SwpStack.AutomationService.DTO.Common.TestHost">0</HostId>
</RequestHostByIdV2>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseSingleHost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.AutomationService.DTO.Common.TestHost">
  <AgentVersion>String</AgentVersion>
  <Agents xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Agents>
  <HostConfiguration>String</HostConfiguration>
  <HostName>String</HostName>
  <Id>0</Id>
  <IsActive>false</IsActive>
  <OS>String</OS>
  <SecurityToken>String</SecurityToken>
</ResponseSingleHost>