StarterTemplate ASP.NET Host

<back to all web services

RequestAutomationsAll

Automation Service

The following routes are available for this service:
GET/service/api/v2/projects/{ProjectId}/tests/{TestId}/automationsReturns the list of automations in a testThe authenticating user must have the Read privilege for Test Library.
Parameters:
NameParameterData TypeRequiredDescription
ProjectIdpathintYesThe ID of the project that contains the automated test
TestIdpathintYesThe ID of the test that contains automations
OffsetqueryintNoThe number of automations to skip before counting the returned automations
LimitqueryintNoThe maximum number of automations to return
FilterquerystringNoThe filter expression to apply to the list of automations

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/RequestAutomationsAll HTTP/1.1 
Host: rest.qacomplete.smartbear.com 
Content-Type: application/xml
Content-Length: length

<RequestAutomationsAll xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Automations">
  <Filter>String</Filter>
  <Limit>0</Limit>
  <Offset>0</Offset>
  <ProjectId>0</ProjectId>
  <TestId>0</TestId>
</RequestAutomationsAll>

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

<ResponseAutomationCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Automations">
  <Metadata i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Common" />
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Automations" xmlns="http://schemas.datacontract.org/2004/07/SwpStack.Service.Entity.Common">
    <d2p1:ResponseAutomationSingle>
      <d2p1:Agent>String</d2p1:Agent>
      <d2p1:Params xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
      <d2p1:RunMode>0</d2p1:RunMode>
      <d2p1:Timeout>0</d2p1:Timeout>
      <d2p1:Title>String</d2p1:Title>
    </d2p1:ResponseAutomationSingle>
  </Results>
</ResponseAutomationCollection>