SpiraPlan: ImportExport SOAP Web Service

Click here for a complete list of operations.

DataMapping_RetrieveCustomPropertyMapping

Retrieves the data mapping for a custom property

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

<?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>
    <DataMapping_RetrieveCustomPropertyMapping xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <dataSyncSystemId>int</dataSyncSystemId>
      <artifactTypeId>int</artifactTypeId>
      <customPropertyId>int</customPropertyId>
    </DataMapping_RetrieveCustomPropertyMapping>
  </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>
    <DataMapping_RetrieveCustomPropertyMappingResponse xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <DataMapping_RetrieveCustomPropertyMappingResult>
        <ProjectId>int</ProjectId>
        <InternalId>int</InternalId>
        <ExternalKey>string</ExternalKey>
        <Primary>boolean</Primary>
      </DataMapping_RetrieveCustomPropertyMappingResult>
    </DataMapping_RetrieveCustomPropertyMappingResponse>
  </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>
    <DataMapping_RetrieveCustomPropertyMapping xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <dataSyncSystemId>int</dataSyncSystemId>
      <artifactTypeId>int</artifactTypeId>
      <customPropertyId>int</customPropertyId>
    </DataMapping_RetrieveCustomPropertyMapping>
  </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>
    <DataMapping_RetrieveCustomPropertyMappingResponse xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <DataMapping_RetrieveCustomPropertyMappingResult>
        <ProjectId>int</ProjectId>
        <InternalId>int</InternalId>
        <ExternalKey>string</ExternalKey>
        <Primary>boolean</Primary>
      </DataMapping_RetrieveCustomPropertyMappingResult>
    </DataMapping_RetrieveCustomPropertyMappingResponse>
  </soap12:Body>
</soap12:Envelope>