Request page of the REST step in (DataStage®)
On the Request page of the REST step, you can specify the request body of the REST step as a text, a binary data, or as a file.
- A text node named body on the Mappings page
- Select if the HTTP request body is text data. If you select this option, the body node is created in the target schema on the Mappings page and the node needs to be mapped to a text input data field or a fixed string.
- A binary node named body on the Mappings page
- Select if the HTTP request body is binary data. If you select this option, the body node of binary type is created in the target schema on the Mappings page and the node needs to be mapped to a binary input data field.
- A file whose path is set on the Mappings page as bodyFilePath
- If you select this option, the bodyFilePath node is created in the target schema on the Mappings page, and the node must be mapped to a text input data field or a fixed string that contains file path.
- Content type
Select the content type and the encoding type for the request.
- Compress the body before sending
- Select to send the HTTP request body to the REST service as compressed. The request body supports only the .gzip format.
- Custom headers
- Specify the headers for the HTTP request in the Name field. HTTP headers
are name and value pairs that are separated by a colon, for example, name:value.
If you add HTTP headers in the Custom headers field, ensure that the header
names are unique. You can specify an HTTP header as text by clicking the Text
view tab.
To set a constant value for the header, specify the constant value in the Default value field. Select the Map option to map the header on the Mappings page. If the Null to value option is selected, you can set a default value for the header that is used if the source column that is mapped to the header contains no data.
- Custom cookies
- Specify the cookies to the HTTP request in the Name field. HTTP cookie is
a token or packet of status information that the HTTP agent and the target server can exchange to
maintain a session. The state information consists of name-value pairs for attributes such as
version, domain, a path that specifies the subset of URLs on the origin server to which the cookie
applies, and the maximum time for which the cookie is valid. You can specify as HTTP cookie as text
by clicking the Text view tab.
To set a constant value for the cookie, specify the value in the Default value field. Select the Map option to map the cookie on the Mappings page. If the Null to value option is selected, you can set a default value for the cookie that is used if the source column that is mapped to the cookie contains no data.