This functionality is provided by the automated testing bridge that allows obtaining TestComplete test results to the QAComplete Automation screen. Starting from the release 9.9.0, this functionality is obsolete and is supported only for backward compatibility. |
Adds a new host to your project and returns the ID of the added host.
Requirements
The user must belong to a security group that has the Add privilege for Automation Hosts.
Parameters
The operation uses the following parameters:
AuthenticationData : AuthenticationData, required
An AuthenticationData
object containing the login information and the ID of the project to which you want to add a new host.
AutomationHost : AutomationHost, required
An AutomationHost
object that describes the host you want to register in your project.
Result
The ID of the added host.
Remarks
The AutomationHost
object you pass to the method must have the HostName
property specified.
Example
Sample Code
C#
string login = "[email protected]";
string password = "p@ssword";
ServiceSoapClient service = new ServiceSoapClient();
// Prepare AuthenticationData
LoginInfo loginInfo = service.GetLoginInfo("", login, password);
AuthenticationData authData = new AuthenticationData();
authData.AppCode = loginInfo.AppCode;
authData.UserId = loginInfo.UserId;
authData.PassCode = password;
authData.DeptId = loginInfo.DeptId;
authData.ProjId = loginInfo.ProjId;
// Prepare the AutomationHost object
AutomationHost host = new AutomationHost();
host.HostName = "Test-WinXPx86";
// Add the host
int hostId = service.AutomationHosts_Add(authData, host);
Java
String login = "[email protected]";
String password = "p@ssword";
ServiceSoap service = new Service().getServiceSoap12();
// Prepare AuthenticationData
LoginInfo loginInfo = service.getLoginInfo("", login, password);
AuthenticationData authData = new AuthenticationData();
authData.setAppCode(loginInfo.getAppCode());
authData.setUserId(loginInfo.getUserId());
authData.setPassCode(password);
authData.setDeptId(loginInfo.getDeptId());
authData.setProjId(loginInfo.getProjId());
// Prepare the AutomationHost object
AutomationHost host = new AutomationHost();
host.setHostName("Test-WinXPx86");
// Add the host
int hostId = service.automationHostsAdd(authData, host);
Sample Request XML
POST /psws/psws.asmx HTTP/1.1
Host: myteam.mysite.com
Content-Type: text/xml; charset=utf-8
Content-Length: 738 {Insert an appropriate value here}
SOAPAction: "http://www.pragmaticsw.com/AutomationHosts_Add"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<AutomationHosts_Add xmlns="http://www.pragmaticsw.com/">
<AuthenticationData>
<AppCode>agSP</AppCode>
<DeptId>8162</DeptId>
<ProjId>11873</ProjId>
<UserId>24661</UserId>
<PassCode>p@ssword</PassCode>
</AuthenticationData>
<AutomationHost>
<AutomaticHostId>0</AutomaticHostId>
<HostName>Test-WinXPx86</HostName>
<CreateUserId>0</CreateUserId>
<UpdateUserId>0</UpdateUserId>
<DateCreated>0001-01-01T00:00:00</DateCreated>
<DateUpdated>0001-01-01T00:00:00</DateUpdated>
</AutomationHost>
</AutomationHosts_Add>
</soap:Body>
</soap:Envelope>
SOAP 1.2
POST /psws/psws.asmx HTTP/1.1
Host: myteam.mysite.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: 746 {Insert an appropriate value here}
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<AutomationHosts_Add xmlns="http://www.pragmaticsw.com/">
<AuthenticationData>
<AppCode>agSP</AppCode>
<DeptId>8162</DeptId>
<ProjId>11873</ProjId>
<UserId>24661</UserId>
<PassCode>p@ssword</PassCode>
</AuthenticationData>
<AutomationHost>
<AutomaticHostId>0</AutomaticHostId>
<HostName>Test-WinXPx86</HostName>
<CreateUserId>0</CreateUserId>
<UpdateUserId>0</UpdateUserId>
<DateCreated>0001-01-01T00:00:00</DateCreated>
<DateUpdated>0001-01-01T00:00:00</DateUpdated>
</AutomationHost>
</AutomationHosts_Add>
</soap12:Body>
</soap12:Envelope>
Sample Response XML
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: 397 {The server returns an appropriate value here}
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<AutomationHosts_AddResponse xmlns="http://www.pragmaticsw.com/">
<AutomationHosts_AddResult>1</AutomationHosts_AddResult>
</AutomationHosts_AddResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: 407 {The server returns an appropriate value here}
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<AutomationHosts_AddResponse xmlns="http://www.pragmaticsw.com/">
<AutomationHosts_AddResult>1</AutomationHosts_AddResult>
</AutomationHosts_AddResponse>
</soap12:Body>
</soap12:Envelope>
See Also
Automation Hosts Operations
AutomationHosts_Delete
AutomationHosts_Load
AutomationHosts_LoadByCriteria
AutomationHosts_Update
Automated Testing Bridge Operations
SOAP API Reference