SpiraPlan: ImportExport SOAP Web Service


Click here for a complete list of operations.

Incident_RetrieveWorkflowFields

Retrieves the list of incident fields and their workflow status for a given type and status/step.

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

<?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>
    <Incident_RetrieveWorkflowFields xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <currentTypeID>int</currentTypeID>
      <currentStatusID>int</currentStatusID>
    </Incident_RetrieveWorkflowFields>
  </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>
    <Incident_RetrieveWorkflowFieldsResponse xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <Incident_RetrieveWorkflowFieldsResult>
        <RemoteWorkflowIncidentFields>
          <FieldCaption>string</FieldCaption>
          <FieldName>string</FieldName>
          <FieldID>int</FieldID>
          <FieldStatus>int</FieldStatus>
        </RemoteWorkflowIncidentFields>
        <RemoteWorkflowIncidentFields>
          <FieldCaption>string</FieldCaption>
          <FieldName>string</FieldName>
          <FieldID>int</FieldID>
          <FieldStatus>int</FieldStatus>
        </RemoteWorkflowIncidentFields>
      </Incident_RetrieveWorkflowFieldsResult>
    </Incident_RetrieveWorkflowFieldsResponse>
  </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>
    <Incident_RetrieveWorkflowFields xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <currentTypeID>int</currentTypeID>
      <currentStatusID>int</currentStatusID>
    </Incident_RetrieveWorkflowFields>
  </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>
    <Incident_RetrieveWorkflowFieldsResponse xmlns="http://www.inflectra.com/SpiraTest/Services/v2.2/">
      <Incident_RetrieveWorkflowFieldsResult>
        <RemoteWorkflowIncidentFields>
          <FieldCaption>string</FieldCaption>
          <FieldName>string</FieldName>
          <FieldID>int</FieldID>
          <FieldStatus>int</FieldStatus>
        </RemoteWorkflowIncidentFields>
        <RemoteWorkflowIncidentFields>
          <FieldCaption>string</FieldCaption>
          <FieldName>string</FieldName>
          <FieldID>int</FieldID>
          <FieldStatus>int</FieldStatus>
        </RemoteWorkflowIncidentFields>
      </Incident_RetrieveWorkflowFieldsResult>
    </Incident_RetrieveWorkflowFieldsResponse>
  </soap12:Body>
</soap12:Envelope>