Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

Plugins can be accessed through this API using GET. This service retrieves information about plugins.

...

Include Page

...

titleBase URL for Plugins REST API

...

http://host:port/flexdeploy/rest/v1/administration/plugins

REST V1 Authentication
REST V1 Authentication

Table of Contents
maxLevel2

...

GET (Using Query Parameters)

This GET service will return a list of plugins in the form of JSON objects based on a query parameter for the display name. Plugins are only returned if they contain the specified parameter. If no query parameters are given this request will return the entire list of plugins.

Info
titleAPI URLsURL

http://host:port/flexdeploy/rest/v1/administration/plugins

Append the following character sequences to the above URL to specify Query parameters.

?pluginDisplayName={pluginDisplayName}

Examples:
To return all of the plugins:

http://host:port/flexdeploy/rest/v1/administration/plugins

To search by display name only:

http://host:port/flexdeploy/rest/v1/administration/plugins?pluginDisplayName={pluginDisplayName}

...

Tip

The query parameters are not case sensitive. Searching by name=EXAMPLE is the same as searching by name=example.

...

Request

Parameter

Type

Required

Description

pluginDisplayNameURLNoThis is a URL query parameter for the display name which is used to search the plugins

...

Code Block
themeEclipse
titlePlugin
[
    {
        "isActive": true,
        "pluginId": 10705,
        "pluginName": "FlexagonJDBCPlugin",
        "pluginDisplayName": "JDBC",
        "pluginVersion": "4.5.1.38",
        "description": "A plugin to import, export, and run scripts.",
        "vendorName": "Flexagon",
        "pluginGroup": "Database",
        "pluginSubGroup": "JDBC",
        "operations": [
        {
            "export",
            "import",
            "partialBuild",
            "partialDeploy",
            "runPLSQL",
            "runQuery",
            "runScript"
        }
        ]
    }
]

...