Web Service Steps
- 14 Feb 2023
- 1 Minute to read
- Print
- DarkLight
Web Service Steps
- Updated on 14 Feb 2023
- 1 Minute to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
| Step Details | |
| Introduced in Version | 4.0.0 |
| Last Modified in Version | 7.12.0 |
| Location | Integration > Web Services |
Web Service steps are methods that can be integrated into a Flow. To add a Web Service within the Portal, navigate to the folder System > Integrations > External Services and click the ADD WEB SERVICE REFERENCE button, then supply the necessary details. The steps added to the Flow Designer depend on the Web Service itself; this article will go over the basic settings of the Web Service steps.
Prerequisites
Integrate with an External Web Service
Properties
Credentials
| Property | Description | Data Type | |
|---|---|---|---|
| Specify Credentials | Allows for the credentials to be specified within the Flow itself; this will override any credentials set when setting up the Web Service. | Boolean | |
| Authentication Type | Choose from Basic Authentication or NTLM Authentication. | --- | |
| Get Credentials from Flow Data | Setting this to true will allow the UserId and Password to be Inputs on the step, allowing them to be set with dynamic data at runtime. | Boolean | |
| UserName | UserName to authenticate the connection. | String | |
| Password | Password to authenticate the connection. | String | |
Environment
| Property | Description | Data Type |
|---|---|---|
| Get URL From Data | Setting this to true will allow the Web Service URL to be an Input on the step, allowing it to be set with dynamic data at runtime. | --- |
| Request Timeout | This allows users to specify a timeout for the request; if the request isn't successfully run in the time specified, the step will fail. Request Timeout is in seconds. | --- |
Inputs
| Property | Description | Data Type |
|---|---|---|
| Web Service URL | *Only available if the Get URL From Data setting is true. | String |
| UserId | UserId to authenticate the connection. | String |
| Password | Password to authenticate the connection. | String |
Outputs
| Property | Description | Data Type |
|---|---|---|
| Error Message | Provides a detailed error message based the error that was encountered. | String |
Related Information
Was this article helpful?
