SpiraPlan: ImportExport SOAP Web Service


Click here for a complete list of operations.

TestRun_Retrieve

Retrieves a list of test runs in the system that match the provided filter/sort

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /Spira/Services/v2_2/ImportExport.asmx HTTP/1.1
Host: api.inflectra.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.inflectra.com/SpiraTest/Services/v2.2/TestRun_Retrieve"

<?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>
    <TestRun_Retrieve xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <remoteFilters>
        <RemoteFilter>
          <PropertyName>string</PropertyName>
          <IntValue>int</IntValue>
          <StringValue>string</StringValue>
          <MultiValue>
            <Values xsi:nil="true" />
            <IsNone>boolean</IsNone>
          </MultiValue>
          <DateRangeValue>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <ConsiderTimes>boolean</ConsiderTimes>
          </DateRangeValue>
        </RemoteFilter>
        <RemoteFilter>
          <PropertyName>string</PropertyName>
          <IntValue>int</IntValue>
          <StringValue>string</StringValue>
          <MultiValue>
            <Values xsi:nil="true" />
            <IsNone>boolean</IsNone>
          </MultiValue>
          <DateRangeValue>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <ConsiderTimes>boolean</ConsiderTimes>
          </DateRangeValue>
        </RemoteFilter>
      </remoteFilters>
      <remoteSort>
        <PropertyName>string</PropertyName>
        <SortAscending>boolean</SortAscending>
      </remoteSort>
      <startingRow>int</startingRow>
      <numberOfRows>int</numberOfRows>
    </TestRun_Retrieve>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?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>
    <TestRun_RetrieveResponse xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <TestRun_RetrieveResult>
        <RemoteTestRun>
          <TestRunId>int</TestRunId>
          <Name>string</Name>
          <TestCaseId>int</TestCaseId>
          <TestRunTypeId>int</TestRunTypeId>
          <TesterId>int</TesterId>
          <ExecutionStatusId>int</ExecutionStatusId>
          <ReleaseId>int</ReleaseId>
          <TestSetId>int</TestSetId>
          <StartDate>dateTime</StartDate>
          <EndDate>dateTime</EndDate>
          <RunnerName>string</RunnerName>
          <RunnerTestName>string</RunnerTestName>
          <RunnerAssertCount>int</RunnerAssertCount>
          <RunnerMessage>string</RunnerMessage>
          <RunnerStackTrace>string</RunnerStackTrace>
          <TestRunSteps>
            <RemoteTestRunStep xsi:nil="true" />
            <RemoteTestRunStep xsi:nil="true" />
          </TestRunSteps>
        </RemoteTestRun>
        <RemoteTestRun>
          <TestRunId>int</TestRunId>
          <Name>string</Name>
          <TestCaseId>int</TestCaseId>
          <TestRunTypeId>int</TestRunTypeId>
          <TesterId>int</TesterId>
          <ExecutionStatusId>int</ExecutionStatusId>
          <ReleaseId>int</ReleaseId>
          <TestSetId>int</TestSetId>
          <StartDate>dateTime</StartDate>
          <EndDate>dateTime</EndDate>
          <RunnerName>string</RunnerName>
          <RunnerTestName>string</RunnerTestName>
          <RunnerAssertCount>int</RunnerAssertCount>
          <RunnerMessage>string</RunnerMessage>
          <RunnerStackTrace>string</RunnerStackTrace>
          <TestRunSteps>
            <RemoteTestRunStep xsi:nil="true" />
            <RemoteTestRunStep xsi:nil="true" />
          </TestRunSteps>
        </RemoteTestRun>
      </TestRun_RetrieveResult>
    </TestRun_RetrieveResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /Spira/Services/v2_2/ImportExport.asmx HTTP/1.1
Host: api.inflectra.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?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>
    <TestRun_Retrieve xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <remoteFilters>
        <RemoteFilter>
          <PropertyName>string</PropertyName>
          <IntValue>int</IntValue>
          <StringValue>string</StringValue>
          <MultiValue>
            <Values xsi:nil="true" />
            <IsNone>boolean</IsNone>
          </MultiValue>
          <DateRangeValue>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <ConsiderTimes>boolean</ConsiderTimes>
          </DateRangeValue>
        </RemoteFilter>
        <RemoteFilter>
          <PropertyName>string</PropertyName>
          <IntValue>int</IntValue>
          <StringValue>string</StringValue>
          <MultiValue>
            <Values xsi:nil="true" />
            <IsNone>boolean</IsNone>
          </MultiValue>
          <DateRangeValue>
            <StartDate>dateTime</StartDate>
            <EndDate>dateTime</EndDate>
            <ConsiderTimes>boolean</ConsiderTimes>
          </DateRangeValue>
        </RemoteFilter>
      </remoteFilters>
      <remoteSort>
        <PropertyName>string</PropertyName>
        <SortAscending>boolean</SortAscending>
      </remoteSort>
      <startingRow>int</startingRow>
      <numberOfRows>int</numberOfRows>
    </TestRun_Retrieve>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?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>
    <TestRun_RetrieveResponse xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <TestRun_RetrieveResult>
        <RemoteTestRun>
          <TestRunId>int</TestRunId>
          <Name>string</Name>
          <TestCaseId>int</TestCaseId>
          <TestRunTypeId>int</TestRunTypeId>
          <TesterId>int</TesterId>
          <ExecutionStatusId>int</ExecutionStatusId>
          <ReleaseId>int</ReleaseId>
          <TestSetId>int</TestSetId>
          <StartDate>dateTime</StartDate>
          <EndDate>dateTime</EndDate>
          <RunnerName>string</RunnerName>
          <RunnerTestName>string</RunnerTestName>
          <RunnerAssertCount>int</RunnerAssertCount>
          <RunnerMessage>string</RunnerMessage>
          <RunnerStackTrace>string</RunnerStackTrace>
          <TestRunSteps>
            <RemoteTestRunStep xsi:nil="true" />
            <RemoteTestRunStep xsi:nil="true" />
          </TestRunSteps>
        </RemoteTestRun>
        <RemoteTestRun>
          <TestRunId>int</TestRunId>
          <Name>string</Name>
          <TestCaseId>int</TestCaseId>
          <TestRunTypeId>int</TestRunTypeId>
          <TesterId>int</TesterId>
          <ExecutionStatusId>int</ExecutionStatusId>
          <ReleaseId>int</ReleaseId>
          <TestSetId>int</TestSetId>
          <StartDate>dateTime</StartDate>
          <EndDate>dateTime</EndDate>
          <RunnerName>string</RunnerName>
          <RunnerTestName>string</RunnerTestName>
          <RunnerAssertCount>int</RunnerAssertCount>
          <RunnerMessage>string</RunnerMessage>
          <RunnerStackTrace>string</RunnerStackTrace>
          <TestRunSteps>
            <RemoteTestRunStep xsi:nil="true" />
            <RemoteTestRunStep xsi:nil="true" />
          </TestRunSteps>
        </RemoteTestRun>
      </TestRun_RetrieveResult>
    </TestRun_RetrieveResponse>
  </soap12:Body>
</soap12:Envelope>