PluginResource Resource

RESTful Web Service Endpoint to manage plugins.

GET /api/rest/plugins

Returns all plugins.

Response Codes
code condition
200 success
500 internal server error
Response Body
media type data type description
application/json array of PluginInformation (JSON) all plugins
application/xml list of pluginInformation (XML)

Example

Request
GET /plugins
Accept: application/json

              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "artifactId" : "...",
  "author" : "...",
  "category" : "...",
  "condition" : {
    "arch" : "...",
    "min-version" : "...",
    "os" : [ "...", "..." ]
  },
  "description" : "...",
  "groupId" : "...",
  "name" : "...",
  "screenshots" : [ "...", "..." ],
  "state" : "CORE",
  "url" : "...",
  "version" : "...",
  "wiki" : "..."
} ]
                
              

GET /api/rest/plugins/available

Returns all available plugins.

Response Codes
code condition
200 success
500 internal server error
Response Body
media type data type description
application/json array of PluginInformation (JSON) all available plugins
application/xml list of pluginInformation (XML)

Example

Request
GET /plugins/available
Accept: application/json

              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "artifactId" : "...",
  "author" : "...",
  "category" : "...",
  "condition" : {
    "arch" : "...",
    "min-version" : "...",
    "os" : [ "...", "..." ]
  },
  "description" : "...",
  "groupId" : "...",
  "name" : "...",
  "screenshots" : [ "...", "..." ],
  "state" : "AVAILABLE",
  "url" : "...",
  "version" : "...",
  "wiki" : "..."
} ]
                
              

POST /api/rest/plugins/install-package

Installs a plugin from a package.

Request Parameters
name type description
uploadedInputStream formdata
Request Body
media type data type
multipart/form-data (custom)
Response Codes
code condition
200 success
412 precondition failed
500 internal server error
Response Body
media type data type
application/json object (JSON)
application/xml anyType (XML)

Example

Request
POST /plugins/install-package
Accept: application/json

              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...
                
              

POST /api/rest/plugins/install-package.html

Installs a plugin from a package. This method is a workaround for ExtJS file upload, which requires text/html as content-type.

Request Parameters
name type description
uploadedInputStream formdata
Request Body
media type data type
multipart/form-data (custom)
Response Codes
code condition
200 success
412 precondition failed
500 internal server error
Response Body
media type data type
text/html (custom)

Example

Request
POST /plugins/install-package.html
Accept: text/html

              
Response
HTTP/1.1 200 OK
Content-Type: text/html

                
...
                
              

GET /api/rest/plugins/installed

Returns all installed plugins.

Response Codes
code condition
200 success
500 internal server error
Response Body
media type data type description
application/json array of PluginInformation (JSON) all installed plugins
application/xml list of pluginInformation (XML)

Example

Request
GET /plugins/installed
Accept: application/json

              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "artifactId" : "...",
  "author" : "...",
  "category" : "...",
  "condition" : {
    "arch" : "...",
    "min-version" : "...",
    "os" : [ "...", "..." ]
  },
  "description" : "...",
  "groupId" : "...",
  "name" : "...",
  "screenshots" : [ "...", "..." ],
  "state" : "NEWER_VERSION_INSTALLED",
  "url" : "...",
  "version" : "...",
  "wiki" : "..."
} ]
                
              

GET /api/rest/plugins/overview

Returns all plugins for the overview.

Response Codes
code condition
200 success
500 internal server error
Response Body
media type data type description
application/json array of PluginInformation (JSON) all plugins for the overview
application/xml list of pluginInformation (XML)

Example

Request
GET /plugins/overview
Accept: application/json

              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "artifactId" : "...",
  "author" : "...",
  "category" : "...",
  "condition" : {
    "arch" : "...",
    "min-version" : "...",
    "os" : [ "...", "..." ]
  },
  "description" : "...",
  "groupId" : "...",
  "name" : "...",
  "screenshots" : [ "...", "..." ],
  "state" : "NEWER_VERSION_INSTALLED",
  "url" : "...",
  "version" : "...",
  "wiki" : "..."
} ]
                
              

GET /api/rest/plugins/updates

Returns all plugins which are available for update.

Response Codes
code condition
200 success
500 internal server error
Response Body
media type data type description
application/json array of PluginInformation (JSON) all plugins which are available for update
application/xml list of pluginInformation (XML)

Example

Request
GET /plugins/updates
Accept: application/json

              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "artifactId" : "...",
  "author" : "...",
  "category" : "...",
  "condition" : {
    "arch" : "...",
    "min-version" : "...",
    "os" : [ "...", "..." ]
  },
  "description" : "...",
  "groupId" : "...",
  "name" : "...",
  "screenshots" : [ "...", "..." ],
  "state" : "CORE",
  "url" : "...",
  "version" : "...",
  "wiki" : "..."
} ]
                
              

POST /api/rest/plugins/install/{id}

Installs a plugin.

Request Parameters
name type description
id path id of the plugin to be installed
Response Codes
code condition
200 success
500 internal server error

Example

Request
POST /plugins/install/{id}

              
Response
HTTP/1.1 200 OK

              

POST /api/rest/plugins/uninstall/{id}

Uninstalls a plugin.

Request Parameters
name type description
id path id of the plugin to be uninstalled
Response Codes
code condition
200 success
500 internal server error
Response Body
media type data type
application/json object (JSON)
application/xml anyType (XML)

Example

Request
POST /plugins/uninstall/{id}
Accept: application/json

              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...
                
              

POST /api/rest/plugins/update/{id}

Updates a plugin.

Request Parameters
name type description
id path id of the plugin to be updated
Response Codes
code condition
200 success
500 internal server error
Response Body
media type data type
application/json object (JSON)
application/xml anyType (XML)

Example

Request
POST /plugins/update/{id}
Accept: application/json

              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...