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
(→RTP REST API) |
(→RTP REST API) |
||
| Line 9: | Line 9: | ||
//Response | //Response | ||
Status 200 OK | Status 200 OK | ||
| − | Content: in JSON format specified here | + | Content: [http://wiki.eclipse.org/RTP/Configuration-Format in JSON format specified here] |
'''Lists all available and installed components''' | '''Lists all available and installed components''' | ||
| Line 17: | Line 17: | ||
//Response | //Response | ||
Status 200 OK | Status 200 OK | ||
| − | Content: in JSON format specified here | + | Content: [http://wiki.eclipse.org/RTP/Configuration-Format in JSON format specified here] |
'''Lists all available and not installed components''' | '''Lists all available and not installed components''' | ||
| Line 25: | Line 25: | ||
//Response | //Response | ||
Status 200 OK | Status 200 OK | ||
| − | Content: in JSON format specified here | + | Content: [http://wiki.eclipse.org/RTP/Configuration-Format 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.''' | ||
| Line 33: | Line 33: | ||
//Response | //Response | ||
Status 200 OK | Status 200 OK | ||
| − | Content: in JSON format specified here | + | Content: [http://wiki.eclipse.org/RTP/Configuration-Format in JSON format specified here] |
'''Lists the available components which where searched. A phonetic search is done.''' | '''Lists the available components which where searched. A phonetic search is done.''' | ||
| Line 41: | Line 41: | ||
//Response | //Response | ||
Status 200 OK | Status 200 OK | ||
| − | Content: in JSON format specified here | + | Content: [http://wiki.eclipse.org/RTP/Configuration-Format 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.''' | ||
Latest revision as of 08:20, 21 May 2012
RTP REST API
The core idea behind the RTP-REST API is to allow remote provisioning of any RT-components into an Eclipse RTP based runtime. Below is a list with all available services if the 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