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

RulePoint REST API Overview

RulePoint REST API Overview

The RulePoint REST API is a Representational State Transfer (REST) API.
The RulePoint REST API allows you to use API calls to perform the following tasks in RulePoint:
  • Create, update, retrieve, and delete projects.
  • Create, update, retrieve, and delete objects.
  • Perform deployment tasks for objects.
  • Create, update, retrieve, and delete users.
You can access the REST APIs through the following base URL:
http://<localhost>:<port>/rulepoint/api
When you use the REST API to configure a request, use the appropriate resource, method, the applicable date and time values, object ID, along with the applicable headers. Use the applicable format for the request header and body component. RulePoint supports XML and JSON formats for passing the attributes. RulePoint performs the requested task and returns the http response, or returns an error object and related messages.
For more information on the request and response format for specific RulePoint resources, see the sample XML and JSON requests and responses.

0 COMMENTS

We’d like to hear from you!