Plugins can be accessed through this API using GET. This service retrieves information about plugins.
Base URL for Plugins REST API
http://host:port/flexdeploy/rest/v1/administration/plugins
GET
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.
API URLs
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}
The query parameters are not case sensitive. Searching by name=EXAMPLE is the same as searching by name=example.
Parameters
Parameter | Type | Required | Description |
|---|---|---|---|
| pluginDisplayName | URL | No | This is a URL query parameter for the display name which is used to search the plugins |
Example
If we had a plugin in our database with the following attributes
[
{
"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"
}
]
}
]
When we run a GET request at the following URL
http://host:port/flexdeploy/rest/v1/administration/plugins?pluginDisplayName=JDBC
The GET request would return the following JSON plugin object
[
{
"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"
}
]
}
]