Aqara · JSON-LD Context
Aqara Context
JSON-LD context defining the semantic vocabulary for Aqara from Aqara.
74 Classes
116 Properties
4 Namespaces
Namespaces
schema:
https://schema.org/
xsd:
http://www.w3.org/2001/XMLSchema#
dcterms:
http://purl.org/dc/terms/
aqara:
https://aqara.com/schema#
Classes
BaseResponse
SpaceNode
SpaceSettings
CreateSpaceRequest
UpdateSpaceNameRequest
DeviceType
DeviceInfo
DeviceSpace
DeviceDefinition
Endpoint
DeviceFunction
Trait
Command
CommandField
BaseParameter
KeyValue
TraitExecuteRequest
TraitExecuteItem
TraitExecuteResult
TraitReadRequest
TraitValueQuery
TraitValueResult
CommandExecuteRequest
CommandExecuteItem
CommandArg
CommandExecuteResult
DeviceListData
DeleteSpaceRequest
DeleteDevicePointRequest
VirtualDeviceAddRequest
VirtualDeviceAddData
DeviceUnbindRequest
CommandExecuteAwaitResult
GatewayInfo
SubdeviceJoinRequest
SubdeviceJoinStopRequest
GatewaySubdeviceDidFilter
DeviceBindResultRequest
DeviceBindResultItem
AutomationDefinitionType
AutomationSummary
AutomationManualTriggerBrief
AutomationManualTriggerInfo
JsonAutomationConfig
JsonAutomationMetadata
JsonAutomationDevicePropertyDefinition
JsonAutomationRule
JsonAutomationTypedItem
FlowCanonicalConfig
FlowCanonicalMetadata
FlowCanonicalVariable
FlowCanonicalNode
FlowCanonicalEdge
FlowCanonicalPortRef
FlowCanonicalEditorState
FlowCanonicalPosition
FlowCanonicalEditorNode
AutomationListData
CreateAutomationRequest
UpdateAutomationRequest
UpdateAutomationStatusRequest
UpdateAutomationSpaceRequest
DeleteAutomationsRequest
AutomationBatchFailure
AutomationBatchResultData
ExecuteAutomationManualTriggerRequest
AutomationCapabilitiesData
AutomationCapabilityDevice
AutomationCapabilityEndpoint
AutomationCapabilityProperty
AutomationCapabilityValueRange
AutomationCapabilityEnumItem
StudioStatisticsDimension
StudioStatisticsData
Properties
| Property | Type | Container |
|---|---|---|
| type | string | |
| version | string | |
| msgId | string | |
| code | integer | |
| message | string | |
| spaceId | string | |
| parentSpaceId | string | |
| name | string | |
| spatialMarking | string | |
| children | list | |
| gmtTimeZone | string | |
| locationId | string | |
| autoAdjustDst | boolean | |
| settings | reference | |
| deviceType | string | |
| deviceId | string | |
| gatewayId | string | |
| deviceName | string | |
| deviceTypesList | list | |
| createTime | integer | |
| state | boolean | |
| space | reference | |
| endpoints | list | |
| endpointId | integer | |
| endpointName | string | |
| functions | list | |
| functionCode | string | |
| traits | list | |
| commands | list | |
| traitCode | string | |
| parameter | reference | |
| value | reference | |
| time | integer | |
| commandCode | string | |
| fields | list | |
| fieldCode | string | |
| min | decimal | |
| max | decimal | |
| supportedValues | list | |
| unit | string | |
| step | decimal | |
| key | string | |
| data | list | |
| traitCodes | list | |
| args | list | |
| totalCount | integer | |
| pageNum | integer | |
| pageSize | integer | |
| deleteChildren | boolean | |
| virtualDeviceType | string | |
| responded | boolean | |
| commandReportValue | string | |
| responseTime | integer | |
| supportZigbee | boolean | |
| supportedMatterRoles | integer | |
| subDeviceIds | list | |
| protocols | list | |
| gatewaySubdeviceFilters | list | |
| bindTime | integer | |
| automationId | string | |
| enabled | boolean | |
| definitionType | string | |
| manualTriggers | list | |
| triggerNodeId | string | |
| triggerName | string | |
| automationName | string | |
| metadata | reference | |
| automations | list | |
| description | string | |
| scope | list | |
| starters | list | |
| condition | ||
| actions | list | |
| kind | string | |
| flowVersion | string | |
| registryVersion | string | |
| variables | list | |
| nodes | list | |
| edges | list | |
| editor | reference | |
| id | string | |
| config | ||
| inputs | list | |
| outputs | list | |
| title | string | |
| source | reference | |
| target | reference | |
| node | string | |
| port | string | |
| positions | ||
| x | decimal | |
| y | decimal | |
| summary | string | |
| label | string | |
| icon | string | |
| iconColor | string | |
| detail | ||
| hidden | boolean | |
| autoSuffixOnDuplicate | boolean | |
| updateMask | list | |
| automationIds | list | |
| successIds | list | |
| failedItems | list | |
| devices | list | |
| properties | list | |
| functionName | string | |
| traitName | string | |
| commandName | string | |
| valueType | string | |
| semanticRole | list | |
| valueRange | reference | |
| enumRange | list | |
| deviceCount | integer | |
| linkageCount | integer | |
| spaceCount | integer | |
| sceneCount | integer |
JSON-LD Document
{
"@context": {
"@vocab": "https://aqara.com/schema#",
"schema": "https://schema.org/",
"xsd": "http://www.w3.org/2001/XMLSchema#",
"dcterms": "http://purl.org/dc/terms/",
"aqara": "https://aqara.com/schema#",
"BaseResponse": "aqara:BaseResponse",
"type": {
"@id": "aqara:type",
"@type": "xsd:string"
},
"version": {
"@id": "aqara:version",
"@type": "xsd:string"
},
"msgId": {
"@id": "aqara:msgId",
"@type": "xsd:string"
},
"code": {
"@id": "aqara:code",
"@type": "xsd:integer"
},
"message": {
"@id": "aqara:message",
"@type": "xsd:string"
},
"SpaceNode": "aqara:SpaceNode",
"spaceId": {
"@id": "aqara:spaceId",
"@type": "xsd:string"
},
"parentSpaceId": {
"@id": "aqara:parentSpaceId",
"@type": "xsd:string"
},
"name": {
"@id": "aqara:name",
"@type": "xsd:string"
},
"spatialMarking": {
"@id": "aqara:spatialMarking",
"@type": "xsd:string"
},
"children": {
"@id": "aqara:children",
"@container": "@list"
},
"SpaceSettings": "aqara:SpaceSettings",
"gmtTimeZone": {
"@id": "aqara:gmtTimeZone",
"@type": "xsd:string"
},
"locationId": {
"@id": "aqara:locationId",
"@type": "xsd:string"
},
"autoAdjustDst": {
"@id": "aqara:autoAdjustDst",
"@type": "xsd:boolean"
},
"CreateSpaceRequest": "aqara:CreateSpaceRequest",
"settings": {
"@id": "aqara:settings",
"@type": "@id"
},
"UpdateSpaceNameRequest": "aqara:UpdateSpaceNameRequest",
"DeviceType": "aqara:DeviceType",
"deviceType": {
"@id": "aqara:deviceType",
"@type": "xsd:string"
},
"DeviceInfo": "aqara:DeviceInfo",
"deviceId": {
"@id": "aqara:deviceId",
"@type": "xsd:string"
},
"gatewayId": {
"@id": "aqara:gatewayId",
"@type": "xsd:string"
},
"deviceName": {
"@id": "aqara:deviceName",
"@type": "xsd:string"
},
"deviceTypesList": {
"@id": "aqara:deviceTypesList",
"@container": "@list"
},
"createTime": {
"@id": "aqara:createTime",
"@type": "xsd:integer"
},
"state": {
"@id": "aqara:state",
"@type": "xsd:boolean"
},
"space": {
"@id": "aqara:space",
"@type": "@id"
},
"DeviceSpace": "aqara:DeviceSpace",
"DeviceDefinition": "aqara:DeviceDefinition",
"endpoints": {
"@id": "aqara:endpoints",
"@container": "@list"
},
"Endpoint": "aqara:Endpoint",
"endpointId": {
"@id": "aqara:endpointId",
"@type": "xsd:integer"
},
"endpointName": {
"@id": "aqara:endpointName",
"@type": "xsd:string"
},
"functions": {
"@id": "aqara:functions",
"@container": "@list"
},
"DeviceFunction": "aqara:DeviceFunction",
"functionCode": {
"@id": "aqara:functionCode",
"@type": "xsd:string"
},
"traits": {
"@id": "aqara:traits",
"@container": "@list"
},
"commands": {
"@id": "aqara:commands",
"@container": "@list"
},
"Trait": "aqara:Trait",
"traitCode": {
"@id": "aqara:traitCode",
"@type": "xsd:string"
},
"parameter": {
"@id": "aqara:parameter",
"@type": "@id"
},
"value": {
"@id": "aqara:value",
"@type": "@id"
},
"time": {
"@id": "aqara:time",
"@type": "xsd:integer"
},
"Command": "aqara:Command",
"commandCode": {
"@id": "aqara:commandCode",
"@type": "xsd:string"
},
"fields": {
"@id": "aqara:fields",
"@container": "@list"
},
"CommandField": "aqara:CommandField",
"fieldCode": {
"@id": "aqara:fieldCode",
"@type": "xsd:string"
},
"BaseParameter": "aqara:BaseParameter",
"min": {
"@id": "aqara:min",
"@type": "xsd:decimal"
},
"max": {
"@id": "aqara:max",
"@type": "xsd:decimal"
},
"supportedValues": {
"@id": "aqara:supportedValues",
"@container": "@list"
},
"unit": {
"@id": "aqara:unit",
"@type": "xsd:string"
},
"step": {
"@id": "aqara:step",
"@type": "xsd:decimal"
},
"KeyValue": "aqara:KeyValue",
"key": {
"@id": "aqara:key",
"@type": "xsd:string"
},
"TraitExecuteRequest": "aqara:TraitExecuteRequest",
"data": {
"@id": "aqara:data",
"@container": "@list"
},
"TraitExecuteItem": "aqara:TraitExecuteItem",
"TraitExecuteResult": "aqara:TraitExecuteResult",
"TraitReadRequest": "aqara:TraitReadRequest",
"TraitValueQuery": "aqara:TraitValueQuery",
"traitCodes": {
"@id": "aqara:traitCodes",
"@container": "@list"
},
"TraitValueResult": "aqara:TraitValueResult",
"CommandExecuteRequest": "aqara:CommandExecuteRequest",
"CommandExecuteItem": "aqara:CommandExecuteItem",
"args": {
"@id": "aqara:args",
"@container": "@list"
},
"CommandArg": "aqara:CommandArg",
"CommandExecuteResult": "aqara:CommandExecuteResult",
"DeviceListData": "aqara:DeviceListData",
"totalCount": {
"@id": "aqara:totalCount",
"@type": "xsd:integer"
},
"pageNum": {
"@id": "aqara:pageNum",
"@type": "xsd:integer"
},
"pageSize": {
"@id": "aqara:pageSize",
"@type": "xsd:integer"
},
"DeleteSpaceRequest": "aqara:DeleteSpaceRequest",
"deleteChildren": {
"@id": "aqara:deleteChildren",
"@type": "xsd:boolean"
},
"DeleteDevicePointRequest": "aqara:DeleteDevicePointRequest",
"VirtualDeviceAddRequest": "aqara:VirtualDeviceAddRequest",
"virtualDeviceType": {
"@id": "aqara:virtualDeviceType",
"@type": "xsd:string"
},
"VirtualDeviceAddData": "aqara:VirtualDeviceAddData",
"DeviceUnbindRequest": "aqara:DeviceUnbindRequest",
"CommandExecuteAwaitResult": "aqara:CommandExecuteAwaitResult",
"responded": {
"@id": "aqara:responded",
"@type": "xsd:boolean"
},
"commandReportValue": {
"@id": "aqara:commandReportValue",
"@type": "xsd:string"
},
"responseTime": {
"@id": "aqara:responseTime",
"@type": "xsd:integer"
},
"GatewayInfo": "aqara:GatewayInfo",
"supportZigbee": {
"@id": "aqara:supportZigbee",
"@type": "xsd:boolean"
},
"supportedMatterRoles": {
"@id": "aqara:supportedMatterRoles",
"@type": "xsd:integer"
},
"SubdeviceJoinRequest": "aqara:SubdeviceJoinRequest",
"SubdeviceJoinStopRequest": "aqara:SubdeviceJoinStopRequest",
"GatewaySubdeviceDidFilter": "aqara:GatewaySubdeviceDidFilter",
"subDeviceIds": {
"@id": "aqara:subDeviceIds",
"@container": "@list"
},
"DeviceBindResultRequest": "aqara:DeviceBindResultRequest",
"protocols": {
"@id": "aqara:protocols",
"@container": "@list"
},
"gatewaySubdeviceFilters": {
"@id": "aqara:gatewaySubdeviceFilters",
"@container": "@list"
},
"DeviceBindResultItem": "aqara:DeviceBindResultItem",
"bindTime": {
"@id": "aqara:bindTime",
"@type": "xsd:integer"
},
"AutomationDefinitionType": "aqara:AutomationDefinitionType",
"AutomationSummary": "aqara:AutomationSummary",
"automationId": {
"@id": "aqara:automationId",
"@type": "xsd:string"
},
"enabled": {
"@id": "aqara:enabled",
"@type": "xsd:boolean"
},
"definitionType": {
"@id": "aqara:definitionType",
"@type": "xsd:string"
},
"manualTriggers": {
"@id": "aqara:manualTriggers",
"@container": "@list"
},
"AutomationManualTriggerBrief": "aqara:AutomationManualTriggerBrief",
"triggerNodeId": {
"@id": "aqara:triggerNodeId",
"@type": "xsd:string"
},
"triggerName": {
"@id": "aqara:triggerName",
"@type": "xsd:string"
},
"AutomationManualTriggerInfo": "aqara:AutomationManualTriggerInfo",
"automationName": {
"@id": "aqara:automationName",
"@type": "xsd:string"
},
"JsonAutomationConfig": "aqara:JsonAutomationConfig",
"metadata": {
"@id": "aqara:metadata",
"@type": "@id"
},
"automations": {
"@id": "aqara:automations",
"@container": "@list"
},
"JsonAutomationMetadata": "aqara:JsonAutomationMetadata",
"description": {
"@id": "aqara:description",
"@type": "xsd:string"
},
"scope": {
"@id": "aqara:scope",
"@container": "@list"
},
"JsonAutomationDevicePropertyDefinition": "aqara:JsonAutomationDevicePropertyDefinition",
"JsonAutomationRule": "aqara:JsonAutomationRule",
"starters": {
"@id": "aqara:starters",
"@container": "@list"
},
"condition": {
"@id": "aqara:condition"
},
"actions": {
"@id": "aqara:actions",
"@container": "@list"
},
"JsonAutomationTypedItem": "aqara:JsonAutomationTypedItem",
"FlowCanonicalConfig": "aqara:FlowCanonicalConfig",
"kind": {
"@id": "aqara:kind",
"@type": "xsd:string"
},
"flowVersion": {
"@id": "aqara:flowVersion",
"@type": "xsd:string"
},
"registryVersion": {
"@id": "aqara:registryVersion",
"@type": "xsd:string"
},
"variables": {
"@id": "aqara:variables",
"@container": "@list"
},
"nodes": {
"@id": "aqara:nodes",
"@container": "@list"
},
"edges": {
"@id": "aqara:edges",
"@container": "@list"
},
"editor": {
"@id": "aqara:editor",
"@type": "@id"
},
"FlowCanonicalMetadata": "aqara:FlowCanonicalMetadata",
"FlowCanonicalVariable": "aqara:FlowCanonicalVariable",
"id": {
"@id": "aqara:id",
"@type": "xsd:string"
},
"config": {
"@id": "aqara:config"
},
"FlowCanonicalNode": "aqara:FlowCanonicalNode",
"inputs": {
"@id": "aqara:inputs",
"@container": "@list"
},
"outputs": {
"@id": "aqara:outputs",
"@container": "@list"
},
"title": {
"@id": "aqara:title",
"@type": "xsd:string"
},
"FlowCanonicalEdge": "aqara:FlowCanonicalEdge",
"source": {
"@id": "aqara:source",
"@type": "@id"
},
"target": {
"@id": "aqara:target",
"@type": "@id"
},
"FlowCanonicalPortRef": "aqara:FlowCanonicalPortRef",
"node": {
"@id": "aqara:node",
"@type": "xsd:string"
},
"port": {
"@id": "aqara:port",
"@type": "xsd:string"
},
"FlowCanonicalEditorState": "aqara:FlowCanonicalEditorState",
"positions": {
"@id": "aqara:positions"
},
"FlowCanonicalPosition": "aqara:FlowCanonicalPosition",
"x": {
"@id": "aqara:x",
"@type": "xsd:decimal"
},
"y": {
"@id": "aqara:y",
"@type": "xsd:decimal"
},
"FlowCanonicalEditorNode": "aqara:FlowCanonicalEditorNode",
"summary": {
"@id": "aqara:summary",
"@type": "xsd:string"
},
"label": {
"@id": "aqara:label",
"@type": "xsd:string"
},
"icon": {
"@id": "aqara:icon",
"@type": "xsd:string"
},
"iconColor": {
"@id": "aqara:iconColor",
"@type": "xsd:string"
},
"detail": {
"@id": "aqara:detail"
},
"hidden": {
"@id": "aqara:hidden",
"@type": "xsd:boolean"
},
"AutomationListData": "aqara:AutomationListData",
"CreateAutomationRequest": "aqara:CreateAutomationRequest",
"autoSuffixOnDuplicate": {
"@id": "aqara:autoSuffixOnDuplicate",
"@type": "xsd:boolean"
},
"UpdateAutomationRequest": "aqara:UpdateAutomationRequest",
"updateMask": {
"@id": "aqara:updateMask",
"@container": "@list"
},
"UpdateAutomationStatusRequest": "aqara:UpdateAutomationStatusRequest",
"automationIds": {
"@id": "aqara:automationIds",
"@container": "@list"
},
"UpdateAutomationSpaceRequest": "aqara:UpdateAutomationSpaceRequest",
"DeleteAutomationsRequest": "aqara:DeleteAutomationsRequest",
"AutomationBatchFailure": "aqara:AutomationBatchFailure",
"AutomationBatchResultData": "aqara:AutomationBatchResultData",
"successIds": {
"@id": "aqara:successIds",
"@container": "@list"
},
"failedItems": {
"@id": "aqara:failedItems",
"@container": "@list"
},
"ExecuteAutomationManualTriggerRequest": "aqara:ExecuteAutomationManualTriggerRequest",
"AutomationCapabilitiesData": "aqara:AutomationCapabilitiesData",
"devices": {
"@id": "aqara:devices",
"@container": "@list"
},
"AutomationCapabilityDevice": "aqara:AutomationCapabilityDevice",
"AutomationCapabilityEndpoint": "aqara:AutomationCapabilityEndpoint",
"properties": {
"@id": "aqara:properties",
"@container": "@list"
},
"AutomationCapabilityProperty": "aqara:AutomationCapabilityProperty",
"functionName": {
"@id": "aqara:functionName",
"@type": "xsd:string"
},
"traitName": {
"@id": "aqara:traitName",
"@type": "xsd:string"
},
"commandName": {
"@id": "aqara:commandName",
"@type": "xsd:string"
},
"valueType": {
"@id": "aqara:valueType",
"@type": "xsd:string"
},
"semanticRole": {
"@id": "aqara:semanticRole",
"@container": "@list"
},
"valueRange": {
"@id": "aqara:valueRange",
"@type": "@id"
},
"AutomationCapabilityValueRange": "aqara:AutomationCapabilityValueRange",
"enumRange": {
"@id": "aqara:enumRange",
"@container": "@list"
},
"AutomationCapabilityEnumItem": "aqara:AutomationCapabilityEnumItem",
"StudioStatisticsDimension": "aqara:StudioStatisticsDimension",
"StudioStatisticsData": "aqara:StudioStatisticsData",
"deviceCount": {
"@id": "aqara:deviceCount",
"@type": "xsd:integer"
},
"linkageCount": {
"@id": "aqara:linkageCount",
"@type": "xsd:integer"
},
"spaceCount": {
"@id": "aqara:spaceCount",
"@type": "xsd:integer"
},
"sceneCount": {
"@id": "aqara:sceneCount",
"@type": "xsd:integer"
}
},
"@type": "schema:Dataset",
"schema:name": "Aqara API JSON-LD context",
"schema:description": "A JSON-LD @context for the objects Aqara's own API contract declares: one class per component schema, one property per declared field, typed from the contract. Derived by script (derive-json-ld.py, 2026-10-28) from openapi/aiot-api-en.yaml, openapi/aiot-api-zh.yaml, openapi/data-export-api-en.yaml.",
"dcterms:created": "2026-10-28",
"dcterms:source": [
"openapi/aiot-api-en.yaml",
"openapi/aiot-api-zh.yaml",
"openapi/data-export-api-en.yaml",
"openapi/data-export-api-zh.yaml"
]
}