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.

...

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
titleAPI URL

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}

...

Parameter

Type

Required

Description

pluginDisplayNameQuery - StringNo

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

Contains ignore case type search.

Response Codes

HTTP Code
Description
200Search successful and results returned
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
500Unexpected internal server error

Example

If we had a plugin in our database with the following attributes

...