SpiraPlan: ImportExport SOAP Web Service

Click here for a complete list of operations.

TestSet_Retrieve

Retrieves a list of testSets in the system that match the provided filter

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/TestSet_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>
    <TestSet_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>
      <startingRow>int</startingRow>
      <numberOfRows>int</numberOfRows>
    </TestSet_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>
    <TestSet_RetrieveResponse xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <TestSet_RetrieveResult>
        <RemoteTestSet>
          <TestSetId>int</TestSetId>
          <ProjectId>int</ProjectId>
          <TestSetStatusId>int</TestSetStatusId>
          <CreatorId>int</CreatorId>
          <OwnerId>int</OwnerId>
          <ReleaseId>int</ReleaseId>
          <Name>string</Name>
          <Description>string</Description>
          <CreationDate>dateTime</CreationDate>
          <LastUpdateDate>dateTime</LastUpdateDate>
          <PlannedDate>dateTime</PlannedDate>
          <ExecutionDate>dateTime</ExecutionDate>
          <Folder>boolean</Folder>
          <CountPassed>int</CountPassed>
          <CountFailed>int</CountFailed>
          <CountCaution>int</CountCaution>
          <CountBlocked>int</CountBlocked>
          <CountNotRun>int</CountNotRun>
          <CountNotApplicable>int</CountNotApplicable>
        </RemoteTestSet>
        <RemoteTestSet>
          <TestSetId>int</TestSetId>
          <ProjectId>int</ProjectId>
          <TestSetStatusId>int</TestSetStatusId>
          <CreatorId>int</CreatorId>
          <OwnerId>int</OwnerId>
          <ReleaseId>int</ReleaseId>
          <Name>string</Name>
          <Description>string</Description>
          <CreationDate>dateTime</CreationDate>
          <LastUpdateDate>dateTime</LastUpdateDate>
          <PlannedDate>dateTime</PlannedDate>
          <ExecutionDate>dateTime</ExecutionDate>
          <Folder>boolean</Folder>
          <CountPassed>int</CountPassed>
          <CountFailed>int</CountFailed>
          <CountCaution>int</CountCaution>
          <CountBlocked>int</CountBlocked>
          <CountNotRun>int</CountNotRun>
          <CountNotApplicable>int</CountNotApplicable>
        </RemoteTestSet>
      </TestSet_RetrieveResult>
    </TestSet_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>
    <TestSet_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>
      <startingRow>int</startingRow>
      <numberOfRows>int</numberOfRows>
    </TestSet_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>
    <TestSet_RetrieveResponse xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <TestSet_RetrieveResult>
        <RemoteTestSet>
          <TestSetId>int</TestSetId>
          <ProjectId>int</ProjectId>
          <TestSetStatusId>int</TestSetStatusId>
          <CreatorId>int</CreatorId>
          <OwnerId>int</OwnerId>
          <ReleaseId>int</ReleaseId>
          <Name>string</Name>
          <Description>string</Description>
          <CreationDate>dateTime</CreationDate>
          <LastUpdateDate>dateTime</LastUpdateDate>
          <PlannedDate>dateTime</PlannedDate>
          <ExecutionDate>dateTime</ExecutionDate>
          <Folder>boolean</Folder>
          <CountPassed>int</CountPassed>
          <CountFailed>int</CountFailed>
          <CountCaution>int</CountCaution>
          <CountBlocked>int</CountBlocked>
          <CountNotRun>int</CountNotRun>
          <CountNotApplicable>int</CountNotApplicable>
        </RemoteTestSet>
        <RemoteTestSet>
          <TestSetId>int</TestSetId>
          <ProjectId>int</ProjectId>
          <TestSetStatusId>int</TestSetStatusId>
          <CreatorId>int</CreatorId>
          <OwnerId>int</OwnerId>
          <ReleaseId>int</ReleaseId>
          <Name>string</Name>
          <Description>string</Description>
          <CreationDate>dateTime</CreationDate>
          <LastUpdateDate>dateTime</LastUpdateDate>
          <PlannedDate>dateTime</PlannedDate>
          <ExecutionDate>dateTime</ExecutionDate>
          <Folder>boolean</Folder>
          <CountPassed>int</CountPassed>
          <CountFailed>int</CountFailed>
          <CountCaution>int</CountCaution>
          <CountBlocked>int</CountBlocked>
          <CountNotRun>int</CountNotRun>
          <CountNotApplicable>int</CountNotApplicable>
        </RemoteTestSet>
      </TestSet_RetrieveResult>
    </TestSet_RetrieveResponse>
  </soap12:Body>
</soap12:Envelope>