Map

Use the Map policy to apply transformations to your assembly flow and specify relationships between variables.

Gateway support

Table 1. Table showing which gateways support this policy, and the corresponding policy version
Gateway Policy version
DataPower® Gateway (v5 compatible) 1.0.0
DataPower API Gateway 2.0.0

This topic describes how to configure the policy in the assembly user interface; for details on how to configure the policy in your OpenAPI source, see map.

About

Be aware that MAP decodes all parameter values to an ASCII character equivalent. If a MAP parameter contains entries such as %nn, the MAP output contains decoded values.

For information about the structure of a Map policy and its behavior, see The Map policy structure.

For information about configuring a Map policy by using the user interface, see Configuring the Map policy in the user interface.

For examples of YAML representations of different Map policy configurations, see Map policy examples.

You can attach this policy to the following API flows:
  • REST
  • SOAP

Properties

The following table lists the policy properties, indicates whether a property is required, specifies the valid and default values for input, and specifies the data type of the values.

Table 2. Map policy properties
Property label Required Description Data type
Title No The title of the policy. The field is visible when editing inputs.

The default value is map.

string
Description No A description of the policy. The field is visible when editing inputs. string
Inputs Yes A list of variables that are inputs of the policy. array (string)
Outputs Yes A list of variables that are outputs of the policy. array (string)
Value Yes A GatewayScript program to be performed by the policy in order to map its inputs to its outputs, or to set the value of outputs. string
Note: The map policy has other properties that are not displayed in the user interface. For a complete list of properties, see map.