This API provides access to read and execute any plugin command that is provided by a Plugins implementation. You can also read and update command presets. A command preset is a combination of an plugin command and pre defined data.
Gets a list of all commands provided by plugins.
Property | Type | Description |
---|---|---|
commands | Array<CommandInfo> |
List of available commands. |
Property | Type | Description |
---|---|---|
pluginId | string |
The ID of the plugin that provides this command. |
name | string |
The command name. |
displayName | string |
The command name to be displayed on the user interface. (>3.1.0) |
description | string |
The command description |
exampleData | string |
Optional. JSON string with example data. |
Executes a command.
Optional: The body can contain a valid JSON that is used as the command data.
Optional: The command implementation can return data that is JSON serialized to the response body.
Property | Type | Description |
---|---|---|
message | string |
A detailed error message. |
Same as the post request. The "get" is provided to allow easy command executing with just a link.
Gets a list of all command presets.
Property | Type | Description |
---|---|---|
presets | Array<CommandPreset> |
List of command presets. |
Property | Type | Description |
---|---|---|
name | string |
The unique preset name. |
displayName | string |
The preset name to be used for the user interface. |
groupName | string |
Optional: Group presets together. |
commandName | string |
The name of the plugin provided command. |
commandData | object |
Optional: Data for the command. Do not use strings here. |
Updates a command preset
Property | Type | Description |
---|---|---|
preset | The command presets. |
Property | Type | Description |
---|---|---|
message | string |
No preset or preset.name missing. |
Adds a new command preset
Property | Type | Description |
---|---|---|
preset | The command presets. |
Property | Type | Description |
---|---|---|
message | string |
No preset or preset.name missing. |
Deletes an existing command preset.
Property | Type | Description |
---|---|---|
message | string |
Preset does not exist. |
Executes a command.
Optional: The command implementation can return data that is JSON serialized to the response body.
Property | Type | Description |
---|---|---|
message | string |
Preset does not exist. |
Property | Type | Description |
---|---|---|
message | string |
A detailed error message. |
Same as the post request. The "get" is provided to allow easy command preset executing with just a link.