SOAP Pure

Overview

SOAP HTTP (Pure) step allows making network requests to query or send data.

Configuration

• URL (endpoint.url) - URL for the SOAP service
• Target path (targetPath) - doc node on which to store the result
• Path to store headers (headerPath) - store request/response headers of the API call. No header values will be stored if left blank.
• Cache response (cacheble) - if checked, enables caching response values
• Disable headers in cache key (disableHeadersInKey) - Disable the usage of the HTTP headers in the cache key of the results
• Cache Key (cacheKey) - if specified, will be used as key to store the cached response
• Cache clean-up condition (cacheCleanupCondition) - If condition is true, then step cache is cleared, else if condition is false or not defined, then step behaves as usually.
• TTL (ttl) - time in minutes for how long to keep the cached results
• SOAP Request (soapRequest) - SOAP request to be sent (JSON)
• HTTP Headers (httpHeaders) - HTTP headers to send in the request
• SOAP result header path (headerTargetPath) - set the doc node on which to store SOAP response headers (if required)

Example

Example flow

tags:
  - general
steps:
  - stepType: soap-pure
    config:
      endpoint:
        url: https://www.dataaccess.com/webservicesserver/NumberConversion.wso
      soapRequest:
        soap:Envelope:
          attr:
            xmlns:soap: http://schemas.xmlsoap.org/soap/envelope/
          soap:Body:
            NumberToWords:
              attr:
                xmlns: http://www.dataaccess.com/webservicesserver/
              ubiNum: 333
      targetPath: result
      httpHeaders: {}
      disableHeadersInKey: false
    name: SOAP HTTP (Pure)
    description: ""
    condition: ""
sampleData: {}

Flow Result

{
  "doc": {
    "result": {
      "soap:Envelope": {
        "soap:Body": {
          "m:NumberToWordsResponse": {
            "m:NumberToWordsResult": "three hundred and thirty three "
          }
        }
      }
    }
  },
  "errors": [],
  "performance": {
    "steps": [
      {
        "step": "soap-pure",
        "executionTime": 1272
      }
    ],
    "executionTimeOfFlow": 1273,
    "timeMetric": "ms"
  }
}