Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "RTP/REST"
< RTP
| Line 1: | Line 1: | ||
| + | =RTP REST API= | ||
| + | |||
| + | The core idea behind the REST APIs is to allow for Remote Provisioning of any RTP-components to an Eclipse RTP based runtime. Below you can find a list with all available REST API. | ||
| + | |||
'''Lists all available components''' | '''Lists all available components''' | ||
| − | + | GET /list | |
| − | Response | + | //Response |
Status 200 OK | Status 200 OK | ||
Content: in JSON format specified here | Content: in JSON format specified here | ||
| Line 9: | Line 13: | ||
'''Lists all available and installed components''' | '''Lists all available and installed components''' | ||
| − | + | GET /list/installed | |
| − | Response | + | //Response |
Status 200 OK | Status 200 OK | ||
Content: in JSON format specified here | Content: in JSON format specified here | ||
| − | |||
'''Lists all available and not installed components''' | '''Lists all available and not installed components''' | ||
| − | + | GET /list/uninstalled | |
| − | Response | + | //Response |
Status 200 OK | Status 200 OK | ||
Content: in JSON format specified here | Content: in JSON format specified here | ||
| − | |||
'''Shows details of specific components. The value for the 'query' parameter is used to select the components.''' | '''Shows details of specific components. The value for the 'query' parameter is used to select the components.''' | ||
| − | + | GET /show?query="some query" | |
| − | Response | + | //Response |
Status 200 OK | Status 200 OK | ||
Content: in JSON format specified here | Content: in JSON format specified here | ||
| Line 35: | Line 37: | ||
'''Lists the available components which where searched. A phonetic search is done.''' | '''Lists the available components which where searched. A phonetic search is done.''' | ||
| − | + | GET /search?query="some query" | |
| − | Response | + | //Response |
Status 200 OK | Status 200 OK | ||
Content: in JSON format specified here | Content: in JSON format specified here | ||
| − | |||
'''Installs a component. If no version provided the latest available version will be installed.''' | '''Installs a component. If no version provided the latest available version will be installed.''' | ||
| − | + | PUT /install/<id>/<version> (E.g. /install/rap/1.5.0) | |
| − | Response | + | //Response |
Status 200 OK //uninstall was successfull | Status 200 OK //uninstall was successfull | ||
Status 500 //installation wasn't successfull. In this case content contains the exception's stack trace | Status 500 //installation wasn't successfull. In this case content contains the exception's stack trace | ||
| − | |||
'''Updates all installed componets to their latest version.''' | '''Updates all installed componets to their latest version.''' | ||
| − | + | PUT /updateworld | |
| − | Response | + | //Response |
Status 200 OK //udpate was successfull | Status 200 OK //udpate was successfull | ||
Status 500 //udpate wasn't successfull. In this case content contains the exception's stack trace | Status 500 //udpate wasn't successfull. In this case content contains the exception's stack trace | ||
| Line 61: | Line 61: | ||
'''Uninstalls a component. If no version provided the latest available version will be uninstalled.''' | '''Uninstalls a component. If no version provided the latest available version will be uninstalled.''' | ||
| − | + | DELETE /uninstall/<id>/<version> (E.g. /uninstall/rap/1.5.0) | |
| − | Response | + | //Response |
Status 200 OK //uninstall was successfull | Status 200 OK //uninstall was successfull | ||
Status 500 //uninstall wasn't successfull. In this case content contains the exception's stack trace | Status 500 //uninstall wasn't successfull. In this case content contains the exception's stack trace | ||
Revision as of 15:44, 15 May 2012
RTP REST API
The core idea behind the REST APIs is to allow for Remote Provisioning of any RTP-components to an Eclipse RTP based runtime. Below you can find a list with all available REST API.
Lists all available components
GET /list
//Response Status 200 OK Content: in JSON format specified here
Lists all available and installed components
GET /list/installed
//Response Status 200 OK Content: in JSON format specified here
Lists all available and not installed components
GET /list/uninstalled
//Response Status 200 OK Content: in JSON format specified here
Shows details of specific components. The value for the 'query' parameter is used to select the components.
GET /show?query="some query"
//Response Status 200 OK Content: in JSON format specified here
Lists the available components which where searched. A phonetic search is done.
GET /search?query="some query"
//Response Status 200 OK Content: in JSON format specified here
Installs a component. If no version provided the latest available version will be installed.
PUT /install/<id>/<version> (E.g. /install/rap/1.5.0)
//Response Status 200 OK //uninstall was successfull Status 500 //installation wasn't successfull. In this case content contains the exception's stack trace
Updates all installed componets to their latest version.
PUT /updateworld
//Response Status 200 OK //udpate was successfull Status 500 //udpate wasn't successfull. In this case content contains the exception's stack trace
Uninstalls a component. If no version provided the latest available version will be uninstalled.
DELETE /uninstall/<id>/<version> (E.g. /uninstall/rap/1.5.0)
//Response Status 200 OK //uninstall was successfull Status 500 //uninstall wasn't successfull. In this case content contains the exception's stack trace