Skip to main content

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.

Jump to: navigation, search

Difference between revisions of "RTP/REST"

< RTP
(New page: = RTP REST API = '''Lists all available components''' * GET /list Response Status 200 OK Content: in JSON format specified here with all available components '''Lists all available ...)
 
(RTP REST API)
Line 1: Line 1:
= RTP REST API =
 
 
 
'''Lists all available components'''
 
'''Lists all available components'''
  

Revision as of 15:49, 14 May 2012

Lists all available components

  • GET /list

Response

Status 200 OK
Content: in JSON format specified here with all available components


Lists all available and installed components

  • GET /list/installed

Response

Status 200 OK
Content: in JSON format specified here with all available and installed components


Lists all available and not installed components

  • GET /list/uninstalled

Response

Status 200 OK
Content: in JSON format specified here with all available and not installed components


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 with all components that match the query value

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 with all components that where searched


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 /install/<id>/<version> (E.g. /install/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

Back to the top