PluginResource
The following resources are applicable:
- /plugins
- /plugins/available
- /plugins/install/{id}
- /plugins/installed
- /plugins/install-package
- /plugins/install-package.html
- /plugins/overview
- /plugins/uninstall/{id}
- /plugins/update/{id}
- /plugins/updates
/plugins
Mount Point: /api/rest/plugins
GET
Returns all plugins.
- 200 success
- 500 internal server error
Response Body
element: | (custom) |
media types: | application/xml application/json |
all plugins
/plugins/available
Mount Point: /api/rest/plugins/available
GET
Returns all available plugins.
- 200 success
- 500 internal server error
Response Body
element: | (custom) |
media types: | application/xml application/json |
all available plugins
/plugins/install/{id}
Mount Point: /api/rest/plugins/install/{id}
POST
Installs a plugin.
- 200 success
- 500 internal server error
Parameters
name | description | type | default |
---|---|---|---|
id | id of the plugin to be installed | path |
Response Body
element: | (custom) |
media types: | */* application/xml |
(no documentation provided)
/plugins/installed
Mount Point: /api/rest/plugins/installed
GET
Returns all installed plugins.
- 200 success
- 500 internal server error
Response Body
element: | (custom) |
media types: | application/xml application/json |
all installed plugins
/plugins/install-package
Mount Point: /api/rest/plugins/install-package
POST
Installs a plugin from a package.
- 200 success
- 412 precondition failed
- 500 internal server error
Parameters
name | description | type | default |
---|---|---|---|
uploadedInputStream | (no documentation provided) | formdata |
Response Body
element: | (custom) |
media types: | application/xml application/json |
(no documentation provided)
/plugins/install-package.html
Mount Point: /api/rest/plugins/install-package.html
POST
Installs a plugin from a package. This method is a workaround for ExtJS
file upload, which requires text/html as content-type.
- 200 success
- 412 precondition failed
- 500 internal server error
Parameters
name | description | type | default |
---|---|---|---|
uploadedInputStream | (no documentation provided) | formdata |
Response Body
element: | (custom) |
media types: | text/html |
(no documentation provided)
/plugins/overview
Mount Point: /api/rest/plugins/overview
GET
Returns all plugins for the overview.
- 200 success
- 500 internal server error
Response Body
element: | (custom) |
media types: | application/xml application/json |
all plugins for the overview
/plugins/uninstall/{id}
Mount Point: /api/rest/plugins/uninstall/{id}
POST
Uninstalls a plugin.
- 200 success
- 500 internal server error
Parameters
name | description | type | default |
---|---|---|---|
id | id of the plugin to be uninstalled | path |
Response Body
element: | (custom) |
media types: | */* application/xml |
(no documentation provided)
/plugins/update/{id}
Mount Point: /api/rest/plugins/update/{id}
POST
Updates a plugin.
- 200 success
- 500 internal server error
Parameters
name | description | type | default |
---|---|---|---|
id | id of the plugin to be updated | path |
Response Body
element: | (custom) |
media types: | */* application/xml |
(no documentation provided)
/plugins/updates
Mount Point: /api/rest/plugins/updates
GET
Returns all plugins which are available for update.
- 200 success
- 500 internal server error
Response Body
element: | (custom) |
media types: | application/xml application/json |
all plugins which are available for update