SOAP HTTP

Overview

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

Configuration

• WSDL URL location - WSDL url for the SOAP service
• Soap endpoint - optional url for the SOAP endpoint. If not provided, then endpoint URL is retrieved from WSDL.
• Soap method name - the soap method name to execute
• Target path - doc node on which to store the result
• Path to store headers - store request/response headers of the api call. No header values will be stored if left blank.
• Store target path results in cache - if checked will enable caching response values
• Cache Key - if specified, will be used as key to store the cached response
• Cache clean-up condition - If condition is true, then step cache is cleared and data is not cached, else if condition is false or not defined, then step behaves as usually.
• TTL - time in minutes for how long to keep the cached results
• Soap headers - array of soap headers to be sent
• HTTP Headers - http headers to send in the rest request
• soap result header path - set the doc done on which to store SOAP response headers (if required)
• Soap Request - type of SOAP request (json or xml)
• JSON object or XML String - data to be sent with the request
• Additional options for the soap client - (Advanced configuration) additional options for the underlying SOAP client

Formatting the SOAP request JSON object

If an element in the JSON object (for example username) is expected to have a namespace prefix (for example ns1), it can be added by prefixing the element (such as ns1:username). The JSON object will automatically resolve namespaces defined in the WSDL.

Formatting the SOAP request XML string

The passed XML does not need to contain an XML declaration (ex: <?xml version="1.0" encoding="UTF-8"?>) or document type declaration and should not be wrapped in an envelope - this is all done by the step itself. On the other hand, all of the required namespaces and namespace prefixes must be specified. Namespaces are only utilized from the WSDL if the request data is passed as JSON.

Examples

Example flow

{
  "id": "195f2474-3004-4acf-892e-acc7eb4df461",
  "name": "sampleSoapCall",
  "flow": {
    "name": "sampleSoapCall",
    "description": "",
    "steps": [
      {
        "stepType": "soap-new",
        "color": "rgb(247,225,211)",
        "displayName": "SOAP HTTP",
        "isSelected": true,
        "config": {
          "endpoint": {
            "url": "https://www.dataaccess.com/webservicesserver/NumberConversion.wso?wsdl"
          },
          "soapRequest": "JSON",
          "method": "NumberToWords",
          "targetPath": "result",
          "json": {
            "ubiNum": "{{number}}"
          },
          "extraSoapClientOptions": {},
          "httpHeaders": {}
        },
        "textColor": "black"
      }
    ]
  },
  "inputSchema": {
    "number": "123"
  },
  "createDate": "2022-09-27T12:02:57.791Z",
  "tags": [
    "general"
  ],
  "inputSchemaLabel": "",
  "version": 1
}

Flow Result

{
  "doc": {
    "number": "123",
    "result": {
      "NumberToWordsResult": "one hundred and twenty three"
    }
  },
  "errors": [],
  "performance": {
    "steps": [
      {
        "step": "soap-new",
        "executionTime": 307
      }
    ],
    "executionTimeOfFlow": 308,
    "timeMetric": "ms"
  }
}