Skip to content

Commit 959f745

Browse files
Updated readme
1 parent 06e331d commit 959f745

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

activity/soapclient/README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ flogo install github.com/project-flogo/contrib/activity/soapclient
2222
| soapVersion | string | SOAP Version to be used. Supported Version: 1.1 and 1.2 - **REQUIRED**
2323
| timeout | integer| Request timeout in seconds
2424
| enableTLS | bool | Set to true when using certificates. If set to false and SOAP Service Endpoint starts with https then certificate validation is set to false.
25-
| xmlPassthroughMode | bool | Use this mode when SOAP body and headers are coming from upstream activity/trigger in XML format. When set, even incoming SOAP response is set in XML format without any processing. When not set, activity will convert request body and headers from JSON to XML and response body and headers from XML to JSON based on configured schema
26-
| attributePrefix | string | When xmlPassthroughMode is not set, use this confguration to define attribute representation in JSON data. e.g If the prefix is set to '@', <car electric="true">Tesla</car> will be converted to {"car": {"@electric": "true", "#text": "Tesla"}}. The default is set to '-'
25+
| xmlMode | bool | Use this mode when SOAP body and headers are coming from upstream activity/trigger in XML format. When enabled, even incoming SOAP response is set in XML format without any processing. When not set, activity will convert request body and headers from JSON to XML and response body and headers from XML to JSON based on configured JSON schema
26+
| xmlAttributePrefix | string | When xmlMode is not set, use this confguration to define attribute representation in JSON data. e.g If the prefix is set to '@', <car electric="true">Tesla</car> will be converted to {"car": {"@electric": "true", "#text": "Tesla"}}. The default is set to '-'
2727
| serverCertificate | string | When enableTLS set to true, you can configure a PEM encoded CA or Server certificate. You can set either base64 encoded certificate value or file path with prefix 'file://'
2828
| clientCertificate | string | When enableTLS set to true, you can configure a PEM encoded Client certificate. You can set either base64 encoded certificate value or file path with prefix 'file://'
2929
| clientKey | string | When enableTLS set to true, you can configure a PEM encoded Clinent Key certificate. You can set either base64 encoded certificate value or file path with prefix 'file://'
@@ -32,15 +32,15 @@ flogo install github.com/project-flogo/contrib/activity/soapclient
3232
| Name | Type | Description
3333
|:--- | :--- | :---
3434
| soapAction | string | The SOAP action to be set in the header
35-
| httpQueryParams | any | The HTTP query parameters to be sent. When xmlPassthroughMode set to false, you can coerce this field to JSON payload/schema. Just hover over the field and select 'Coerce with Schema' option after clicking '...'
36-
| soapRequestHeaders | any | The SOAP request headers to be sent. When xmlPassthroughMode set to false, you can coerce this field to JSON payload/schema. Just hover over the field and select 'Coerce with Schema' option after clicking '...'
37-
| soapRequestBody | any | The SOAP request headers to be sent. When xmlPassthroughMode set to false, you can coerce this field to JSON payload/schema. Just hover over the field and select 'Coerce with Schema' option after clicking '...'
35+
| httpQueryParams | any | The HTTP query parameters to be sent. You can coerce this field to JSON payload/schema. Just hover over the field and select 'Coerce with Schema' option after clicking '...'
36+
| soapRequestHeaders | any | The SOAP request headers to be sent. When xmlMode set to false, you can coerce this field to JSON payload/schema. Just hover over the field and select 'Coerce with Schema' option after clicking '...'
37+
| soapRequestBody | any | The SOAP request headers to be sent. When xmlMode set to false, you can coerce this field to JSON payload/schema. Just hover over the field and select 'Coerce with Schema' option after clicking '...'
3838

3939
### Output:
4040
| Name | Type | Description
4141
|:--- | :--- | :---
4242
| httpStatus | int | The HTTP status code
4343
| isFault | bool | Set to true when fault returned in the response
44-
| soapResponsePayload | any | The SOAP response payload received in case of success. When xmlPassthroughMode set to false, you can coerce this field to JSON payload/schema. Just hover over the field and select 'Coerce with Schema' option after clicking '...'
45-
| soapResponseHeaders | any | The SOAP response headers received. When xmlPassthroughMode set to false, you can coerce this field to JSON payload/schema. Just hover over the field and select 'Coerce with Schema' option after clicking '...'
46-
| soapResponseFault | any | The SOAP response payload received in case of success. When xmlPassthroughMode set to false, you can coerce this field to JSON payload/schema. Just hover over the field and select 'Coerce with Schema' option after clicking '...'
44+
| soapResponsePayload | any | The SOAP response payload received in case of success. When xmlMode set to false, you can coerce this field to JSON payload/schema. Just hover over the field and select 'Coerce with Schema' option after clicking '...'. When xmlMode is true, output will be XML string.
45+
| soapResponseHeaders | any | The SOAP response headers received. When xmlMode set to false, you can coerce this field to JSON payload/schema. Just hover over the field and select 'Coerce with Schema' option after clicking '...'. When xmlMode is true, output will be XML string.
46+
| soapResponseFault | any | The SOAP response payload received in case of success. When xmlMode set to false, you can coerce this field to JSON payload/schema. Just hover over the field and select 'Coerce with Schema' option after clicking '...'. When xmlMode is true, output will be XML string.

0 commit comments

Comments
 (0)