Developer Guide

2.3.2
- 2.5.0
- 2.4.0
- 2.3.1
- 2.3.0

Back Next

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 a REST API request header, use the following format:

<METHOD> <Server URL>/api/<URI>
Content-Type: application/json
Accept: application/json
Cookie: $Version=1; JSESSIONID=<Valid_session_ID>

The following table includes the request components:

Request Component	Required/Optional	Description
METHOD	Required	Method you want to use, such as GET, POST, PUT, or DELETE.
Server URL	Required	Base URL for all resources, which include the hostname and port.
URI	Required for most resources	The resource URI. The format of a resource URI is one of the following: <BASE URL>/dataflows . Use this URI to access dataflows,source services, target services,connections, aggregator, links, and transformations. <BASE URL>/nodes . Use this URI to access nodes. <BASE_URI>/nodegroups . Use this URI to access node groups. <BASE_URI>/parameters . Use this URI to access parameters. The Base URL is http://<hostname>:<port>/administrator/api

The following table includes the request headers:

Header	Required/Optional	Description
Content-Type	Required for POST requests	Format of the request. Use the following option: - application/json. Reads request as JSON.
Accept	Optional	Request format that you want. Use the following option: - application/json. Sends response as JSON.
Cookie	Required	Sets the valid session ID as a cookie while a client makes a REST call to any of the resources of VDS. Make the /dtlogin REST call to obtain the session ID. The session ID is set as the JSESSIONID cookie.

Rename Saved Search

Table of Contents

Developer Guide

Developer Guide

Request Header

Request Header