Developer Guide

6.1
- 6.2
- 6.1.2

Back Next

Request Header

When you construct a REST API request header, use the following format:

<METHOD> <Server URL>/rulepoint/api/<URI>
Content-Type: application/<json|xml>
Accept: application/<json|xml>
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: <projects/project ID>. Use this URI to refer to a project with this project ID. projects/project ID/<object_type>. Use this URI to refer to objects of the specified object type within a project. projects/project ID/<object_type>/<object ID>. Use this URI to refer to an object with a specific ID in the object category.

The following table includes the request headers:

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

Rename Saved Search

Table of Contents

Developer Guide

Developer Guide

Request Header

Request Header