List Event Rules

GET 
/organizations/:organizationId/event-rules

List event rules

Request

Path Parameters

organizationId stringrequired

The ID of organization.

Query Parameters

stage string

Possible values: [Edge, IoTCore]

The stage of event rule.

maxResults string

The maximum number of results to return.

nextToken string

To retrieve the next set of results.

Responses

200

application/json

Schema

Schema

data object[]required
An array of event rule objects.
Array [
id stringrequired
organizationId stringrequired
name stringrequired
stage stringrequired
status stringrequired
targetName stringrequired
expression stringrequired
hashtags string[]required
conditions object[]required
Array [
assetId stringrequired
property stringrequired
symbol stringrequired
valueDataType stringrequired
value stringrequired
operator stringrequired
]
devices string[]required
actions object[]required
Array [
type stringrequired
parameters objectrequired
]
createdBy stringrequired
createdAtDateString stringrequired
createdAt numberrequired
updatedAtDateString stringrequired
updatedAt numberrequired
]

Example (from schema)

{
  "data": [
    {
      "id": "string",
      "organizationId": "string",
      "name": "string",
      "stage": "string",
      "status": "string",
      "targetName": "string",
      "expression": "string",
      "hashtags": [
        "string"
      ],
      "conditions": [
        {
          "assetId": "string",
          "property": "string",
          "symbol": "string",
          "valueDataType": "string",
          "value": "string",
          "operator": "string"
        }
      ],
      "devices": [
        "string"
      ],
      "actions": [
        {
          "type": "string",
          "parameters": {}
        }
      ],
      "createdBy": "string",
      "createdAtDateString": "string",
      "createdAt": 0,
      "updatedAtDateString": "string",
      "updatedAt": 0
    }
  ]
}

Example

{
  "data": [
    {
      "id": "er_eventRuleId",
      "organizationId": "o-organizationId",
      "name": "IDT-EventRule",
      "stage": "IoTCore",
      "status": "Enabled",
      "targetName": "IoTCore-Target-Name",
      "expression": "IoTCore-Expression",
      "hashtags": [
        "Important"
      ],
      "conditions": [
        {
          "assetId": "a-assetId",
          "property": "Temperature",
          "symbol": ">",
          "valueDataType": "integer",
          "value": "25",
          "operator": "AND"
        }
      ],
      "devices": [
        "a-assetId"
      ],
      "actions": [
        {
          "type": "enqueue",
          "parameters": {
            "name": "Power Off",
            "assetId": "a-assetId",
            "confirmed": true,
            "fPort": 85,
            "payload": "080000ff",
            "payloadDataType": "string"
          }
        }
      ],
      "createdBy": "d6b0e137-xxxx-xxxx-xxxx-c944cc12a5f4",
      "createdAtDateString": "2024-01-01T00:00:00.000Z",
      "createdAt": 1704067200000,
      "updatedAtDateString": "2024-01-31T00:00:00.000Z",
      "updatedAt": 1706659200000
    }
  ]
}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

404

The resource hasn't found.

application/json

Schema

Schema

error stringrequired

The resource hasn't found.

message stringrequired

The resource hasn't found message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ResourceNotFound",
  "message": "The requested resource could not be found."
}

422

The input data has invalid.

application/json

Schema

Schema

error stringrequired

The input data has invalid.

message stringrequired

The input data has invalid message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ValidationError",
  "message": "Input data validation failed."
}

Loading...