Amazon IoT SiteWise · JSON Structure

Iot Sitewise Describe Asset Property Response Structure

DescribeAssetPropertyResponse schema

Type: object Properties: 5 Required: 3
Asset ManagementIndustrial IoTIoTTime Series Data

DescribeAssetPropertyResponse is a JSON Structure definition published by Amazon IoT SiteWise, describing 5 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

assetId assetName assetModelId assetProperty compositeModel

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-sitewise/refs/heads/main/json-structure/iot-sitewise-describe-asset-property-response-structure.json",
  "name": "DescribeAssetPropertyResponse",
  "description": "DescribeAssetPropertyResponse schema",
  "type": "object",
  "properties": {
    "assetId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ID"
        },
        {
          "description": "The ID of the asset."
        }
      ]
    },
    "assetName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Name"
        },
        {
          "description": "The name of the asset."
        }
      ]
    },
    "assetModelId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ID"
        },
        {
          "description": "The ID of the asset model."
        }
      ]
    },
    "assetProperty": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Property"
        },
        {
          "description": "<p>The asset property's definition, alias, and notification state.</p> <p>This response includes this object for normal asset properties. If you describe an asset property in a composite model, this response includes the asset property information in <code>compositeModel</code>.</p>"
        }
      ]
    },
    "compositeModel": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CompositeModelProperty"
        },
        {
          "description": "The composite asset model that declares this asset property, if this asset property exists in a composite model."
        }
      ]
    }
  },
  "required": [
    "assetId",
    "assetName",
    "assetModelId"
  ]
}