CallRESTWebService

The CallRESTWebService function allows for calling a REST web service.

This function can be used to call other published Linx processes on the same or different Linx servers.

Properties

Authentication

The authentication properties are needed when authentication is required by the web service being called. This does not apply to custom authentication implementations where the username and password are commonly passed as parameters to the web service. For Windows authentication, this requires a Windows user and security for the site defined in Internet Information Server (IIS).

  • Type

    The type of authentication configured on the server for the web service being called. Most common is Basic.

  • Domain

    The domain to authenticate the user against.

  • Username

    The username to authenticate against.

  • Password

    The password to authenticate against.

Request

  • Method

    Most web services are configured to accept messages using GET or POST. Some may also use HEAD, PUT or DELETE.

  • URL

    The base URL to use for the service request. This excludes any parameter-specific information that are send with the request. A valid example for this field could look like this:
    http://localhost:8022/Service/ExecuteService

  • Query string

    A list of parameters to use in order to build up the query string. A query string with a format similar to the following will be generated (note that parameters have not been URL encoded to improve readability):
    origin=CapeTown&destination=Johannesburg&sensor=false&alternatives=true

  • Headers

    Arguments and data are commonly transferred using the headers of a call. You can add data to the headers if the web service requires this.

  • Body format

    The Body of a request needs to be in the format that the web service understands. If you are not sure which value to use, the standard and most likely value is ‘Text’. The developers of the service you are trying to call should be able to assist in identifying the correct value.

  • Body

    The payload of your web service call in the format specified by the Body format property. If you pass data in the body, you cannot use the GET method, but need to use POST instead.

Request Signing (Certificate)

  • Sign with certificate

    Specifies whether the client should expose a certificate with which to sign requests.

  • Certificate path

    The certificate to use to sign requests.

Request signing (OAuth)

  • Sign request

    Specifies whether the request should be signed using the OAuth authentication standard.

  • Encryption key

    The key used to encrypt the request when signing.

Response

This section allows to configure the structure of the data that is being returned from the web service.

The supported return formats are JSON, XML, or a plain string.

  • Output type

    The value type to use when interpreting the response. The List option indicates whether the response should be interpreted as a list of values. The List option requires you to use JSON or XML for the Body format.

    If you create a custom type and you have formatted your response accordingly, you can point the Output type field at your user defined type. After the service has executed, Linx will map the return result to the specified structure. Any field that is specified in the return structure that is not present in the response will be ignored.

  • List content type

    Indicates the value type for the items in the list. This option is only visible if the Output type is set to List.

Web proxy

These settings are applicable only if you or the server you’re contacting are using a proxy server.

  • Proxy name

    The IP address or URL of your proxy server.

  • Port

    The web service call is commonly performed over port 80, but you can change that if you have configured the service or proxy to use a different port.

  • Bypass on local

    While you are developing the function you may have a different setup from the live environment. When this property is checked, the proxy setup is ignored for your local machine.

Settings

  • Timeout

    The timeout value for the web service call.

  • Max response content size

    The maximum amount of bytes response content can contain.

Links