Action
Manage Actions.
Find
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
| Field | Type | Required |
|---|---|---|
| cloudId | string | yes |
| type | string |
Query String Options
| Field | Type | Notes |
|---|---|---|
| filter | string | Full text string to filter for. |
| next | object | Pagination token for the next page. |
| prev | object | Pagination token for the previous page. |
| limit | number | Number of items to retrieve. |
| index | string | Database index to use. |
| exists | boolean | Set to true to require the item exists, otherwise set to null to perform an upsert. |
Response
Paged response.
| Field | Type | Notes |
|---|---|---|
| data | array | Array of items. |
| next | string | Paged cursor to use for the next page of items. |
| prev | string | Pages cursor to use for the previous page of items. |
Action
An array of Action items.
| Field | Type | Notes |
|---|---|---|
| buffer | object | Buffer optimizations. |
| cloudId | string | Owning device cloud ID. |
| context | object | Expression context, merged with user params. |
| description | string | |
| due | number | When the action is next due (if rearming). |
| enable | boolean | |
| error | string | |
| expression | string | |
| id | string | |
| message | string | Message template/properties. |
| name | string | |
| poll | number | Delay between pollng the action. |
| rearm | number | Time period to suppress the action. |
| severity | string | |
| trigger | string | Source of action trigger. |
| destination | string | URL, email address, function name, topic, phone number. |
| format | string | |
| type | string | |
| args | object | Action args. |
Get
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
| Field | Type | Required |
|---|---|---|
| id | string | |
| cloudId | string | yes |
| type | string | yes |
Response
| Field | Type | Notes |
|---|---|---|
| buffer | object | Buffer optimizations. |
| cloudId | string | Owning device cloud ID. |
| context | object | Expression context, merged with user params. |
| description | string | |
| due | number | When the action is next due (if rearming). |
| enable | boolean | |
| error | string | |
| expression | string | |
| id | string | |
| message | string | Message template/properties. |
| name | string | |
| poll | number | Delay between pollng the action. |
| rearm | number | Time period to suppress the action. |
| severity | string | |
| trigger | string | Source of action trigger. |
| destination | string | URL, email address, function name, topic, phone number. |
| format | string | |
| type | string | |
| args | object | Action args. |
Invoke
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
| Field | Type |
|---|---|
| id | string |
| name | string |
| params | object |
| context | object |
Response
A string.