THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
| Note | ||
|---|---|---|
| ||
In Syncope 1.1.0 a new REST interface was introduced (referred as new in the following). It is exposed in 1.1.0 by default under The REST interface available in 1.0.X (referred as old in the following) is still present but will be removed from releases >= 1.2.0. It is exposed by default in 1.1.X under Starting with 2.0.0 the Reference Guide is available. |
This page shall give you an overview of old and new REST API.
| Table of Contents |
|---|
Main focus on redesign REST interface was to apply RESTful Best Practices
...
Old URL | New URL | Comment |
|---|---|---|
POST /connector/create | POST /connectors | Creates a new connector instance. |
GET /connector/read/{connectorId} | GET /connectors/{connectorId} | Returns connector with matching id. |
GET /connector/list?lang={lang} | GET /connectors?lang={lang} | Returns a list of all connectors. Default language is English. |
POST /connector/update | PUT /connectors/{connectorId} | Overwrites connector with matching key. |
GET /connector/delete/{connectorId} | DELETE /connectors/{connectorId} | Deletes connector with matching id. |
Old URL | New URL | Comment |
GET /connector/bundle/list?lang={lang} | GET /connectors/bundles?lang={lang} | Returns known bundles. Default language is English. |
POST /connector/schema/list?showall={showall} | POST /connectors/{connectorId}/schemas?showAll={showall} | Returns schema names for connector. Default is showAll=false. |
GET /connector/{connectorId}/configurationProperty/list | GET /connectors/{connectorId}/configuration | Returns configuration for selected connector. |
POST /connector/check | POST /connectors/check | Checks if a connection can be established. |
GET /connector/{resourceName}/readByResource | GET /connectors;resourceName={connectorId} | Returns connector for resourceName. |
POST /connector/reload | POST /connectors/reload | Reload all connector bundles and instances. |
...
Old URL | New URL | Comment |
|---|---|---|
POST /report/create | POST /reports | Creates a new report. |
GET /report/read/{reportId} | GET /reports/{reportId} | Returns report with matching reportId. |
GET /report/list | GET /reports | Returns a list of all reports. |
GET /report/list/{page}/{size} | GET /reports?page={page}&size={size} | Returns a list of reports according to pagination. |
POST /report/count | POST /reports/count | Returns number of existing reports. |
POST /report/update | PUT /reports/{reportId} | Updates report with matching reportId. |
GET /report/delete/{reportId} | DELETE /reports/{reportId} | Deletes report with matching id. |
Old URL | New URL | Comment |
POST /report/execute/{reportId} | POST /reports/{reportId}/execute | Executes report and returns execution result. |
GET /report/execution/read/{executionId} | GET /reports/executions/{executionId} | Returns execution report. |
GET /report/execution/export/{executionId}?fmt={format} | GET /reports/executions/{executionId}/dbDump?format={format} | Returns execution report as an downloadable file. Format is optional. |
GET /report/execution/delete/{executionId} | DELETE /reports/executions/{executionId} | Deletes execution report with matching id. |
Old URL | New URL | Comment |
GET /report/reportletConfClasses | GET /reports/reportletConfClasses | Returns a list of all reportletConfClasses. |
...
Old URL | New URL | Comment |
|---|---|---|
GET /user/activate/{userId} | POST /users/{userId}/status/activate | Activates matching user account. |
GET /user/activateByUsername/{username} | POST /user/activateByUsername/{username} | Activates matching user account. |
GET /user/reactivate/{userId} | POST /users/{userId}/status/reactivate | Reactivates new user account. |
GET /user/reactivateByUsername/{username} | POST /user/reactivateByUsername/{username} | Reactivates new user account. |
GET /user/suspend/{userId} | POST /users/{userId}/status/suspend | Suspends user account. |
GET /user/suspendByUsername/{username} | POST /user/suspendByUsername/{username} | Suspends user account. |
...