Get Thing

GET 
/organizations/:organizationId/things/:thingName

Get thing

Request

Path Parameters

organizationId stringrequired

The ID of organization.

thingName stringrequired

The name of IoT device

Responses

200

application/json

Schema

Schema

data object[]required
Data of the things.
Array [
thingArn stringrequired
thingName stringrequired
thingTypeName stringrequired
attributes objectrequired
shadows objectrequired
version numberrequired
]

Example (from schema)

{
  "data": [
    {
      "thingArn": "string",
      "thingName": "string",
      "thingTypeName": "string",
      "attributes": {},
      "shadows": {},
      "version": 0
    }
  ]
}

Example

{
  "data": {
    "thingArn": "arn:aws:iot:ap-northeast-1:012345678901:thing/o-organizationId-a-24e124148b323456",
    "thingName": "o-organizationId-a-24e124148b323456",
    "thingTypeName": "o-organizationId-Default",
    "attributes": {
      "assetTypeId": "o-organizationId-at-assetType",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "integrationId": "o-organizationId-is-integrationId",
      "locationId": "o-organizationId-l-locationId"
    },
    "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
      },
      "version": 1
    }
  }
}

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