Output Document tab

On this tab you can define how API response must be sent to output document. Or you can use manual mapping to define different document format with values from API response using path expressions.

Document
Select the document.

If the document is not defined in ION Data Catalog, you can click GENERATE METADATA to add new document. The generate metadata functionality can be used for generating BOD metadata from API response and for registering new ANY documents.

Output Format

Select the output format. A list of available output formats is defined by these criteria:

  • The type of the selected output document.
  • If the Map API response to document check box is selected.
  • The response content types that are available in API

The output can have these formats without manual mapping:

  • application/json - JSON Conventional response is sent to output document.

  • application/x-ndjson - JSON newline-delimited response is sent to the output document.

  • JSON from XML - XML response is converted to JSON Conventional and sent to output document.

  • application/xml - XML response is sent to output document.

  • BOD from XML - XML response is wrapped as a BOD and sent to output document.

  • BOD from JSON - JSON Conventional response is converted to XML, wrapped as a BOD and sent to output document.

  • XML from JSON - JSON Conventional response is converted to XML and sent to output document.

  • text/csv, text/tab-separated-values, text/plain - DSV response is sent to output document.

  • Any other request content type - ANY response is sent to output document.

The output has these formats with manual mapping:

  • application/json - Define a JSON Conventional output document in the Manual Mapping field and use path expressions to get values from response.

  • application/xml - Define an XML output document in the Manual Mapping field and use path expressions to get values from response.

Map API response to the document

You can select Map API response to the document to define different document format with values from API response using path expressions.

This option is available when the application/json and the application/xml response content type is available in API.

To identify the path expression, use one of these elements:

  • For the outgoing document of JSON Coventional type use “IonApiRef”
  • For the outgoing document of BOD type use <IonApiRef>

The value of these elements must be Xpath or JSONPath per type of API response.

See the examples in Examples of JSON Path or Xpath in body mapping