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

Retrieve Projects

Retrieve Projects

Use the GET method to retrieve a project in RulePoint.

GET Request in JSON Format

Generate a GET request. For example, the following GET request retrieves a project in a RulePoint application:
GET http://localhost:8080/rulepoint/api/projects Accept: application/json Cookie: JSESSIONID=<VALID SESSION ID>

GET Body in JSON Format

{ "name": "TestProject", "description": "Test Project" }

GET Response in JSON Format

Returns the project object and response code 200 OK. Returns the error object if an errors occur.
{ "total": 4, "count": 4, "items": [ { "id": "3", "name": "AT_PROJECT11375183310634", "valid": false, "self": { "rel": "self", "href": "api/projects/3" }, "actions": [ { "rel": "update", "href": "/api/projects/3", "type": "PUT" }, { "rel": "delete", "href": "/api/projects/3", "type": "DELETE" }, { "rel": "deploy", "href": "/api/projects/3/deploy", "type": "POST" }, { "rel": "undeploy", "href": "/api/projects/3/undeploy", "type": "POST" } ], "acl": { "rel": "acl", "href": "api/projects/3/acl", "title": "acl" }, "description": "AT_PROJECT11375183310634" }, { "id": "1", "name": "Default Project", "valid": false, "self": { "rel": "self", "href": "api/projects/1" }, "actions": [ { "rel": "deploy", "href": "/api/projects/1/deploy", "type": "POST" }, { "rel": "undeploy", "href": "/api/projects/1/undeploy", "type": "POST" } ], "acl": { "rel": "acl", "href": "api/projects/1/acl", "title": "acl" }, "description": "Default Rulepoint Project" }, { "id": "5", "name": "HA Scenario", "valid": false, "self": { "rel": "self", "href": "api/projects/5" }, "actions": [ { "rel": "update", "href": "/api/projects/5", "type": "PUT" }, { "rel": "delete", "href": "/api/projects/5", "type": "DELETE" }, { "rel": "deploy", "href": "/api/projects/5/deploy", "type": "POST" }, { "rel": "undeploy", "href": "/api/projects/5/undeploy", "type": "POST" } ], "acl": { "rel": "acl", "href": "api/projects/5/acl", "title": "acl" }, "description": "HA Scenario" }, { "id": "2", "name": "ImportProj1375183310634", "valid": false, "self": { "rel": "self", "href": "api/projects/2" }, "actions": [ { "rel": "update", "href": "/api/projects/2", "type": "PUT" }, { "rel": "delete", "href": "/api/projects/2", "type": "DELETE" }, { "rel": "deploy", "href": "/api/projects/2/deploy", "type": "POST" }, { "rel": "undeploy", "href": "/api/projects/2/undeploy", "type": "POST" } ], "acl": { "rel": "acl", "href": "api/projects/2/acl", "title": "acl" }, "description": "ImportProj1375183310634" } ] }
Response Code : 200 OK

0 COMMENTS

We’d like to hear from you!