- This line was added.
- This line was removed.
- Formatting was changed.
Occasionally, the need arises to use values created in one transformation in another transformation, for example, a sessionID returned from a login web service is required when calling subsequent web services for authentication purposes.
The need can also arise to use values created in one part of a transformation at a later stage in that transformation, for example, RecordNumber is initialized and incremented for every record inserted into a target to identify its item number.
Sometimes, we need to use values returned in one transformation in the definition settings of subsequent operations, for example, the URL setting returned by one transformation is used to set the Web Service URL of a subsequent web service call.
In all of these instances, you can use global variables to share the information in question with other parts of the operation or transformation. However, please note that global variables are only available for chained operations, that is, subsequent operations called from the operation that created the global variables using On Success and On Failure operation settings. Global Variables can also be used within the same transformation. See Using Global Variables for instructions to create global variables.
The following predefined API global variables are currently available in Jitterbit.
jitterbit.api.request.body and jitterbit.api.request.body.*
Looks at the payload/payloads submitted to the API. Note that for the majority of the APIs, you would only expect one plain payload and, as such, jitterbit.api.request.body is the variable to use (aka content-type:text/plain).
If you expect multiple payloads to be submitted at once, using URL-encoded form (aka content-type:application/x-www-form-urlencoded) such as in the case of API being used as the backend of a submission form, see http://www.w3.org/TR/html401/interact/forms.html), then you should be using jitterbit.api.request.body.*. Much like the jitterbit.api.request.parameters.* below, jitterbit.api.request.body.name will be equal to EStore if the value of the form's field "name" was entered as EStore.
Variable array used to dynamically iterate through all of the submitted parts of the payload/body (versus checking a specific part as with jitterbit.api.request.body.* above). The usage is the same as with the jitterbit.api.request.enum.parameters.
Variable used to look at the request headers submitted to the API; i.e. $jitterbit.api.request.headers.x_forwarded_for is the public IP of the box/user accessing the URL.
This variable returns the URL that was called to trigger the Jitterbit OData or Custom API.
Variable array used to dynamically iterate through all of the request headers (versus checking specific headers as with jitterbit.api.request.headers.* below). The usage is the same as with the jitterbit.api.request.enum.parameters and jitterbit.api.request.enum.body.
|jitterbit.api.request.method||String||This variable returns the request method that was used to call the API.|
Looks at the parameters submitted to the API directly via the URL; i.e.jitterbit.api.request.parameters.name will be equal to EStore if the URL requested had &name=EStore
NOTE: Multi-value URL parameters will return a string delimited by "|||" (3 pipes). To return multi-value URL parameters as an array, use the jitterbit.api.request.mvparameters* variable instead.
Example of multi-value parameters: If the URL is https://jitterbitxx.na.jitterbit.org/dev/ProductAPIResponse?ProdID=abc&ProdID=abc1&ProdID=abc2, then jitterbit.api.request.parameters.ProdID will be equal to: abc|||abc1|||abc2.
Variable array used to dynamically iterate through all of the submitted parameters (as opposed to checking each parameter specifically as jitterbit.api.request.parameters.name).
Below is a sample script implementation that appends all of the provided parameters to a new variable for later display back to the user:
$output = "URL Parameters: <br>\r\n";
Looks at the multi-values of the parameter submitted to the API directly via the URL and returns the values as an array with a space between each value.
Example: If the URL is https://jitterbitxx.na.jitterbit.org/dev/ProductAPIResponse?ProdID=abc&ProdID=abc1&ProdID=abc2, then jitterbit.api.request.mvparameters.ProdID will be equal to: abc abc1 abc2.
|$jitterbit.api.request.enum.mvparameters||String||Variable Variable array used to dynamically iterate through all of the multi-value parameters (as opposed to checking each parameter specifically as jitterbit.api.request.mvparameters.ProdID).|
This variable needs to be set if you have set your API to use variable as the response versus final target.
Used to set the response headers of the API; i.e. $jitterbit.api.response.headers.access_control_allow_origin="*" to override default CORS behavior and allow the API to be accessed by any domain in a cross-site manner.
|$jitterbit.api.response.status_code||String||Variable providing the ability to override HTTP response code for custom APIs via Jitterbit script variable. Set the $jitterbit.api.response.status_code variable in the script that is executed by a Custom API. This allows project authors to set a specific HTTP error code (along with actual payload information) versus relying on the system to return codes 200 or 500 based on default behavior.|