SpiraPlan: ImportExport SOAP Web Service


Click here for a complete list of operations.

Release_RetrieveById

Retrieves a single release in the system

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/Release_RetrieveById"

<?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>
    <Release_RetrieveById xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <releaseId>int</releaseId>
    </Release_RetrieveById>
  </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>
    <Release_RetrieveByIdResponse xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <Release_RetrieveByIdResult>
        <ReleaseId>int</ReleaseId>
        <CreatorId>int</CreatorId>
        <ProjectId>int</ProjectId>
        <Name>string</Name>
        <Description>string</Description>
        <VersionNumber>string</VersionNumber>
        <CreationDate>dateTime</CreationDate>
        <LastUpdateDate>dateTime</LastUpdateDate>
        <Summary>boolean</Summary>
        <Active>boolean</Active>
        <Iteration>boolean</Iteration>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
        <ResourceCount>int</ResourceCount>
        <DaysNonWorking>int</DaysNonWorking>
        <PlannedEffort>int</PlannedEffort>
        <AvailableEffort>int</AvailableEffort>
        <TaskEstimatedEffort>int</TaskEstimatedEffort>
        <TaskActualEffort>int</TaskActualEffort>
        <TaskCount>int</TaskCount>
        <CreatorName>string</CreatorName>
      </Release_RetrieveByIdResult>
    </Release_RetrieveByIdResponse>
  </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>
    <Release_RetrieveById xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <releaseId>int</releaseId>
    </Release_RetrieveById>
  </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>
    <Release_RetrieveByIdResponse xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <Release_RetrieveByIdResult>
        <ReleaseId>int</ReleaseId>
        <CreatorId>int</CreatorId>
        <ProjectId>int</ProjectId>
        <Name>string</Name>
        <Description>string</Description>
        <VersionNumber>string</VersionNumber>
        <CreationDate>dateTime</CreationDate>
        <LastUpdateDate>dateTime</LastUpdateDate>
        <Summary>boolean</Summary>
        <Active>boolean</Active>
        <Iteration>boolean</Iteration>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
        <ResourceCount>int</ResourceCount>
        <DaysNonWorking>int</DaysNonWorking>
        <PlannedEffort>int</PlannedEffort>
        <AvailableEffort>int</AvailableEffort>
        <TaskEstimatedEffort>int</TaskEstimatedEffort>
        <TaskActualEffort>int</TaskActualEffort>
        <TaskCount>int</TaskCount>
        <CreatorName>string</CreatorName>
      </Release_RetrieveByIdResult>
    </Release_RetrieveByIdResponse>
  </soap12:Body>
</soap12:Envelope>