SpiraPlan: ImportExport SOAP Web Service


Click here for a complete list of operations.

TestStep_Create

Creates a new test step 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/TestStep_Create"

<?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>
    <TestStep_Create xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <remoteTestStep>
        <TestStepId>int</TestStepId>
        <TestCaseId>int</TestCaseId>
        <ExecutionStatusId>int</ExecutionStatusId>
        <Position>int</Position>
        <Description>string</Description>
        <ExpectedResult>string</ExpectedResult>
        <SampleData>string</SampleData>
        <LinkedTestCaseId>int</LinkedTestCaseId>
      </remoteTestStep>
      <testCaseId>int</testCaseId>
    </TestStep_Create>
  </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>
    <TestStep_CreateResponse xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <TestStep_CreateResult>
        <TestStepId>int</TestStepId>
        <TestCaseId>int</TestCaseId>
        <ExecutionStatusId>int</ExecutionStatusId>
        <Position>int</Position>
        <Description>string</Description>
        <ExpectedResult>string</ExpectedResult>
        <SampleData>string</SampleData>
        <LinkedTestCaseId>int</LinkedTestCaseId>
      </TestStep_CreateResult>
    </TestStep_CreateResponse>
  </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>
    <TestStep_Create xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <remoteTestStep>
        <TestStepId>int</TestStepId>
        <TestCaseId>int</TestCaseId>
        <ExecutionStatusId>int</ExecutionStatusId>
        <Position>int</Position>
        <Description>string</Description>
        <ExpectedResult>string</ExpectedResult>
        <SampleData>string</SampleData>
        <LinkedTestCaseId>int</LinkedTestCaseId>
      </remoteTestStep>
      <testCaseId>int</testCaseId>
    </TestStep_Create>
  </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>
    <TestStep_CreateResponse xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <TestStep_CreateResult>
        <TestStepId>int</TestStepId>
        <TestCaseId>int</TestCaseId>
        <ExecutionStatusId>int</ExecutionStatusId>
        <Position>int</Position>
        <Description>string</Description>
        <ExpectedResult>string</ExpectedResult>
        <SampleData>string</SampleData>
        <LinkedTestCaseId>int</LinkedTestCaseId>
      </TestStep_CreateResult>
    </TestStep_CreateResponse>
  </soap12:Body>
</soap12:Envelope>