THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
Old URL | New URL | Comment |
|---|---|---|
POST /task/create/sync | POST /tasks | Creates a new sync task. |
GET /task/read/{taskId} | GET /tasks/sync/{taskId} | Returns sync task with matching id. |
GET /task/sync/list | GET /tasks/sync/list | Returns a list of sync tasks. |
GET /task/sync/list/{page}/{size} | GET /tasks/sync?page={page}&size={size} | Returns a list of paginated sync tasks. |
GET /task/sync/count | GET /tasks/sync/count | Returns number of sync tasks. |
POST /task/update/sync | PUT /tasks/{taskId} | Updates sync task with matching id. |
GET /task/sync/execution/list | GET /tasks/sync/executions | Returns list of sync task executions. |
Old URL | New URL | Comment |
POST /task/create/sched | POST /tasks | Creates a new sched task. |
GET /task/read/{taskId} | GET /tasks/sched/{taskId} | Returns sched task with matching id. |
GET /task/sched/list | GET /tasks/sched/list | Returns a list of sched tasks. |
GET /task/sched/list/{page}/{size} | GET /tasks/sched?page={page}&size={size} | Returns a list of paginated sched tasks. |
GET /task/sched/count | GET /tasks/sched/count | Returns number of sched tasks. |
POST /task/update/sched | PUT /tasks/{taskId} | Updates sched task with matching id. |
GET /task/sched/execution/list | GET /tasks/sched/executions | Returns list of sched task executions. |
Old URL | New URL | Comment |
GET /task/read/{taskId} | GET /tasks/propagation/{taskId} | Returns propagation task with matching id. |
GET /task/propagation/list | GET /tasks/propagation/list | Returns a list of propagation tasks. |
GET /task/propagation/list/{page}/{size} | GET /tasks/propagation?page={page}&size={size} | Returns a list of paginated propagation tasks. |
GET /task/propagation/count | GET /tasks/propagation/count | Returns number of propagation tasks. |
GET /task/propagation/execution/list | GET /tasks/propagation/executions | Returns list of propagation task executions. |
Old URL | New URL | Comment |
GET /task/read/{taskId} | GET /tasks/notification/{taskId} | Returns notification task with matching id. |
GET /task/notification/list | GET /tasks/notification/list | Returns a list of notification tasks. |
GET /task/notification/list/{page}/{size} | GET /tasks/notification?page={page}&size={size} | Returns a list of paginated notification tasks. |
GET /task/notification/count | GET /tasks/notification/count | Returns number of notification tasks. |
GET /task/notification/execution/list | GET /tasks/notification/executions | Returns list of notification task executions. |
Old URL | New URL | Comment |
GET /task/delete/{taskId} | DELETE /tasks/{taskId} | Deletes task with matching id. |
GET /task/execution/read/{executionId} | GET /tasks/executions/{executionId} | Returns execution of task with matching id. |
POST /task/execute/{taskId}?dryRun={dryRun} | POST /tasks/{taskId}/execute?dryRun={dryRun} | Executes task with matching id. |
GET /task/execution/delete/{executionId} | DELETE /tasks/executions/{executionId} | Deletes execution of task with matching id. |
GET /task/jobClasses | GET /tasks/jobClasses | Returns a list of available jobClasses. |
GET /task/syncActionsClasses | GET /tasks/syncActionsClasses | Returns a list of available syncActionsClasses. |
GET /task/execution/report/{executionId} | POST /tasks/executions/{executionId}/report | Creates a new report for matching execution id. |
User Service
| Note | ||
|---|---|---|
| ||
User Service Interface in Version 1.1.0 is still not applying some major RESTful best practices. Therefore refactoring for release >= 1.2.0 is most likely. |
CRUD operations:
Old URL | New URL | Comment |
|---|---|---|
POST /user/create | POST /users | Creates a new user. (Returns URL to new user definition) |
GET /user/list | GET /users | Returns a list of all known users |
GET /user/list/{page}/{size} | GET /users?page={page}&size={size} | Returns a list of known users matching page/size conditions |
GET /user/read/{userId} | GET /users/{userId} | Returns a single user matching the provided userId |
GET /user/readByUsername/{username} | GET /users;uname?username={username} | Returns a single user matching the provided username |
POST /user/search | POST /users/search | Returns a list of user matching the provided search conditions. |
POST /user/search/{page}/{size} | POST /users/search?page={page}&size={size} | Returns a list of user matching the provided page/size and search conditions. |
GET /user/count | GET /users/count | Returns a number of existing users. |
POST /user/search/count | POST /users/search/count | Returns a number of user matching the provided search conditions. |
GET /user/verifyPassword/{username}?password={password} | GET /users;uname?username={username};&pwd={password} | Returns user if username and password match with an existing account. |
POST /user/update | POST /users/{userId} | Updates user. (POST is used here instead of PUT, because UserMod only contains changes for a user and not a complete representation thereof.) |
GET /user/delete/{userId} | DELETE /users/{userId} | Deletes user. |
GET /deleteByUsername/{username} | <<removed>> | Please use 'GET /user;uname?username={username}' to discover userId and then use 'DELETE /user/{userId}' to delete user. |
...
Old URL | New URL | Comment | |
|---|---|---|---|
GET /user/activate/{userId} | POST /users/{userId}/status/activate | Activates matching user account Post a new StatusMod element with status ACTIVATE. | |
GET /user/activateByUsername/{username} | <<removed>> | POST /user/activateByUsername/{username} | Activates matching Please use 'GET /user;uname={username}' to discover userId and then use 'POST /user/{userId}/status' to enable user account. |
GET /user/reactivate/{userId} | POST /users/{userId}/status/reactivate | Post a new StatusMod element with status REACTIVATE Reactivates new user account. | |
GET /user/reactivateByUsername/{username} | <<removed>> | POST /user/reactivateByUsername/{username} | Reactivates new Please use 'GET /user;uname={username}' to discover userId and then use 'POST /user/{userId}/status' to reactivate user account. |
GET /user/suspend/{userId} | POST /users/{userId}/status/suspend | Suspends user account Post a new StatusMod element with status SUSPEND. | |
GET /user/suspendByUsername/{username} | <<removed>> | POST /user/suspendByUsername/{username} | Suspends Please use 'GET /user;uname={username}' to discover userId and then use 'POST /user/{userId}/status' to suspend user account. |
Workflow actions: TODO: Is this a good design decision? Should these activities be moved to WorkflowController?
Old URL | New URL | Comment |
|---|---|---|
GET /user/workflow/form/list | GET /users/workflow/form | Returns a list of user workflow forms. |
GET /user/workflow/form/{userId} | GET /users/{userId}/workflow/form | Returns a (single) workflow form assigned to user. |
POST /user/workflow/form/submit | POST /users/workflow/form | Submittes a form to a user workflow. |
POST /user/execute/workflow/{taskId} | POST /users/workflow/tasktasks/{taskId}/execute | Executes workflow task on user. |
GET /workflow/form/claim/{taskId} | POST /users/workflow/tasktasks/{taskId}/claim | Claims workflow task for authenticated (session) user. |
...