Get LoRaWAN gateways in edge gateway

GET 
/organizations/:organizationId/edge-gateways/:edgeGatewayId/lorawan-gateways

Get LoRaWAN Gateways in edge gateway

Request

Path Parameters

organizationId stringrequired

The ID of organization.

edgeGatewayId stringrequired

Edge Gateway ID

Query Parameters

requireThingAttributes string

Possible values: [true, false]

Also fetch thing attributes.

requireThingShadows string

Possible values: [true, false]

Also fetch thing shadows with shadow names.

thingShadowNames string[]

Specify shadow names to fetch. (Default: optional; Options: DeviceUplink, GatewayUplink)

Responses

200

application/json

Schema

Schema

data objectrequired
Data of the edge gateway.
thingArn stringrequired
thingId stringrequired
thingName stringrequired
thingTypeName stringrequired
attributes objectrequired
shadows objectrequired

Example (from schema)

{
  "data": {
    "thingArn": "string",
    "thingId": "string",
    "thingName": "string",
    "thingTypeName": "string",
    "attributes": {},
    "shadows": {}
  }
}

Example

{
  "data": {
    "thingArn": "arn:aws:iot:region:accountId:thing/LoRaWANGateway01",
    "thingId": "efgh5678",
    "thingName": "LoRaWAN_Gateway_01",
    "thingTypeName": "LoRaWAN_Gateway",
    "attributes": {
      "Location": "Building 1, Floor 3",
      "CoverageArea": "Campus A",
      "NetworkProvider": "LoRaWAN Network A",
      "DeploymentDate": "2023-06-15"
    },
    "shadows": {
      "DeviceUplink": {
        "state": {
          "reported": {
            "Payload": {
              "Temperature": 25.4,
              "Humidity": 62,
              "CO2": 869,
              "rssi": -91
            },
            "ExpiredAt": 1711341602287
          },
          "metadata": {
            "reported": {
              "Payload": {
                "Temperature": {
                  "timestamp": 1711330802
                },
                "Humidity": {
                  "timestamp": 1711330802
                },
                "CO2": {
                  "timestamp": 1711330802
                },
                "rssi": {
                  "timestamp": 1711330802
                }
              },
              "ExpiredAt": {
                "timestamp": 1711330802
              }
            }
          },
          "version": 21415,
          "timestamp": 1711330849
        }
      }
    }
  }
}

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."
}

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...