Syncope's REST API has changed from version <placeholder> to <placeholder>. These (sub)pages will give you an overview of old and new REST URLs.
These changes will only affect REST URLs, content models have not been changed.
Main focus on redesign REST interface was:
- use HTTP operations instead of URL encoded operation names
- use URL parameters for search and filter restrictions
Role Interface
Old URL |
New URL |
Comment |
---|---|---|
GET /role/list |
GET /roles |
Returns a list of all known roles |
GET /role/read/{roleId} |
GET /roles/{roleId} |
Returns a single role definition matching the provided roleID |
GET /role/selfRead/{roleId} |
GET /roles/{roleId} |
Authorization mechanisms will be independent of URL |
GET /role/parent/{roleId} |
GET /roles/{roleId}/parent |
Returns a single parent role definition (if available) |
GET /role/children/{roleId} |
GET /roles/{roleId}/children |
Returns a list of children role definitions |
POST /role/create |
POST /roles/ |
Creates a new (root) role. (Returns URL to new role definition?) |
POST /role/create |
POST /roles/{parentRoleId} |
Creates a new (child) role. Returns new role definition. |
POST /role/update |
PUT /roles/{roleId} |
Updates role. |
GET /role/delete/{roleId} |
DELETE /roles/{roleId} |
Deletes role. |
User Interface
Old URL |
New URL |
Comment |
---|---|---|
GET /user/list |
GET /user |
Returns a list of all known users |
GET /user/list/{page}/{size} |
GET /user?page={page}&size={size} |
Returns a list of known users matching page/size conditions |
GET /user/read/{userId} |
GET /user/{userId} |
Returns a single user matching the provided userId |
GET /user/readByUsername/{username} |
GET /user?uname={username} |
Returns a single user matching the provided username |
POST /user/create |
POST /user/ |
Creates a new user. (Returns URL to new user definition?) |
POST /user/update |
PUT /user/{userId} |
Updates user. |
GET /user/delete/{userId} |
DELETE /user/{userId} |
Deletes user. |
GET /deleteByUsername/{username} |
<<removed>> |
Please use 'GET /user?uname={username}' to discover userId and then use 'DELETE /user/{userId}' to delete user. |