Versions Compared

Key

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

Anchor
Top
Top

...

Info
titleBase URL for Plugins REST API

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

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 URLs

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

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

pluginNamepluginDisplayName={pluginNamepluginDisplayName}

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?pluginNamepluginDisplayName={pluginNamepluginDisplayName}


Tip

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

...

Parameter

Type

Required

Description

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

...

http://host:port/flexdeploy/rest/v1/administration/plugins?pluginNamepluginDisplayName=JDBC

The GET request would return the  following JSON plugin object

...