SpiraPlan: ImportExport SOAP Web Service


Click here for a complete list of operations.

Requirement_Create1

Creates a new requirement record in the current project using the position offset method

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

<?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>
    <Requirement_Create1 xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <remoteRequirement>
        <RequirementId>int</RequirementId>
        <ProjectId>int</ProjectId>
        <StatusId>int</StatusId>
        <AuthorId>int</AuthorId>
        <OwnerId>int</OwnerId>
        <ImportanceId>int</ImportanceId>
        <ReleaseId>int</ReleaseId>
        <Name>string</Name>
        <Description>string</Description>
        <CreationDate>dateTime</CreationDate>
        <LastUpdateDate>dateTime</LastUpdateDate>
        <Summary>boolean</Summary>
        <CoverageCountTotal>int</CoverageCountTotal>
        <CoverageCountPassed>int</CoverageCountPassed>
        <CoverageCountFailed>int</CoverageCountFailed>
        <CoverageCountCaution>int</CoverageCountCaution>
        <CoverageCountBlocked>int</CoverageCountBlocked>
        <PlannedEffort>int</PlannedEffort>
        <TaskEstimatedEffort>int</TaskEstimatedEffort>
        <TaskActualEffort>int</TaskActualEffort>
        <TaskCount>int</TaskCount>
      </remoteRequirement>
      <indentPosition>int</indentPosition>
    </Requirement_Create1>
  </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>
    <Requirement_Create1Response xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <Requirement_Create1Result>
        <RequirementId>int</RequirementId>
        <ProjectId>int</ProjectId>
        <StatusId>int</StatusId>
        <AuthorId>int</AuthorId>
        <OwnerId>int</OwnerId>
        <ImportanceId>int</ImportanceId>
        <ReleaseId>int</ReleaseId>
        <Name>string</Name>
        <Description>string</Description>
        <CreationDate>dateTime</CreationDate>
        <LastUpdateDate>dateTime</LastUpdateDate>
        <Summary>boolean</Summary>
        <CoverageCountTotal>int</CoverageCountTotal>
        <CoverageCountPassed>int</CoverageCountPassed>
        <CoverageCountFailed>int</CoverageCountFailed>
        <CoverageCountCaution>int</CoverageCountCaution>
        <CoverageCountBlocked>int</CoverageCountBlocked>
        <PlannedEffort>int</PlannedEffort>
        <TaskEstimatedEffort>int</TaskEstimatedEffort>
        <TaskActualEffort>int</TaskActualEffort>
        <TaskCount>int</TaskCount>
      </Requirement_Create1Result>
    </Requirement_Create1Response>
  </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>
    <Requirement_Create1 xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <remoteRequirement>
        <RequirementId>int</RequirementId>
        <ProjectId>int</ProjectId>
        <StatusId>int</StatusId>
        <AuthorId>int</AuthorId>
        <OwnerId>int</OwnerId>
        <ImportanceId>int</ImportanceId>
        <ReleaseId>int</ReleaseId>
        <Name>string</Name>
        <Description>string</Description>
        <CreationDate>dateTime</CreationDate>
        <LastUpdateDate>dateTime</LastUpdateDate>
        <Summary>boolean</Summary>
        <CoverageCountTotal>int</CoverageCountTotal>
        <CoverageCountPassed>int</CoverageCountPassed>
        <CoverageCountFailed>int</CoverageCountFailed>
        <CoverageCountCaution>int</CoverageCountCaution>
        <CoverageCountBlocked>int</CoverageCountBlocked>
        <PlannedEffort>int</PlannedEffort>
        <TaskEstimatedEffort>int</TaskEstimatedEffort>
        <TaskActualEffort>int</TaskActualEffort>
        <TaskCount>int</TaskCount>
      </remoteRequirement>
      <indentPosition>int</indentPosition>
    </Requirement_Create1>
  </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>
    <Requirement_Create1Response xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <Requirement_Create1Result>
        <RequirementId>int</RequirementId>
        <ProjectId>int</ProjectId>
        <StatusId>int</StatusId>
        <AuthorId>int</AuthorId>
        <OwnerId>int</OwnerId>
        <ImportanceId>int</ImportanceId>
        <ReleaseId>int</ReleaseId>
        <Name>string</Name>
        <Description>string</Description>
        <CreationDate>dateTime</CreationDate>
        <LastUpdateDate>dateTime</LastUpdateDate>
        <Summary>boolean</Summary>
        <CoverageCountTotal>int</CoverageCountTotal>
        <CoverageCountPassed>int</CoverageCountPassed>
        <CoverageCountFailed>int</CoverageCountFailed>
        <CoverageCountCaution>int</CoverageCountCaution>
        <CoverageCountBlocked>int</CoverageCountBlocked>
        <PlannedEffort>int</PlannedEffort>
        <TaskEstimatedEffort>int</TaskEstimatedEffort>
        <TaskActualEffort>int</TaskActualEffort>
        <TaskCount>int</TaskCount>
      </Requirement_Create1Result>
    </Requirement_Create1Response>
  </soap12:Body>
</soap12:Envelope>