The assign variable policy can be used to parse the message body to make the various parts of the message available as variables which can be used further in the proxy pipeline.
The message body could be any of the following:
- request to proxy
- response from target server
- response from any external service call outs
For example, a service call made to Google Location JSON service can be parsed to obtain the variables latitude and longitude of a location and can be used further in the flow to build the request to the target server/another service call or response to the client.
This policy is preferred for simple transformations on huge data when used along with Build Message policy. For complex transformations, below policies or combination of those policies is preferred:
Configuration
To add a variable, perform the following actions in the Assign Variable Policy Configuration page:
- Click Add button present at the lower-right part of the page; a default variable gets added under Variable panel.
Click the newly added variable name to configure source information; Source drop-down appears on the right side of the Variable panel.
- Click the Source drop-down to select the source from the following options that appear in the list:
- QUERY_PARAM
- FORM_PARAM
- PATH_PARAM
- HEADER
- VARIABLE
- PAYLOAD
- CONSTANT
- JAVASCRIPT
- Provide the substantiating values for the respective source, which appears as you select the source.
Click Save to complete assigning the variable.
Below figure shows how to add variable (click the image for enlarged view).
|
Figure 1: Adding variable to assign Variable policy
Source
Source attribute helps to provide extra information which can be used by the Variable parameters that are added. Sources are of different types which may be specified as per requirement. Below sections explain the same.
Query Param
Provide parameter name in the Param Name field. The value of the query parameter is copied to the variable. Enable Ignore Case property in case you do not prefer the name to be Case Sensitive.
Figure 2: Query Param source properties
Form Param
Provide parameter name in the Param Name field. The value of the form parameter is copied to the variable. Enable Ignore Case property in case you do not prefer the name to be Case Sensitive.
Figure 3: Form Param source properties
Path Param
Provide path pattern in the Pattern Name property value. This Path will be used by the variable parameter.
Enable Ignore Case property in case you do not prefer the name to be Case Sensitive.
Figure 4: Path Param source properties
Header
Provide parameter name in the Param Name field. This Header parameter will be used by the variable parameter.
Enable Ignore Case property in case you do not prefer the name to be Case Sensitive.
Figure 5: Header source properties
Variable
Provide parameter name in the Param Name field, and enable Ignore Case property in case you do not prefer the name to be Case Sensitive.
Figure 6: Variable source properties
Payload
Provide a JSON Path value in the JSON Path field to insert the JSON message content to the variable parameter.
Figure 7: Payload source properties
Choose Is XML option to provide XPath and thereby insert XML in the Variable parameter. To provide Namespaces for the prefixes used in the XPath expression, click the Add 
button present next to the Namespaces table.
Figure 8: Is XML option under Payload source properties
Constant
Provide a value for the Constant in the Value editor to be used by the Variable parameter.
Figure 9: Constant source properties
Choose Use Variable option to provide variable prefix and suffix in the Variable Prefix and Variable suffix fields respectively.
Figure 10: Use Variables option under Constant source properties
JavaScript
Provide the script in the Value editor under Source drop-down for the Variable parameter to use.
Figure 11: JavaScript source properties
The Java script option can be used when there is a need to perform some complex manipulation instead of simple concatenation which is performed by constant.
To use this option, the script must contain a function which returns a string. This method must be called inside the java script block as shown in line no. 8.
The function can use the variable context which can be used to inject the context of the request. The variable context supports the following methods.
Examples
Extracting JSON elements
In the example Customizing API Response, different parts of the JSON response from target server are extracted using this policy.
Using Java Script
In the example Invoking OAuth and Caching Access Tokens, to calculate and assign the variable to determine whether the token exists in cache or not, java script variant is used.