plugin

Get all plugins

Get a detailed list of all installed plugins

Securityapi_key
Request
query Parameters
page_number
integer <int64>
Default: 1

The page number for which to get algorithm plugins. This will default to the first page if excluded

page_size
integer <int64>

The maximum number of objects to return. This will default to the DefaultApiPageSize setting if not provided

pluginType
string
Default: "EXTENDED_ALGORITHM"

The type of plugin to retrieve.

Enum: "EXTENDED_ALGORITHM" "DRIVER_SUPPORT"
Responses
200

Success

400

Bad request

401

Unauthorized access

get/plugin
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}

Install plugin

Install an uploaded plugin file onto the system

Securityapi_key
Request
query Parameters
fileReferenceId
required
string

The file references ID of the uploaded plugin JAR file to install

pluginName
string

Override the default name of the plugin. Plugin names must be unique across plugins of the same type on the engine.

pluginType
string
Default: "EXTENDED_ALGORITHM"

The type of plugin to retrieve.

Enum: "EXTENDED_ALGORITHM" "DRIVER_SUPPORT"
Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

409

Conflict

post/plugin
Response samples
application/json
{
  • "pluginId": 1,
  • "pluginName": "myPlugin",
  • "pluginAuthor": "pluginAuthor",
  • "pluginType": "EXTENDED_ALGORITHM",
  • "originalFileName": "algorithm.jar",
  • "jarFingerprint": "dce2599f5ece9441a4b84194313245b65618490a47cead870c3327738decd052",
  • "installDate": "2019-09-19T19:43:09.762+0000",
  • "installUser": 5,
  • "builtIn": false,
  • "pluginVersion": "1.0.0-RELEASE",
  • "algorithmNames": [
    ]
}

Get plugin detail by pluginId

Get detailed information about an installed plugin by pluginId

Securityapi_key
Request
path Parameters
pluginId
required
integer <int64>

The ID of the plugin to get

Responses
200

Success

400

Bad request

401

Unauthorized access

404

Not found

get/plugin/{pluginId}
Response samples
application/json
{
  • "pluginId": 1,
  • "pluginName": "myPlugin",
  • "pluginAuthor": "pluginAuthor",
  • "pluginType": "EXTENDED_ALGORITHM",
  • "originalFileName": "algorithm.jar",
  • "jarFingerprint": "dce2599f5ece9441a4b84194313245b65618490a47cead870c3327738decd052",
  • "installDate": "2019-09-19T19:43:09.762+0000",
  • "installUser": 5,
  • "builtIn": false,
  • "pluginVersion": "1.0.0-RELEASE",
  • "algorithmNames": [
    ]
}

Update plugin

Update an installed plugin to use the uploaded JAR file. The new plugin must contain all components delivered by the previous version.

Securityapi_key
Request
path Parameters
pluginId
required
integer <int64>

The ID of the plugin to update

query Parameters
fileReferenceId
required
string

The file references ID of the new uploaded plugin JAR file

pluginName
string

The name of the plugin

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

put/plugin/{pluginId}
Response samples
application/json
{
  • "pluginId": 1,
  • "pluginName": "myPlugin",
  • "pluginAuthor": "pluginAuthor",
  • "pluginType": "EXTENDED_ALGORITHM",
  • "originalFileName": "algorithm.jar",
  • "jarFingerprint": "dce2599f5ece9441a4b84194313245b65618490a47cead870c3327738decd052",
  • "installDate": "2019-09-19T19:43:09.762+0000",
  • "installUser": 5,
  • "builtIn": false,
  • "pluginVersion": "1.0.0-RELEASE",
  • "algorithmNames": [
    ]
}

Delete plugin

Delete an installed plugin.

Securityapi_key
Request
path Parameters
pluginId
required
integer <int64>

The ID of the plugin to delete

query Parameters
force
boolean
Default: false

Force deletion of all dependent usage associated with the plugin, such as inventory and domain assignments of algorithms

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

delete/plugin/{pluginId}
➔ Next to profileJob