Hosted endpoint Jitterbit variables¶
Introduction¶
This page covers Jitterbit variables that are available for hosted endpoints. Each of these are settings variables that you write (Settings).
Settings¶
jitterbit.networking.http.query.ParameterName
¶
Data type¶
String
Description¶
Set when handling a hosted web service call or a Hosted HTTP Endpoint. With ParameterName
substituted by a URL query parameter name, this variable holds the corresponding value. This is for a URL query data of the type ?a=b&c=d
.
jitterbit.networking.http.request.header.HeaderName
¶
Data type¶
String
Description¶
Set when handling a hosted web service call or a Hosted HTTP Endpoint. With HeaderName
substituted by the name of an HTTP header, this variable holds the corresponding value. For example, the variable jitterbit.networking.http.request.header.Content-Type
will hold the mime type of the body of the request.
jitterbit.networking.http.request.method
¶
Data type¶
String
Description¶
When an HTTP Endpoint is called, this variable is set to the method used (GET, PUT, and POST are the most common values).
jitterbit.networking.http.response.content_type
¶
Data type¶
String
Description¶
Set this variable to override the response content type for a Hosted HTTP Endpoint.
Note
Use either $jitterbit.networking.http.response.content_type
or Get("jitterbit.networking.http.response.content-type")
.
jitterbit.networking.http.response.header.HeaderName
¶
Data type¶
String
Description¶
Set when handling an HTTP Endpoint to send back a custom Hosted HTTP header. Can be used to send back HTTP headers such as a location for redirect.
jitterbit.networking.http.response.status_code
¶
Data Type
Integer
Description¶
Set this variable to override the response status code for a Hosted HTTP Endpoint. By default Jitterbit, returns the status code 200. This variable can be used to set a custom success code (2xx), redirect (3xx), client error (4xx), or server error (5xx). Illegal values will revert to 200.
jitterbit.networking.peer.ip
¶
Data type¶
String
Description¶
Set when handling a hosted web service call or a Hosted HTTP Endpoint. Holds the IP number of the host calling the web service or accessing the Hosted HTTP Endpoint.