Table of Contents

Search

  1. Preface
  2. Introduction to Business Entity Services
  3. EJB Business Entity Service Calls
  4. REST Business Entity Service Calls
  5. REST APIs for Data Director
  6. SOAP Business Entity Service Calls
  7. Cross-reference Records and BVT Calculations Services
  8. Supporting Corporate Linkage Service
  9. External Calls to Cleanse, Analyze, and Transform Data
  10. Appendix A: Using REST APIs to Add Records
  11. Appendix B: Using REST APIs to Upload Files
  12. Appendix C: Using REST APIs to Manage Reports

Request Header

Request Header

Use a request header to define the operating parameters or the metadata of the REST operation. The header consists of a series of field-value pairs. The API request line contains the method and the URL. Specify the header fields after the request line.
To construct the REST API request header, add the header fields after the
<METHOD> <<host>:<port>/<context>/<database ID>/<Path>
request line, as shown in the following example:
<METHOD> <<host>:<port>/<context>/<database ID>/<Path> Content-Type: application/<json/xml> Accept: application/<json/xml>
The following table describes some of the commonly used request header fields:
Request component
Description
Content-Type
Media type of the data in the request. When you include a body in the REST request, you must specify the media type of the body in the Content-Type header field. Include the Content-Type header field in PUT and POST requests.
Accept
Media type of the data in the response. To specify the request format, use
application/<json/xml>
in the header or add
.json
or
.xml
to the URL. Default is XML.

0 COMMENTS

We’d like to hear from you!