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

Update Users

Update Users

Use the GET method to update a user in RulePoint.

GET Request in JSON Format

Generate a GET request. For example, the following GET request updates a user in a RulePoint application:
GET http://localhost:8080/rulepoint/api/users Accept: application/json Content-Type: application/json Cookie: JSESSIONID=<VALID SESSION ID>

GET Body in JSON Format

{ "userName": "newuser1", "password": "newuser1234", "firstName": "new", "lastName": "user1111", "roles": [ { "rel": "roles", "href": "/api/roles/ROLE_ADMIN", "title": "Predefined Admin Role", "id": "ROLE_ADMIN" }, { "rel": "roles", "href": "/api/roles/ROLE_USER", "title": "Predefined User Role", "id": "ROLE_USER" } ], "remoteUser": false }

GET Response in JSON Format

Returns the user object and response code. Returns the error object if an error occurs.
{ "id": "98304", "self": { "rel": "self", "href": "/api/users/newuser1", "title": "newuser1", "id": "newuser1" }, "actions": [ { "rel": "update", "href": "/api/users/", "type": "PUT" }, { "rel": "delete", "href": "/api/users/newuser1", "type": "DELETE" } ], "lastModifiedDate": "2013-09-18T18:24:21+05:30", "createDate": "2013-09-18T18:24:21+05:30", "modifiedBy": "Administrator", "createdBy": "Administrator", "userName": "newuser1", "password": "*****", "firstName": "new", "lastName": "user1111", "roles": [ { "rel": "roles", "href": "/api/roles/ROLE_ADMIN", "title": "Predefined Admin Role", "id": "ROLE_ADMIN" }, { "rel": "roles", "href": "/api/roles/ROLE_USER", "title": "Predefined User Role", "id": "ROLE_USER" } ], "enabled": true, "predefined": false, "remoteUser": false }
Response Code : 204 OK

GET Request in XML Format

Generate a GET request. For example, the following GET request updates a user in a RulePoint application:
GET http://localhost:8080/rulepoint/api/users Accept: application/xml Content-Type: application/xml Cookie: JSESSIONID=<VALID SESSION ID>

GET Body in XML Format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <user> <enabled>true</enabled> <firstName>new</firstName> <lastName>user1111</lastName> <password>userzzz123</password> <predefined>false</predefined> <remoteUser>false</remoteUser> <roles> <href>/api/roles/ROLE_ADMIN</href> <id>ROLE_ADMIN</id> <rel>roles</rel> <title>Predefined Admin Role</title> </roles> <roles> <href>/api/roles/ROLE_USER</href> <id>ROLE_USER</id> <rel>roles</rel> <title>Predefined User Role</title> </roles> <userName>newuser1</userName> </user>

GET Response in XML Format

Returns the project object and response code. Returns the error object if an error occurs.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <results> <count>1</count> <items> <user> <actions> <action> <href>/api/users/</href> <rel>update</rel> <type>PUT</type> </action> </actions> <id>1</id> <self> <href>/api/users/Administrator</href> <id>Administrator</id> <rel>self</rel> <title>Administrator</title> </self> <createDate/> <createdBy>Informatica Corp.</createdBy> <enabled>true</enabled> <firstName>System</firstName> <lastModifiedDate/> <lastName>Administrator</lastName> <password>*****</password> <predefined>true</predefined> <remoteUser>false</remoteUser> <roles> <href>/api/roles/ROLE_ADMIN</href> <id>ROLE_ADMIN</id> <rel>roles</rel> <title>Predefined Admin Role</title> </roles> <roles> <href>/api/roles/ROLE_USER</href> <id>ROLE_USER</id> <rel>roles</rel> <title>Predefined User Role</title> </roles> <userName>Administrator</userName> </user> <user> <actions> <action> <href>/api/users/</href> <rel>update</rel> <type>PUT</type> </action> <action> <href>/api/users/AT_User1</href> <rel>delete</rel> <type>DELETE</type> </action> </actions> <id>32773</id> <self> <href>/api/users/AT_User1</href> <id>AT_User1</id> <rel>self</rel> <title>AT_User1</title> </self> <createDate/> <createdBy>Administrator</createdBy> <enabled>true</enabled> <firstName>Atuser</firstName> <lastModifiedDate/> <lastName>Atuserlastname</lastName> <modifiedBy>Administrator</modifiedBy> <password>*****</password> <predefined>false</predefined> <remoteUser>false</remoteUser> <roles> <href>/api/roles/AT_Role2</href> <id>AT_Role2</id> <rel>roles</rel> <title>Role creation for AT</title> </roles> <userName>AT_User1</userName> </user> </items> <total>1</total> </results>
Response Code : 200 OK

0 COMMENTS

We’d like to hear from you!