GET api/gateways/{gatewayId}/eventlogic

Get the event logic for alarm kit devices connected to a specific gateway. For use by gateways.

Request Information

URI Parameters

Name	Description	Type	Additional information
gatewayId	Id of the gateway to get devices for.	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Event logic for the devices.

EventLogicDto

Name	Type	Additional information
Devices	Collection of DeviceDto	None.
Events	Collection of EventDto	None.
CompositeEvents	Collection of CompositeEventDto	None.
Actions	Collection of ActionDto	None.

Response Formats

application/json, text/json

Sample:

{
  "Devices": [
    {
      "Name": "sample string 1",
      "Address": "sample string 2"
    },
    {
      "Name": "sample string 1",
      "Address": "sample string 2"
    }
  ],
  "Events": [
    {
      "Tag": "sample string 1",
      "Topic": "sample string 2",
      "DeviceName": "sample string 3",
      "Value": 1
    },
    {
      "Tag": "sample string 1",
      "Topic": "sample string 2",
      "DeviceName": "sample string 3",
      "Value": 1
    }
  ],
  "CompositeEvents": [
    {
      "Tag": "sample string 1",
      "Operator": "sample string 2",
      "SubEventTags": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "Tag": "sample string 1",
      "Operator": "sample string 2",
      "SubEventTags": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "Actions": [
    {
      "Name": "sample string 1",
      "EnableTag": "sample string 2",
      "DisableTag": "sample string 3",
      "TriggerTag": "sample string 4",
      "CancelTag": "sample string 5",
      "EnableDelay": 6,
      "TriggerDelay": 7,
      "TimeUnit": "sample string 8",
      "EventMessages": [
        {
          "Topic": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Topic": "sample string 1",
          "Value": "sample string 2"
        }
      ],
      "Commands": [
        {
          "DeviceName": "sample string 1",
          "CommandId": "sample string 2"
        },
        {
          "DeviceName": "sample string 1",
          "CommandId": "sample string 2"
        }
      ]
    },
    {
      "Name": "sample string 1",
      "EnableTag": "sample string 2",
      "DisableTag": "sample string 3",
      "TriggerTag": "sample string 4",
      "CancelTag": "sample string 5",
      "EnableDelay": 6,
      "TriggerDelay": 7,
      "TimeUnit": "sample string 8",
      "EventMessages": [
        {
          "Topic": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Topic": "sample string 1",
          "Value": "sample string 2"
        }
      ],
      "Commands": [
        {
          "DeviceName": "sample string 1",
          "CommandId": "sample string 2"
        },
        {
          "DeviceName": "sample string 1",
          "CommandId": "sample string 2"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<EventLogicDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eSmart.Backend.Service.IoTManagement.Controllers">
  <Actions>
    <ActionDto>
      <CancelTag>sample string 5</CancelTag>
      <Commands>
        <CommandDto>
          <CommandId>sample string 2</CommandId>
          <DeviceName>sample string 1</DeviceName>
        </CommandDto>
        <CommandDto>
          <CommandId>sample string 2</CommandId>
          <DeviceName>sample string 1</DeviceName>
        </CommandDto>
      </Commands>
      <DisableTag>sample string 3</DisableTag>
      <EnableDelay>6</EnableDelay>
      <EnableTag>sample string 2</EnableTag>
      <EventMessages>
        <EventMessageDto>
          <Topic>sample string 1</Topic>
          <Value>sample string 2</Value>
        </EventMessageDto>
        <EventMessageDto>
          <Topic>sample string 1</Topic>
          <Value>sample string 2</Value>
        </EventMessageDto>
      </EventMessages>
      <Name>sample string 1</Name>
      <TimeUnit>sample string 8</TimeUnit>
      <TriggerDelay>7</TriggerDelay>
      <TriggerTag>sample string 4</TriggerTag>
    </ActionDto>
    <ActionDto>
      <CancelTag>sample string 5</CancelTag>
      <Commands>
        <CommandDto>
          <CommandId>sample string 2</CommandId>
          <DeviceName>sample string 1</DeviceName>
        </CommandDto>
        <CommandDto>
          <CommandId>sample string 2</CommandId>
          <DeviceName>sample string 1</DeviceName>
        </CommandDto>
      </Commands>
      <DisableTag>sample string 3</DisableTag>
      <EnableDelay>6</EnableDelay>
      <EnableTag>sample string 2</EnableTag>
      <EventMessages>
        <EventMessageDto>
          <Topic>sample string 1</Topic>
          <Value>sample string 2</Value>
        </EventMessageDto>
        <EventMessageDto>
          <Topic>sample string 1</Topic>
          <Value>sample string 2</Value>
        </EventMessageDto>
      </EventMessages>
      <Name>sample string 1</Name>
      <TimeUnit>sample string 8</TimeUnit>
      <TriggerDelay>7</TriggerDelay>
      <TriggerTag>sample string 4</TriggerTag>
    </ActionDto>
  </Actions>
  <CompositeEvents>
    <CompositeEventDto>
      <Operator>sample string 2</Operator>
      <SubEventTags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </SubEventTags>
      <Tag>sample string 1</Tag>
    </CompositeEventDto>
    <CompositeEventDto>
      <Operator>sample string 2</Operator>
      <SubEventTags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </SubEventTags>
      <Tag>sample string 1</Tag>
    </CompositeEventDto>
  </CompositeEvents>
  <Devices>
    <DeviceDto>
      <Address>sample string 2</Address>
      <Name>sample string 1</Name>
    </DeviceDto>
    <DeviceDto>
      <Address>sample string 2</Address>
      <Name>sample string 1</Name>
    </DeviceDto>
  </Devices>
  <Events>
    <EventDto>
      <DeviceName>sample string 3</DeviceName>
      <Tag>sample string 1</Tag>
      <Topic>sample string 2</Topic>
      <Value>1</Value>
    </EventDto>
    <EventDto>
      <DeviceName>sample string 3</DeviceName>
      <Tag>sample string 1</Tag>
      <Topic>sample string 2</Topic>
      <Value>1</Value>
    </EventDto>
  </Events>
</EventLogicDto>