Object request formats with manual mapping

Format

The format can have these request formats with manual mapping:

  • application/json - Define a JSON Conventional request in the Request Body field and use path expressions to get values from the input document.

  • application/xml - Define an XML request in the Request Body field and use path expressions toget values from the input document.

  • text/plain - Define a static text request in the Request Body field.

Name
The name of the parameter of type body that was defined in the API metadata.
Description
The description of the parameter of type body that was defined in the API metadata.
Body

If the Map input document to API request check box is selected, the Body field is enabled. Define a request body using the selected request format.

If the model schema is described in the API metadata, you can generate an example body. To specify the request body with a sample, click EXAMPLE.

You can use the path expressions from the input document to define values for the request body. To identify a path expression in the body structure you can use elements.

For a application/json request content type use "IonApiRef”

For an application/xml request content type use <IonApiRef>

The value of these elements must be Xpath or JSONPath per type of input document. In case the input document is of type ANY, the path type and body content must match the request format.

For more information about path expressions see Specifying a path for mapping.

At runtime, the path expression is replaced with the value from the input document.