SpiraPlan: ImportExport SOAP Web Service


Click here for a complete list of operations.

CustomProperty_RetrieveProjectProperties

Retrieves the list of custom properties configure for the current 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/CustomProperty_RetrieveProjectProperties"

<?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>
    <CustomProperty_RetrieveProjectProperties xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <artifactTypeId>int</artifactTypeId>
    </CustomProperty_RetrieveProjectProperties>
  </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>
    <CustomProperty_RetrieveProjectPropertiesResponse xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <CustomProperty_RetrieveProjectPropertiesResult>
        <RemoteCustomProperty>
          <CustomPropertyId>int</CustomPropertyId>
          <ProjectId>int</ProjectId>
          <ArtifactTypeId>int</ArtifactTypeId>
          <Alias>string</Alias>
          <CustomPropertyListId>int</CustomPropertyListId>
          <CustomPropertyName>string</CustomPropertyName>
          <CustomPropertyTypeId>int</CustomPropertyTypeId>
          <CustomPropertyTypeName>string</CustomPropertyTypeName>
        </RemoteCustomProperty>
        <RemoteCustomProperty>
          <CustomPropertyId>int</CustomPropertyId>
          <ProjectId>int</ProjectId>
          <ArtifactTypeId>int</ArtifactTypeId>
          <Alias>string</Alias>
          <CustomPropertyListId>int</CustomPropertyListId>
          <CustomPropertyName>string</CustomPropertyName>
          <CustomPropertyTypeId>int</CustomPropertyTypeId>
          <CustomPropertyTypeName>string</CustomPropertyTypeName>
        </RemoteCustomProperty>
      </CustomProperty_RetrieveProjectPropertiesResult>
    </CustomProperty_RetrieveProjectPropertiesResponse>
  </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>
    <CustomProperty_RetrieveProjectProperties xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <artifactTypeId>int</artifactTypeId>
    </CustomProperty_RetrieveProjectProperties>
  </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>
    <CustomProperty_RetrieveProjectPropertiesResponse xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <CustomProperty_RetrieveProjectPropertiesResult>
        <RemoteCustomProperty>
          <CustomPropertyId>int</CustomPropertyId>
          <ProjectId>int</ProjectId>
          <ArtifactTypeId>int</ArtifactTypeId>
          <Alias>string</Alias>
          <CustomPropertyListId>int</CustomPropertyListId>
          <CustomPropertyName>string</CustomPropertyName>
          <CustomPropertyTypeId>int</CustomPropertyTypeId>
          <CustomPropertyTypeName>string</CustomPropertyTypeName>
        </RemoteCustomProperty>
        <RemoteCustomProperty>
          <CustomPropertyId>int</CustomPropertyId>
          <ProjectId>int</ProjectId>
          <ArtifactTypeId>int</ArtifactTypeId>
          <Alias>string</Alias>
          <CustomPropertyListId>int</CustomPropertyListId>
          <CustomPropertyName>string</CustomPropertyName>
          <CustomPropertyTypeId>int</CustomPropertyTypeId>
          <CustomPropertyTypeName>string</CustomPropertyTypeName>
        </RemoteCustomProperty>
      </CustomProperty_RetrieveProjectPropertiesResult>
    </CustomProperty_RetrieveProjectPropertiesResponse>
  </soap12:Body>
</soap12:Envelope>