Plugins can be accessed through this API using GET. This service retrieves information about plugins.
...
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. Plugins are returned in descending order by Install Date.
| Info | ||
|---|---|---|
| ||
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. |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
[
{
"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",
"pluginType": "java",
"imageName": null,
"isVersionCurrentlyActive": true,
"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
| Code Block | ||||
|---|---|---|---|---|
| ||||
[
{
"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",
"pluginType": "java",
"imageName": null,
"isVersionCurrentlyActive": true,
"operations": [
{
"export",
"import",
"partialBuild",
"partialDeploy",
"runPLSQL",
"runQuery",
"runScript"
}
]
}
] |
...