REST Lookup

Description

Executes one of the following HTTP requests:

  • GET
  • POST
  • PATCH
  • HEAD
  • PUT
  • DELETE

Use

  • Select an argument field.
    • Additional arguments can be selected.
  • Select a REST Connection from the drop-down list.
  • Select an HTTP method.
    • GET
    • POST
    • PATCH
    • HEAD
    • PUT
    • DELETE
  • Enter an endpoint.
    • Variables can be used in this field if the variable is present in the argument. 

      • Variable syntax:

        ${TUPLE.<field name>}

  • Enter requested header, query parameter, and cookie parameter names and values.
    • Values can be variables present in the argument.
  • Enter the body text in JSON format.
    • Values can be variables present in the argument.

      Example Behavior

      The variable is defined in the following format: {"a": ${TUPLE.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": "${TUPLE.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" }

  • Select the input format:
    • JSON
    • Binary
    • CSV
    • LOG
    • TEXT
  • Click the refresh icon to display the lookup function tuple field mapping.

    • Confirm or change field names.
    • Remove or confirm the arrangement of fields.

    Warning

    The field mapping detection executes a real API call with the sample data. This action can cause changes on the other side when using POST, PUT, PATCH, and DELETE methods.

  • Click OK to save the lookup function configuration.


Type

Lookup