Web Service Connector

The WebService Connector allows you to consume RESTful web services. Drag an OpenAPI definition file onto the Create Web Service window to automatically create supported web service calls. Those can then be accessed in page controls or scripts.

Alternatively, create the WebService Connector manually by entering the base URL and authentication details of a web service in the Connection Editor. Proceed by right-clicking on the name of the WebServiceConnector to add function calls to the web service.



Add a Web Service Connector


Connection Editor Properties

  1. URL

    This is the base URL of the web service.
  2. Timeout

    This value corresponds to the duration in seconds before a request to the web service times out.
  3. Authentication

    This can be one of 3 values: Anonymous, Basic or ApiKey. Stadium does not currently support authentication via OAuth2.
    • Anonymous Authentication
           - For web services requiring no authentication.
    • Basic Authentication
           - For web services requiring the HTTP basic method of authentication. Required: username and password.
    • Api Key Authentication
           - For web services requiring authentication through an API key. Required: key name, key value and key location (QueryString/Header/Cookie).

Function Editor

  1. Method

    Use this dropdown to select the HTTP method type of the web request.
  2. Path

    The URL segment specifying the path and query string parameters of a web request is specified here. Use "{ }" to denote any path parameter having variable values. For example, the path "/pet/{petId}/?filter=cat" will create the path parameter "petId". Path parameters will appear in the Parameters table.
  3. Parameters

    The Parameters table lists the parameters available to be read or set in page controls or scripts. To add a new parameter, enter the parameter name and location (QueryString/Header/Cookie) into the last row of the Parameters table.
  4. Body Format

    Use this dropdown to select the body content type of the web request. This property is enabled only when the HTTP Method is set to POST or PUT.

Function Properties

  1. Response Format

    Use this dropdown to select the content type of the response received from the web request.