Operation
Info
Set of operation fields depends on user's permissions. Users with the manage-operations
permission get all existing fields, while users with the execute-operations
permission get id
, name
and description
fields only.
Field | Type | Description |
---|---|---|
id | Stringrequired |
Operation's ID. |
name | Stringrequired |
Operation's name. |
type | Stringrequired |
Operation's type. It might be equal either to 1 or 2 . The first number corresponds to an MQTT message, the second one is for a program/script. |
description | String | Operation's description |
popupResult | Boolean | Whether to show the results of the operation in a popup message. |
parameters.message | String | An MQTT message. This parameter should be specified only for the MQTT message type. |
parameters.topic | String | An MQTT topic. This parameter should be specified only for the MQTT message type. |
parameters.type | String | A subtype of the current script's type. Available types: fileSystem , scriptReference , scriptText . |
parameters.path | String | A path to a script. This parameter should be specified only for the fileSystem subtype. |
parameters.args | Array<String> | An array of script's input parameters. This parameter should be specified only for the fileSystem subtype. |
parameters.ref | String | The ID of a script. This parameter should be specified only for the scriptReference subtype. |
parameters.text | String | A script's source code. This parameter should be specified only for the scriptText subtype. |