Table of Contents

Search

  1. Preface
  2. RulePoint Interfaces
  3. RulePoint Services
  4. Custom Service API
  5. Java Adapter for REST API
  6. RulePoint REST API
  7. Sample XML and JSON Requests and Responses
  8. RulePoint Pluggable Authentication Module
  9. HTTP Request and Response Attributes

Developer Guide

Developer Guide

REST API Guidelines

REST API Guidelines

Use the following guidelines when working with RulePoint REST APIs:
  • Use the JSON format to construct a request.
  • Specify the format of the request and response in the header. Use the Content-Type attribute to specify the request format and the Accept attribute to specify the response format.
  • Use a placeholder for the JSESSIONID in request headers for all resources. Replace the placeholder with the JSESSIONID data returned when you log in to a session.
  • For all resources, use a placeholder for the base URL. Replace the placeholder with the Server URL data returned by the login resource.
  • All resources and attributes are case sensitive.
  • Use the type attribute to define an object in JSON.

0 COMMENTS

We’d like to hear from you!