SpiraPlan: ImportExport SOAP Web Service

Click here for a complete list of operations.

Project_AddCustomList

Adds a new custom list into the project

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

<?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>
    <Project_AddCustomList xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <remoteCustomList>
        <CustomPropertyListId>int</CustomPropertyListId>
        <ProjectId>int</ProjectId>
        <Name>string</Name>
        <Active>boolean</Active>
      </remoteCustomList>
    </Project_AddCustomList>
  </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>
    <Project_AddCustomListResponse xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <Project_AddCustomListResult>
        <CustomPropertyListId>int</CustomPropertyListId>
        <ProjectId>int</ProjectId>
        <Name>string</Name>
        <Active>boolean</Active>
      </Project_AddCustomListResult>
    </Project_AddCustomListResponse>
  </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>
    <Project_AddCustomList xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <remoteCustomList>
        <CustomPropertyListId>int</CustomPropertyListId>
        <ProjectId>int</ProjectId>
        <Name>string</Name>
        <Active>boolean</Active>
      </remoteCustomList>
    </Project_AddCustomList>
  </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>
    <Project_AddCustomListResponse xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <Project_AddCustomListResult>
        <CustomPropertyListId>int</CustomPropertyListId>
        <ProjectId>int</ProjectId>
        <Name>string</Name>
        <Active>boolean</Active>
      </Project_AddCustomListResult>
    </Project_AddCustomListResponse>
  </soap12:Body>
</soap12:Envelope>