Swagger Lookup

Description

Returns result of executing REST requests based on a Swagger Connection.

This function supports nested fields.

Use

  • Select a Swagger connection in Hero Platform_.
  • Select an endpoint supported by the Connection.
    • Usable endpoints and methods are listed in the drop-down selector.
  • Select a response mode:
    • Simple - This mode processes the successful HTTP responses and throws exception on non-successful HTTP response codes. Output fields are generated by the Swagger schema.
    • Multi response - This mode provides the HTTP response code and tuple definitions for every defined response type in the schema. As Hero Platform_ parses the response, one tuple (or zero) is filled depending on the response code.
  • Select how value parameters are provided. 

    • Request template

      Example Behavior

      The variable is defined in the following format: {"a": ${field}}

      • the input field is a Long and null value: {"a": null }

      • the input field is a Long and 123: {"a": 123 }

      • the input field is a String and "123": {"a": 123 }

      The variable is defined in the following format {"a": "${field}" } 

      • the input field is a Long and null value: {"a": null } (without double quotes)

      • the input field is a String and null value: {"a": null } (without double quotes)

      • the input field is a Long and 123: {"a": "123" }

      • the input field is a String and "123": {"a": "123" }

    • Define field:
      • Tuple 
        • Select parameter name.
      • Custom value
        • Enter custom value.
  • Review and select/move output fields and assign data types.
  • Click OK.

Type

Swagger Lookup


Search