Fields: Plugin Types
See the associated Plugin Types resource section for more information on how to use this resource and supported operations.
Additional references
| Type | Value | Additional information |
|---|---|---|
| Permissions resource | plugin-types | Permissions |
| Hooks filename | plugin-types.groovy | Pre- and Post-Processing Hooks |
| Tenant-supported | No | Tenants |
| Distinct query-supported | No | Distinct |
API version 3
Represents a MWS plugin type. All fields in this class are generated from plugin project and type metadata and cannot be modified directly. Consequentially, all fields are only valid for list/show/GET operations.
| Field Name | Type | PUT | Description |
|---|---|---|---|
| id | String | No |
The unique identifier of the plugin type. This is based on the class name of the plugin. Ex: |
| author | String | No |
The main author (company or person) of the plugin type. |
| commonsVersion | String | No |
A string representing the restriction on which version of the plugin framework (plugins-commons dependency) is required for the plugin type. In the format 'COMMONS_VERSION > *', meaning that any version greater or equal to COMMONS_VERSION is valid. |
| description | String | No |
The full description of the plugin type. |
| documentationLink | String | No |
A full URL to the complete documentation for the plugin type. |
| String | No |
The email of the author. |
|
| eventComponent | Integer | No |
The event component ID of the plugin type. This should be unique for each plugin type and should be 1 or greater. |
| initialPlugins | Map<String, Map> | No |
Represents the plugins that are initially configured when the plugin type is loaded. Each key represents the plugin ID. |
| issueManagementLink | String | No |
A full URL to the issue management system or project for the plugin type. |
| license | String | No |
The license of this plugin type, typically APACHE. |
| mwsVersion | String | No |
A string representing the restriction on which version of MWS is required for the plugin type. In the format 'MWS_VERSION > *', meaning that any version greater or equal to MWS_VERSION is valid. |
| pollMethod | boolean | No |
Indicates whether the plugin type has a defined 'poll' method (event handler) or not. |
| realizedEventComponent | Integer | No |
The fully realized event component ID of the plugin type, including the MWS bits. This should take the form of 0x201. If the eventComponent is not set, this will be 0x2FF, meaning the component ID is an unknown plugin type. |
| scmLink | String | No |
A full URL to the Source Control Management (SCM) system or project for the plugin type. |
| title | String | No |
A short name describing the plugin type. |
| website | String | No |
The website of the author. |
API version 2
Represents a MWS plugin type. All fields in this class are generated from plugin project and type metadata and cannot be modified directly. Consequentially, all fields are only valid for list/show/GET operations.
| Field Name | Type | PUT | Description |
|---|---|---|---|
| id | String | No |
The unique identifier of the plugin type. This is based on the class name of the plugin. Ex: |
| author | String | No |
The main author (company or person) of the plugin type. |
| commonsVersion | String | No |
A string representing the restriction on which version of the plugin framework (plugins-commons dependency) is required for the plugin type. In the format 'COMMONS_VERSION > *', meaning that any version greater or equal to COMMONS_VERSION is valid. |
| description | String | No |
The full description of the plugin type. |
| documentationLink | String | No |
A full URL to the complete documentation for the plugin type. |
| String | No |
The email of the author. |
|
| eventComponent | Integer | No |
The event component ID of the plugin type. This should be unique for each plugin type and should be 1 or greater. |
| initialPlugins | Map<String, Map> | No |
Represents the plugins that are initially configured when the plugin type is loaded. Each key represents the plugin ID. |
| issueManagementLink | String | No |
A full URL to the issue management system or project for the plugin type. |
| license | String | No |
The license of this plugin type, typically APACHE. |
| mwsVersion | String | No |
A string representing the restriction on which version of MWS is required for the plugin type. In the format 'MWS_VERSION > *', meaning that any version greater or equal to MWS_VERSION is valid. |
| pollMethod | boolean | No |
Indicates whether the plugin type has a defined 'poll' method (event handler) or not. |
| realizedEventComponent | Integer | No |
The fully realized event component ID of the plugin type, including the MWS bits. This should take the form of 0x201. If the eventComponent is not set, this will be 0x2FF, meaning the component ID is an unknown plugin type. |
| scmLink | String | No |
A full URL to the Source Control Management (SCM) system or project for the plugin type. |
| title | String | No |
A short name describing the plugin type. |
| website | String | No |
The website of the author. |
Related Topics