Portlet Factory, Version 6.1.2

---

 

REST Service Call builder results variables

The REST Service Call builder can create variables to hold the result and header data.

buildername_reply

If the service call has results, this variable is created to hold the result data.

The variable name is generated using the builder call name plus _reply. For example, if your builder call name is getWeather, the generated result variable name is getWeather_reply. Alternatively, you can refer to the results through a data service name (for example, DataServices/getWeather/execute/results).

You have the following options for associating the results variable with a schema.

• If the reply is expected to be XML, use the Reply Schema Type input.

  This input allows you to set the type of the reply variable according to the type of a schema defined in the current model.

• To specify that this builder should automatically create a schema that describes the result data from the service call, use the Auto Create Schema input.

  Automatic schema creation is done by fetching sample data at model-generation time and building a schema from the sample data. If the schema generated by this option does not meet your needs, manually set the reply schema type with the Reply Schema Type input.

buildername_replyHeaders

This XML variable holds the HTTP response headers from the HTTP request. It is created regardless of whether the service call has results.The variable name is generated using the builder call name plus _replyHeaders. The response headers data also include the HTTP response message and response code. The following code shows typical HTTP response header data.

<HTTPResponseHeaders>
  <ResponseCode>200</ResponseCode>
  <ResponseMessage>OK</ResponseMessage>
  <Proxy-Connection>Keep-Alive</Proxy-Connection>
</HTTPResponseHeaders>

Parent topic: REST Service Call builder

---

Library | Support |