Official MCP-Server add-on for OpenRemote
Documentation GithubConnect to the MCP server using the configuration below:
{
"openremote": {
"transport": "streamable_http",
"url": https://mcp.openremote.tailforge.techmcp"
}
}
Use the official OpenRemote MCP client to use AI directly inside your OpenRemote instance!
List of the tools the AI can use using MCP. Some are auto generated based on the Asset models
Lists all assets available. If 403 is returned, that either means you don't have to correct access rights or the realms you specified do not exist. Try calling the 'get_all_realms' tool to see which realms are available.
{
"$defs": {
"AssetQuerySchemaDescription": {
"properties": {
"recursive": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"select": {
"anyOf": [
{
"$ref": "#/$defs/SelectSchema"
},
{
"type": "null"
}
],
"default": null
},
"access": {
"anyOf": [
{
"enum": [
"PRIVATE",
"PROTECTED",
"PUBLIC"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
},
"names": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/StringPredicateSchema"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
},
"parents": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/ParentPredicateSchema"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
},
"paths": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/PathPredicateSchema"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"$ref": "#/$defs/RealmPredicateSchema"
},
{
"type": "null"
}
],
"default": null,
"description": "Realm to query (Make sure to use the 'get_all_realms' tool to now which realms to query)"
},
"userIds": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
},
"types": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Asset types to query, (Make sure to use the 'get_all_asset_types' tool to gather which types there are)"
},
"attributes": {
"anyOf": [
{
"$ref": "#/$defs/LogicGroupAttributePredicateSchema"
},
{
"type": "null"
}
],
"default": null
},
"orderBy": {
"anyOf": [
{
"$ref": "#/$defs/OrderBySchema"
},
{
"type": "null"
}
],
"default": null
},
"limit": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"offset": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
}
},
"type": "object"
},
"AttributePredicateSchema": {
"properties": {
"name": {
"anyOf": [
{
"$ref": "#/$defs/StringPredicateSchema"
},
{
"type": "null"
}
],
"default": null
},
"negated": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"path": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
},
"value": {
"anyOf": [
{
"$ref": "#/$defs/ValuePredicateSchema"
},
{
"type": "null"
}
],
"default": null
},
"meta": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/NameValuePredicateSchema"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
},
"previousValue": {
"anyOf": [
{
"$ref": "#/$defs/ValuePredicateSchema"
},
{
"type": "null"
}
],
"default": null
},
"timestampOlderThan": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"type": "object"
},
"LogicGroupAttributePredicateSchema": {
"properties": {
"operator": {
"anyOf": [
{
"enum": [
"AND",
"OR"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"items": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/AttributePredicateSchema"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
},
"groups": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/LogicGroupAttributePredicateSchema"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
}
},
"type": "object"
},
"NameValuePredicateSchema": {
"properties": {
"name": {
"anyOf": [
{
"$ref": "#/$defs/StringPredicateSchema"
},
{
"type": "null"
}
],
"default": null
},
"negated": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"path": {
"anyOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
},
"value": {
"anyOf": [
{
"$ref": "#/$defs/ValuePredicateSchema"
},
{
"type": "null"
}
],
"default": null
}
},
"type": "object"
},
"OrderBySchema": {
"properties": {
"property": {
"anyOf": [
{
"enum": [
"CREATED_ON",
"FIRST_NAME",
"LAST_NAME",
"USERNAME",
"EMAIL"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"descending": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
}
},
"type": "object"
},
"ParentPredicateSchema": {
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"type": "object"
},
"PathPredicateSchema": {
"properties": {
"path": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null
}
},
"type": "object"
},
"RealmPredicateSchema": {
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"type": "object"
},
"SelectSchema": {
"properties": {
"basic": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
}
},
"type": "object"
},
"StringPredicateSchema": {
"properties": {
"match_": {
"anyOf": [
{
"enum": [
"EXACT",
"BEGIN",
"END",
"CONTAINS"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"caseSensitive": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"negate": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
}
},
"type": "object"
},
"ValuePredicateSchema": {
"properties": {
"predicateType": {
"type": "string"
}
},
"required": [
"predicateType"
],
"type": "object"
}
},
"properties": {
"asset_query_schema": {
"$ref": "#/$defs/AssetQuerySchemaDescription"
}
},
"required": [
"asset_query_schema"
],
"type": "object"
}Retrieve a single asset by ID.
{
"properties": {
"asset_id": {
"type": "string"
}
},
"required": [
"asset_id"
],
"type": "object"
}Create a new asset in the OpenRemote platform. IMPORTANT RULES FOR THE AI (DO NOT IGNORE): 1. The field "attributes" is REQUIRED. You MUST ALWAYS include it when calling this tool. 2. "attributes" must be an object where: - Each key = attribute name - Each value = { "name": key, "type": "<attribute-type>" } Example: "attributes": { "temperature": {"name": "temperature", "type": "number"}, "status": {"name": "status", "type": "string"} } 3. If the user does not provide asset_properties: - First call get_all_asset_types - Find the selected type - Look at the required attributes - Fill in attributes automatically with logical placeholder types 4. If OpenRemote returns 400: - It means the schema is wrong or missing required attribute fields. - You must ask the user for missing information or generate logical defaults.
{
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name",
"attributes"
],
"type": "object"
}Write/update a single attribute value on an asset. Use this to change sensor values, settings, etc.
{
"properties": {
"asset_id": {
"type": "string"
},
"attribute_name": {
"type": "string"
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"required": [
"asset_id",
"attribute_name",
"value"
],
"type": "object"
}Create a new 'TradfriLightAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"brightness": {
"maximum": 100,
"minimum": 0,
"title": "Brightness",
"type": "integer"
},
"colourTemperature": {
"maximum": 10000,
"minimum": 1000,
"title": "Colourtemperature",
"type": "integer"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"colourRGB": {
"title": "Colourrgb",
"type": "string"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"onOff": {
"title": "Onoff",
"type": "boolean"
}
},
"required": [
"notes",
"brightness",
"colourTemperature",
"location",
"colourRGB",
"onOff"
],
"title": "TradfriLightAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'VelbusSerialAgent' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"messageConvertHex": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconverthex"
},
"agentDisabled": {
"title": "Agentdisabled",
"type": "boolean"
},
"pollingMillis": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Pollingmillis"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"serialBaudrate": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialbaudrate"
},
"host": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Host"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"serialPort": {
"title": "Serialport",
"type": "string"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"messageMaxLength": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagemaxlength"
},
"bindPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindport"
},
"messageConvertBinary": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconvertbinary"
},
"messageCharset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagecharset"
},
"messageDelimiters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagedelimiters"
},
"updateOnWrite": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Updateonwrite"
},
"usernamePassword": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Usernamepassword"
},
"agentStatus": {
"title": "Agentstatus",
"type": "string"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"oAuthGrant": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Oauthgrant"
},
"port": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Port"
},
"messageStripDelimiter": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagestripdelimiter"
},
"location": {
"title": "Location",
"type": "string"
},
"timeInjectionInterval": {
"title": "Timeinjectioninterval",
"type": "integer"
},
"bindHost": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindhost"
}
},
"required": [
"notes",
"agentDisabled",
"serialPort",
"agentStatus",
"location",
"timeInjectionInterval"
],
"title": "VelbusSerialAgent"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'ElectricVehicleFleetGroupAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"powerImportMax": {
"title": "Powerimportmax",
"type": "integer"
},
"childAssetType": {
"title": "Childassettype",
"type": "string"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"availableChargingSpaces": {
"title": "Availablechargingspaces",
"type": "integer"
},
"powerExportMax": {
"title": "Powerexportmax",
"type": "integer"
},
"fleetCategory": {
"title": "Fleetcategory",
"type": "string"
},
"availableDischargingSpaces": {
"title": "Availabledischargingspaces",
"type": "integer"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"mileageMinimum": {
"title": "Mileageminimum",
"type": "integer"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
}
},
"required": [
"notes",
"powerImportMax",
"childAssetType",
"availableChargingSpaces",
"powerExportMax",
"fleetCategory",
"availableDischargingSpaces",
"location",
"mileageMinimum"
],
"title": "ElectricVehicleFleetGroupAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'MailAgent' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"startTLS": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Starttls"
},
"messageConvertHex": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconverthex"
},
"agentDisabled": {
"title": "Agentdisabled",
"type": "boolean"
},
"pollingMillis": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Pollingmillis"
},
"checkIntervalSeconds": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Checkintervalseconds"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"mailFolderName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Mailfoldername"
},
"protocol": {
"title": "Protocol",
"type": "string"
},
"serialBaudrate": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialbaudrate"
},
"preferHTML": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Preferhtml"
},
"deleteProcessedMail": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Deleteprocessedmail"
},
"host": {
"title": "Host",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"serialPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialport"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"messageMaxLength": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagemaxlength"
},
"bindPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindport"
},
"messageConvertBinary": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconvertbinary"
},
"messageCharset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagecharset"
},
"messageDelimiters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagedelimiters"
},
"updateOnWrite": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Updateonwrite"
},
"usernamePassword": {
"title": "Usernamepassword",
"type": "string"
},
"agentStatus": {
"title": "Agentstatus",
"type": "string"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"oAuthGrant": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Oauthgrant"
},
"port": {
"title": "Port",
"type": "string"
},
"messageStripDelimiter": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagestripdelimiter"
},
"location": {
"title": "Location",
"type": "string"
},
"bindHost": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindhost"
}
},
"required": [
"notes",
"agentDisabled",
"protocol",
"host",
"usernamePassword",
"agentStatus",
"port",
"location"
],
"title": "MailAgent"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'PresenceSensorAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"presence": {
"title": "Presence",
"type": "boolean"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
}
},
"required": [
"notes",
"location",
"presence"
],
"title": "PresenceSensorAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'SerialAgent' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"bindPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindport"
},
"messageConvertBinary": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconvertbinary"
},
"messageCharset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagecharset"
},
"messageConvertHex": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconverthex"
},
"agentDisabled": {
"title": "Agentdisabled",
"type": "boolean"
},
"messageDelimiters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagedelimiters"
},
"updateOnWrite": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Updateonwrite"
},
"usernamePassword": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Usernamepassword"
},
"agentStatus": {
"title": "Agentstatus",
"type": "string"
},
"pollingMillis": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Pollingmillis"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"oAuthGrant": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Oauthgrant"
},
"serialBaudrate": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialbaudrate"
},
"port": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Port"
},
"messageStripDelimiter": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagestripdelimiter"
},
"host": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Host"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"serialPort": {
"title": "Serialport",
"type": "string"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"messageMaxLength": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagemaxlength"
},
"bindHost": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindhost"
}
},
"required": [
"notes",
"agentDisabled",
"agentStatus",
"location",
"serialPort"
],
"title": "SerialAgent"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'ElectricityProducerWindAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"powerExportMin": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Powerexportmin"
},
"notes": {
"title": "Notes",
"type": "string"
},
"windSpeedReference": {
"title": "Windspeedreference",
"type": "number"
},
"efficiencyImport": {
"anyOf": [
{
"maximum": 100,
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Efficiencyimport"
},
"windSpeedMin": {
"title": "Windspeedmin",
"type": "number"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"tariffImport": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Tariffimport"
},
"powerSetpoint": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Powersetpoint"
},
"tariffExport": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Tariffexport"
},
"includeForecastWindService": {
"title": "Includeforecastwindservice",
"type": "boolean"
},
"efficiencyExport": {
"anyOf": [
{
"maximum": 100,
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Efficiencyexport"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"power": {
"title": "Power",
"type": "number"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"powerImportMax": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Powerimportmax"
},
"carbonImport": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Carbonimport"
},
"energyImportTotal": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Energyimporttotal"
},
"powerForecast": {
"title": "Powerforecast",
"type": "number"
},
"energyExportTotal": {
"title": "Energyexporttotal",
"type": "number"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"powerExportMax": {
"title": "Powerexportmax",
"type": "number"
},
"powerImportMin": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Powerimportmin"
},
"setWindActualValueWithForecast": {
"title": "Setwindactualvaluewithforecast",
"type": "boolean"
},
"windSpeedMax": {
"title": "Windspeedmax",
"type": "number"
},
"location": {
"title": "Location",
"type": "string"
}
},
"required": [
"notes",
"windSpeedReference",
"windSpeedMin",
"includeForecastWindService",
"power",
"powerForecast",
"energyExportTotal",
"powerExportMax",
"setWindActualValueWithForecast",
"windSpeedMax",
"location"
],
"title": "ElectricityProducerWindAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'TradfriPlugAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"onOff": {
"title": "Onoff",
"type": "boolean"
}
},
"required": [
"notes",
"location",
"onOff"
],
"title": "TradfriPlugAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'ElectricityBatteryAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"energyLevelPercentage": {
"maximum": 100,
"minimum": 0,
"title": "Energylevelpercentage",
"type": "integer"
},
"powerExportMin": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Powerexportmin"
},
"notes": {
"title": "Notes",
"type": "string"
},
"energyLevelPercentageMin": {
"maximum": 100,
"minimum": 0,
"title": "Energylevelpercentagemin",
"type": "integer"
},
"supportsExport": {
"title": "Supportsexport",
"type": "boolean"
},
"efficiencyImport": {
"maximum": 100,
"minimum": 0,
"title": "Efficiencyimport",
"type": "integer"
},
"energyCapacity": {
"title": "Energycapacity",
"type": "number"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"tariffImport": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Tariffimport"
},
"powerSetpoint": {
"title": "Powersetpoint",
"type": "number"
},
"energyLevel": {
"title": "Energylevel",
"type": "number"
},
"tariffExport": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Tariffexport"
},
"efficiencyExport": {
"maximum": 100,
"minimum": 0,
"title": "Efficiencyexport",
"type": "integer"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"power": {
"title": "Power",
"type": "number"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"supportsImport": {
"title": "Supportsimport",
"type": "boolean"
},
"chargeCycles": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Chargecycles"
},
"powerImportMax": {
"title": "Powerimportmax",
"type": "number"
},
"carbonImport": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Carbonimport"
},
"energyImportTotal": {
"title": "Energyimporttotal",
"type": "number"
},
"forceCharge": {
"title": "Forcecharge",
"type": "string"
},
"energyExportTotal": {
"title": "Energyexporttotal",
"type": "number"
},
"energyLevelSchedule": {
"anyOf": [
{
"items": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Energylevelschedule"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"energyLevelPercentageMax": {
"maximum": 100,
"minimum": 0,
"title": "Energylevelpercentagemax",
"type": "integer"
},
"powerExportMax": {
"title": "Powerexportmax",
"type": "number"
},
"powerImportMin": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Powerimportmin"
},
"location": {
"title": "Location",
"type": "string"
}
},
"required": [
"energyLevelPercentage",
"notes",
"energyLevelPercentageMin",
"supportsExport",
"efficiencyImport",
"energyCapacity",
"powerSetpoint",
"energyLevel",
"efficiencyExport",
"power",
"supportsImport",
"powerImportMax",
"energyImportTotal",
"forceCharge",
"energyExportTotal",
"energyLevelPercentageMax",
"powerExportMax",
"location"
],
"title": "ElectricityBatteryAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'ElectricityChargerAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"energyLevelPercentage": {
"maximum": 100,
"minimum": 0,
"title": "Energylevelpercentage",
"type": "integer"
},
"powerExportMin": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Powerexportmin"
},
"notes": {
"title": "Notes",
"type": "string"
},
"energyLevelPercentageMin": {
"maximum": 100,
"minimum": 0,
"title": "Energylevelpercentagemin",
"type": "integer"
},
"vehicleConnected": {
"title": "Vehicleconnected",
"type": "boolean"
},
"supportsExport": {
"title": "Supportsexport",
"type": "boolean"
},
"efficiencyImport": {
"maximum": 100,
"minimum": 0,
"title": "Efficiencyimport",
"type": "integer"
},
"energyCapacity": {
"title": "Energycapacity",
"type": "number"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"tariffImport": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Tariffimport"
},
"powerSetpoint": {
"title": "Powersetpoint",
"type": "number"
},
"energyLevel": {
"title": "Energylevel",
"type": "number"
},
"tariffExport": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Tariffexport"
},
"efficiencyExport": {
"maximum": 100,
"minimum": 0,
"title": "Efficiencyexport",
"type": "integer"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"power": {
"title": "Power",
"type": "number"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"supportsImport": {
"title": "Supportsimport",
"type": "boolean"
},
"connectorType": {
"title": "Connectortype",
"type": "string"
},
"powerImportMax": {
"title": "Powerimportmax",
"type": "number"
},
"carbonImport": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Carbonimport"
},
"energyImportTotal": {
"title": "Energyimporttotal",
"type": "number"
},
"forceCharge": {
"title": "Forcecharge",
"type": "string"
},
"energyExportTotal": {
"title": "Energyexporttotal",
"type": "number"
},
"energyLevelSchedule": {
"anyOf": [
{
"items": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Energylevelschedule"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"energyLevelPercentageMax": {
"maximum": 100,
"minimum": 0,
"title": "Energylevelpercentagemax",
"type": "integer"
},
"powerExportMax": {
"title": "Powerexportmax",
"type": "number"
},
"powerImportMin": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Powerimportmin"
},
"location": {
"title": "Location",
"type": "string"
},
"vehicleID": {
"title": "Vehicleid",
"type": "string"
}
},
"required": [
"energyLevelPercentage",
"notes",
"energyLevelPercentageMin",
"vehicleConnected",
"supportsExport",
"efficiencyImport",
"energyCapacity",
"powerSetpoint",
"energyLevel",
"efficiencyExport",
"power",
"supportsImport",
"connectorType",
"powerImportMax",
"energyImportTotal",
"forceCharge",
"energyExportTotal",
"energyLevelPercentageMax",
"powerExportMax",
"location",
"vehicleID"
],
"title": "ElectricityChargerAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'RoomAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"area": {
"title": "Area",
"type": "integer"
},
"notes": {
"title": "Notes",
"type": "string"
},
"roomNumber": {
"title": "Roomnumber",
"type": "integer"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
}
},
"required": [
"area",
"notes",
"roomNumber",
"location"
],
"title": "RoomAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'ConsoleAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"consoleVersion": {
"title": "Consoleversion",
"type": "string"
},
"consolePlatform": {
"title": "Consoleplatform",
"type": "string"
},
"notes": {
"title": "Notes",
"type": "string"
},
"consoleProviders": {
"title": "Consoleproviders",
"type": "string"
},
"consoleName": {
"title": "Consolename",
"type": "string"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
}
},
"required": [
"consoleVersion",
"consolePlatform",
"notes",
"consoleProviders",
"consoleName",
"location"
],
"title": "ConsoleAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'LightAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"brightness": {
"maximum": 100,
"minimum": 0,
"title": "Brightness",
"type": "integer"
},
"colourTemperature": {
"maximum": 10000,
"minimum": 1000,
"title": "Colourtemperature",
"type": "integer"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"colourRGB": {
"title": "Colourrgb",
"type": "string"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"onOff": {
"title": "Onoff",
"type": "boolean"
}
},
"required": [
"notes",
"brightness",
"colourTemperature",
"location",
"colourRGB",
"onOff"
],
"title": "LightAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'TCPAgent' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"bindPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindport"
},
"messageConvertBinary": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconvertbinary"
},
"messageCharset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagecharset"
},
"messageConvertHex": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconverthex"
},
"agentDisabled": {
"title": "Agentdisabled",
"type": "boolean"
},
"messageDelimiters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagedelimiters"
},
"updateOnWrite": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Updateonwrite"
},
"usernamePassword": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Usernamepassword"
},
"agentStatus": {
"title": "Agentstatus",
"type": "string"
},
"pollingMillis": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Pollingmillis"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"oAuthGrant": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Oauthgrant"
},
"serialBaudrate": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialbaudrate"
},
"port": {
"title": "Port",
"type": "string"
},
"messageStripDelimiter": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagestripdelimiter"
},
"host": {
"title": "Host",
"type": "string"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"serialPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialport"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"messageMaxLength": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagemaxlength"
},
"bindHost": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindhost"
}
},
"required": [
"notes",
"agentDisabled",
"agentStatus",
"port",
"host",
"location"
],
"title": "TCPAgent"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'HTTPAgent' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"requestQueryParameters": {
"title": "Requestqueryparameters",
"type": "string"
},
"notes": {
"title": "Notes",
"type": "string"
},
"messageConvertHex": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconverthex"
},
"agentDisabled": {
"title": "Agentdisabled",
"type": "boolean"
},
"pollingMillis": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Pollingmillis"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"requestTimeoutMillis": {
"title": "Requesttimeoutmillis",
"type": "integer"
},
"serialBaudrate": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialbaudrate"
},
"followRedirects": {
"title": "Followredirects",
"type": "boolean"
},
"host": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Host"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"serialPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialport"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"messageMaxLength": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagemaxlength"
},
"bindPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindport"
},
"messageConvertBinary": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconvertbinary"
},
"messageCharset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagecharset"
},
"messageDelimiters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagedelimiters"
},
"updateOnWrite": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Updateonwrite"
},
"usernamePassword": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Usernamepassword"
},
"agentStatus": {
"title": "Agentstatus",
"type": "string"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"oAuthGrant": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Oauthgrant"
},
"baseURL": {
"title": "Baseurl",
"type": "string"
},
"requestHeaders": {
"title": "Requestheaders",
"type": "string"
},
"port": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Port"
},
"messageStripDelimiter": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagestripdelimiter"
},
"location": {
"title": "Location",
"type": "string"
},
"bindHost": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindhost"
}
},
"required": [
"requestQueryParameters",
"notes",
"agentDisabled",
"requestTimeoutMillis",
"followRedirects",
"agentStatus",
"baseURL",
"requestHeaders",
"location"
],
"title": "HTTPAgent"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'VentilationAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"fanSpeed": {
"maximum": 100,
"minimum": 0,
"title": "Fanspeed",
"type": "integer"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"flow": {
"title": "Flow",
"type": "number"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
}
},
"required": [
"notes",
"location",
"fanSpeed",
"flow"
],
"title": "VentilationAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'BuildingAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"area": {
"title": "Area",
"type": "integer"
},
"country": {
"title": "Country",
"type": "string"
},
"notes": {
"title": "Notes",
"type": "string"
},
"city": {
"title": "City",
"type": "string"
},
"street": {
"title": "Street",
"type": "string"
},
"postalCode": {
"title": "Postalcode",
"type": "string"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"region": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Region"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
}
},
"required": [
"area",
"country",
"notes",
"city",
"street",
"postalCode",
"location"
],
"title": "BuildingAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'ModbusTcpAgent' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"messageConvertHex": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconverthex"
},
"agentDisabled": {
"title": "Agentdisabled",
"type": "boolean"
},
"pollingMillis": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Pollingmillis"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"serialBaudrate": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialbaudrate"
},
"host": {
"title": "Host",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"serialPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialport"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"messageMaxLength": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagemaxlength"
},
"deviceConfig": {
"title": "Deviceconfig",
"type": "string"
},
"bindPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindport"
},
"messageConvertBinary": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconvertbinary"
},
"messageCharset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagecharset"
},
"messageDelimiters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagedelimiters"
},
"updateOnWrite": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Updateonwrite"
},
"usernamePassword": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Usernamepassword"
},
"agentStatus": {
"title": "Agentstatus",
"type": "string"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"oAuthGrant": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Oauthgrant"
},
"port": {
"title": "Port",
"type": "string"
},
"messageStripDelimiter": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagestripdelimiter"
},
"location": {
"title": "Location",
"type": "string"
},
"bindHost": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindhost"
}
},
"required": [
"notes",
"agentDisabled",
"host",
"deviceConfig",
"agentStatus",
"port",
"location"
],
"title": "ModbusTcpAgent"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'EnergyOptimisationAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"financialSaving": {
"title": "Financialsaving",
"type": "number"
},
"carbonSaving": {
"title": "Carbonsaving",
"type": "number"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"optimisationDisabled": {
"title": "Optimisationdisabled",
"type": "boolean"
},
"intervalSize": {
"title": "Intervalsize",
"type": "number"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"financialWeighting": {
"maximum": 100,
"minimum": 0,
"title": "Financialweighting",
"type": "integer"
}
},
"required": [
"notes",
"financialSaving",
"carbonSaving",
"location",
"optimisationDisabled",
"intervalSize",
"financialWeighting"
],
"title": "EnergyOptimisationAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'SNMPAgent' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"messageConvertHex": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconverthex"
},
"agentDisabled": {
"title": "Agentdisabled",
"type": "boolean"
},
"pollingMillis": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Pollingmillis"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"serialBaudrate": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialbaudrate"
},
"host": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Host"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"serialPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialport"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"messageMaxLength": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagemaxlength"
},
"SNMPVersionValue": {
"title": "Snmpversionvalue",
"type": "string"
},
"bindPort": {
"title": "Bindport",
"type": "string"
},
"messageConvertBinary": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconvertbinary"
},
"messageCharset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagecharset"
},
"messageDelimiters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagedelimiters"
},
"updateOnWrite": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Updateonwrite"
},
"usernamePassword": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Usernamepassword"
},
"agentStatus": {
"title": "Agentstatus",
"type": "string"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"oAuthGrant": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Oauthgrant"
},
"port": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Port"
},
"messageStripDelimiter": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagestripdelimiter"
},
"location": {
"title": "Location",
"type": "string"
},
"bindHost": {
"title": "Bindhost",
"type": "string"
}
},
"required": [
"notes",
"agentDisabled",
"SNMPVersionValue",
"bindPort",
"agentStatus",
"location",
"bindHost"
],
"title": "SNMPAgent"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'DoorAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"unlock": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Unlock"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"lastAccess": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Lastaccess"
},
"position": {
"title": "Position",
"type": "boolean"
},
"locked": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Locked"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
}
},
"required": [
"notes",
"location",
"position"
],
"title": "DoorAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'MQTTAgent' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"wildcardSubscriptionTopics": {
"items": {
"type": "string"
},
"title": "Wildcardsubscriptiontopics",
"type": "array"
},
"notes": {
"title": "Notes",
"type": "string"
},
"messageConvertHex": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconverthex"
},
"agentDisabled": {
"title": "Agentdisabled",
"type": "boolean"
},
"certificateAlias": {
"title": "Certificatealias",
"type": "string"
},
"pollingMillis": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Pollingmillis"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"lastWillRetain": {
"title": "Lastwillretain",
"type": "boolean"
},
"serialBaudrate": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialbaudrate"
},
"resumeSession": {
"title": "Resumesession",
"type": "boolean"
},
"host": {
"title": "Host",
"type": "string"
},
"lastWillPayload": {
"title": "Lastwillpayload",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"serialPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialport"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"messageMaxLength": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagemaxlength"
},
"subscribeQos": {
"title": "Subscribeqos",
"type": "string"
},
"bindPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindport"
},
"clientId": {
"title": "Clientid",
"type": "string"
},
"messageConvertBinary": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconvertbinary"
},
"messageCharset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagecharset"
},
"publishQos": {
"title": "Publishqos",
"type": "string"
},
"websocketPath": {
"title": "Websocketpath",
"type": "string"
},
"websocketQuery": {
"title": "Websocketquery",
"type": "string"
},
"messageDelimiters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagedelimiters"
},
"updateOnWrite": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Updateonwrite"
},
"usernamePassword": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Usernamepassword"
},
"agentStatus": {
"title": "Agentstatus",
"type": "string"
},
"websocketMode": {
"title": "Websocketmode",
"type": "boolean"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"oAuthGrant": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Oauthgrant"
},
"lastWillTopic": {
"title": "Lastwilltopic",
"type": "string"
},
"port": {
"title": "Port",
"type": "string"
},
"messageStripDelimiter": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagestripdelimiter"
},
"location": {
"title": "Location",
"type": "string"
},
"secureMode": {
"title": "Securemode",
"type": "boolean"
},
"bindHost": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindhost"
}
},
"required": [
"wildcardSubscriptionTopics",
"notes",
"agentDisabled",
"certificateAlias",
"lastWillRetain",
"resumeSession",
"host",
"lastWillPayload",
"subscribeQos",
"clientId",
"publishQos",
"websocketPath",
"websocketQuery",
"agentStatus",
"websocketMode",
"lastWillTopic",
"port",
"location",
"secureMode"
],
"title": "MQTTAgent"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'KNXAgent' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"messageConvertHex": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconverthex"
},
"agentDisabled": {
"title": "Agentdisabled",
"type": "boolean"
},
"pollingMillis": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Pollingmillis"
},
"messageSourceAddress": {
"title": "Messagesourceaddress",
"type": "string"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"NATMode": {
"title": "Natmode",
"type": "boolean"
},
"serialBaudrate": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialbaudrate"
},
"host": {
"title": "Host",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"serialPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialport"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"messageMaxLength": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagemaxlength"
},
"bindPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindport"
},
"messageConvertBinary": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconvertbinary"
},
"messageCharset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagecharset"
},
"messageDelimiters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagedelimiters"
},
"updateOnWrite": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Updateonwrite"
},
"usernamePassword": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Usernamepassword"
},
"agentStatus": {
"title": "Agentstatus",
"type": "string"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"oAuthGrant": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Oauthgrant"
},
"port": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Port"
},
"messageStripDelimiter": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagestripdelimiter"
},
"location": {
"title": "Location",
"type": "string"
},
"routingMode": {
"title": "Routingmode",
"type": "boolean"
},
"bindHost": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindhost"
}
},
"required": [
"notes",
"agentDisabled",
"messageSourceAddress",
"NATMode",
"host",
"agentStatus",
"location",
"routingMode"
],
"title": "KNXAgent"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'ElectricityConsumerAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"powerExportMin": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Powerexportmin"
},
"notes": {
"title": "Notes",
"type": "string"
},
"powerImportMax": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Powerimportmax"
},
"carbonImport": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Carbonimport"
},
"energyImportTotal": {
"title": "Energyimporttotal",
"type": "number"
},
"powerForecast": {
"title": "Powerforecast",
"type": "number"
},
"efficiencyImport": {
"anyOf": [
{
"maximum": 100,
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Efficiencyimport"
},
"energyExportTotal": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Energyexporttotal"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"tariffImport": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Tariffimport"
},
"powerSetpoint": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Powersetpoint"
},
"powerExportMax": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Powerexportmax"
},
"powerImportMin": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Powerimportmin"
},
"tariffExport": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Tariffexport"
},
"efficiencyExport": {
"anyOf": [
{
"maximum": 100,
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Efficiencyexport"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"power": {
"title": "Power",
"type": "number"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
}
},
"required": [
"notes",
"energyImportTotal",
"powerForecast",
"location",
"power"
],
"title": "ElectricityConsumerAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'GroundwaterSensorAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"soilTemperature": {
"title": "Soiltemperature",
"type": "number"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"waterLevel": {
"title": "Waterlevel",
"type": "integer"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
}
},
"required": [
"notes",
"soilTemperature",
"location",
"waterLevel"
],
"title": "GroundwaterSensorAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'ElectricityProducerSolarAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"powerExportMin": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Powerexportmin"
},
"notes": {
"title": "Notes",
"type": "string"
},
"panelAzimuth": {
"title": "Panelazimuth",
"type": "integer"
},
"efficiencyImport": {
"anyOf": [
{
"maximum": 100,
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Efficiencyimport"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"tariffImport": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Tariffimport"
},
"powerSetpoint": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Powersetpoint"
},
"tariffExport": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Tariffexport"
},
"panelPitch": {
"title": "Panelpitch",
"type": "integer"
},
"efficiencyExport": {
"anyOf": [
{
"maximum": 100,
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Efficiencyexport"
},
"includeForecastSolarService": {
"title": "Includeforecastsolarservice",
"type": "boolean"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"power": {
"title": "Power",
"type": "number"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"setActualSolarValueWithForecast": {
"title": "Setactualsolarvaluewithforecast",
"type": "boolean"
},
"powerImportMax": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Powerimportmax"
},
"carbonImport": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Carbonimport"
},
"energyImportTotal": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Energyimporttotal"
},
"powerForecast": {
"title": "Powerforecast",
"type": "number"
},
"panelOrientation": {
"title": "Panelorientation",
"type": "string"
},
"energyExportTotal": {
"title": "Energyexporttotal",
"type": "number"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"powerExportMax": {
"title": "Powerexportmax",
"type": "number"
},
"powerImportMin": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Powerimportmin"
},
"location": {
"title": "Location",
"type": "string"
}
},
"required": [
"notes",
"panelAzimuth",
"panelPitch",
"includeForecastSolarService",
"power",
"setActualSolarValueWithForecast",
"powerForecast",
"panelOrientation",
"energyExportTotal",
"powerExportMax",
"location"
],
"title": "ElectricityProducerSolarAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'TheThingsStackAgent' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"MQTTHost": {
"title": "Mqtthost",
"type": "string"
},
"notes": {
"title": "Notes",
"type": "string"
},
"apiKey": {
"title": "Apikey",
"type": "string"
},
"messageConvertHex": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconverthex"
},
"agentDisabled": {
"title": "Agentdisabled",
"type": "boolean"
},
"certificateAlias": {
"title": "Certificatealias",
"type": "string"
},
"pollingMillis": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Pollingmillis"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"secureGRPC": {
"title": "Securegrpc",
"type": "boolean"
},
"lastWillRetain": {
"title": "Lastwillretain",
"type": "boolean"
},
"serialBaudrate": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialbaudrate"
},
"resumeSession": {
"title": "Resumesession",
"type": "boolean"
},
"host": {
"title": "Host",
"type": "string"
},
"lastWillPayload": {
"title": "Lastwillpayload",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"serialPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialport"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"messageMaxLength": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagemaxlength"
},
"subscribeQos": {
"title": "Subscribeqos",
"type": "string"
},
"bindPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindport"
},
"clientId": {
"title": "Clientid",
"type": "string"
},
"messageConvertBinary": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconvertbinary"
},
"messageCharset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagecharset"
},
"publishQos": {
"title": "Publishqos",
"type": "string"
},
"websocketPath": {
"title": "Websocketpath",
"type": "string"
},
"websocketQuery": {
"title": "Websocketquery",
"type": "string"
},
"messageDelimiters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagedelimiters"
},
"updateOnWrite": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Updateonwrite"
},
"usernamePassword": {
"title": "Usernamepassword",
"type": "string"
},
"agentStatus": {
"title": "Agentstatus",
"type": "string"
},
"websocketMode": {
"title": "Websocketmode",
"type": "boolean"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"oAuthGrant": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Oauthgrant"
},
"lastWillTopic": {
"title": "Lastwilltopic",
"type": "string"
},
"MQTTPort": {
"title": "Mqttport",
"type": "string"
},
"port": {
"title": "Port",
"type": "string"
},
"messageStripDelimiter": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagestripdelimiter"
},
"tenantId": {
"title": "Tenantid",
"type": "string"
},
"location": {
"title": "Location",
"type": "string"
},
"applicationId": {
"title": "Applicationid",
"type": "string"
},
"secureMode": {
"title": "Securemode",
"type": "boolean"
},
"bindHost": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindhost"
}
},
"required": [
"MQTTHost",
"notes",
"apiKey",
"agentDisabled",
"certificateAlias",
"secureGRPC",
"lastWillRetain",
"resumeSession",
"host",
"lastWillPayload",
"subscribeQos",
"clientId",
"publishQos",
"websocketPath",
"websocketQuery",
"usernamePassword",
"agentStatus",
"websocketMode",
"lastWillTopic",
"MQTTPort",
"port",
"tenantId",
"location",
"applicationId",
"secureMode"
],
"title": "TheThingsStackAgent"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'PlugAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"onOff": {
"title": "Onoff",
"type": "boolean"
}
},
"required": [
"notes",
"location",
"onOff"
],
"title": "PlugAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'PeopleCounterAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"countGrowthMinute": {
"title": "Countgrowthminute",
"type": "number"
},
"notes": {
"title": "Notes",
"type": "string"
},
"countIn": {
"title": "Countin",
"type": "integer"
},
"countInMinute": {
"title": "Countinminute",
"type": "integer"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"countTotal": {
"title": "Counttotal",
"type": "integer"
},
"countOut": {
"title": "Countout",
"type": "integer"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"countOutMinute": {
"title": "Countoutminute",
"type": "integer"
}
},
"required": [
"countGrowthMinute",
"notes",
"countIn",
"countInMinute",
"location",
"countTotal",
"countOut",
"countOutMinute"
],
"title": "PeopleCounterAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'BluetoothMeshAgent' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"messageConvertHex": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconverthex"
},
"agentDisabled": {
"title": "Agentdisabled",
"type": "boolean"
},
"pollingMillis": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Pollingmillis"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"serialBaudrate": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialbaudrate"
},
"host": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Host"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"serialPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialport"
},
"proxyAddress": {
"title": "Proxyaddress",
"type": "string"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"messageMaxLength": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagemaxlength"
},
"sequenceNumber": {
"title": "Sequencenumber",
"type": "integer"
},
"bindPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindport"
},
"sourceAddress": {
"title": "Sourceaddress",
"type": "string"
},
"messageConvertBinary": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconvertbinary"
},
"messageCharset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagecharset"
},
"applicationKey": {
"title": "Applicationkey",
"type": "string"
},
"messageDelimiters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagedelimiters"
},
"updateOnWrite": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Updateonwrite"
},
"usernamePassword": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Usernamepassword"
},
"agentStatus": {
"title": "Agentstatus",
"type": "string"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"oAuthGrant": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Oauthgrant"
},
"networkKey": {
"title": "Networkkey",
"type": "string"
},
"mtu": {
"title": "Mtu",
"type": "integer"
},
"port": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Port"
},
"messageStripDelimiter": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagestripdelimiter"
},
"location": {
"title": "Location",
"type": "string"
},
"bindHost": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindhost"
}
},
"required": [
"notes",
"agentDisabled",
"proxyAddress",
"sequenceNumber",
"sourceAddress",
"applicationKey",
"agentStatus",
"networkKey",
"mtu",
"location"
],
"title": "BluetoothMeshAgent"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'ChirpStackAgent' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"MQTTHost": {
"title": "Mqtthost",
"type": "string"
},
"notes": {
"title": "Notes",
"type": "string"
},
"apiKey": {
"title": "Apikey",
"type": "string"
},
"messageConvertHex": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconverthex"
},
"agentDisabled": {
"title": "Agentdisabled",
"type": "boolean"
},
"certificateAlias": {
"title": "Certificatealias",
"type": "string"
},
"pollingMillis": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Pollingmillis"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"secureGRPC": {
"title": "Securegrpc",
"type": "boolean"
},
"lastWillRetain": {
"title": "Lastwillretain",
"type": "boolean"
},
"serialBaudrate": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialbaudrate"
},
"resumeSession": {
"title": "Resumesession",
"type": "boolean"
},
"host": {
"title": "Host",
"type": "string"
},
"lastWillPayload": {
"title": "Lastwillpayload",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"serialPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialport"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"messageMaxLength": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagemaxlength"
},
"subscribeQos": {
"title": "Subscribeqos",
"type": "string"
},
"bindPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindport"
},
"clientId": {
"title": "Clientid",
"type": "string"
},
"messageConvertBinary": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconvertbinary"
},
"messageCharset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagecharset"
},
"publishQos": {
"title": "Publishqos",
"type": "string"
},
"websocketPath": {
"title": "Websocketpath",
"type": "string"
},
"websocketQuery": {
"title": "Websocketquery",
"type": "string"
},
"messageDelimiters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagedelimiters"
},
"updateOnWrite": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Updateonwrite"
},
"usernamePassword": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Usernamepassword"
},
"agentStatus": {
"title": "Agentstatus",
"type": "string"
},
"websocketMode": {
"title": "Websocketmode",
"type": "boolean"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"oAuthGrant": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Oauthgrant"
},
"lastWillTopic": {
"title": "Lastwilltopic",
"type": "string"
},
"MQTTPort": {
"title": "Mqttport",
"type": "string"
},
"port": {
"title": "Port",
"type": "string"
},
"messageStripDelimiter": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagestripdelimiter"
},
"location": {
"title": "Location",
"type": "string"
},
"applicationId": {
"title": "Applicationid",
"type": "string"
},
"secureMode": {
"title": "Securemode",
"type": "boolean"
},
"bindHost": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindhost"
}
},
"required": [
"MQTTHost",
"notes",
"apiKey",
"agentDisabled",
"certificateAlias",
"secureGRPC",
"lastWillRetain",
"resumeSession",
"host",
"lastWillPayload",
"subscribeQos",
"clientId",
"publishQos",
"websocketPath",
"websocketQuery",
"agentStatus",
"websocketMode",
"lastWillTopic",
"MQTTPort",
"port",
"location",
"applicationId",
"secureMode"
],
"title": "ChirpStackAgent"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'VelbusTCPAgent' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"messageConvertHex": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconverthex"
},
"agentDisabled": {
"title": "Agentdisabled",
"type": "boolean"
},
"pollingMillis": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Pollingmillis"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"serialBaudrate": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialbaudrate"
},
"host": {
"title": "Host",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"serialPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialport"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"messageMaxLength": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagemaxlength"
},
"bindPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindport"
},
"messageConvertBinary": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconvertbinary"
},
"messageCharset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagecharset"
},
"messageDelimiters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagedelimiters"
},
"updateOnWrite": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Updateonwrite"
},
"usernamePassword": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Usernamepassword"
},
"agentStatus": {
"title": "Agentstatus",
"type": "string"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"oAuthGrant": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Oauthgrant"
},
"port": {
"title": "Port",
"type": "string"
},
"messageStripDelimiter": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagestripdelimiter"
},
"location": {
"title": "Location",
"type": "string"
},
"timeInjectionInterval": {
"title": "Timeinjectioninterval",
"type": "integer"
},
"bindHost": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindhost"
}
},
"required": [
"notes",
"agentDisabled",
"host",
"agentStatus",
"port",
"location",
"timeInjectionInterval"
],
"title": "VelbusTCPAgent"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'GatewayAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"clientId": {
"title": "Clientid",
"type": "string"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"clientSecret": {
"title": "Clientsecret",
"type": "string"
},
"disabled": {
"title": "Disabled",
"type": "boolean"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"gatewayStatus": {
"title": "Gatewaystatus",
"type": "string"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"tunnelingSupported": {
"title": "Tunnelingsupported",
"type": "boolean"
}
},
"required": [
"notes",
"clientId",
"location",
"clientSecret",
"disabled",
"gatewayStatus",
"tunnelingSupported"
],
"title": "GatewayAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'GroupAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"childAssetType": {
"title": "Childassettype",
"type": "string"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
}
},
"required": [
"notes",
"location",
"childAssetType"
],
"title": "GroupAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'MicrophoneAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"soundLevel": {
"title": "Soundlevel",
"type": "number"
},
"notes": {
"title": "Notes",
"type": "string"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
}
},
"required": [
"soundLevel",
"notes",
"location"
],
"title": "MicrophoneAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'ModbusSerialAgent' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"parity": {
"title": "Parity",
"type": "string"
},
"messageConvertHex": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconverthex"
},
"agentDisabled": {
"title": "Agentdisabled",
"type": "boolean"
},
"dataBits": {
"title": "Databits",
"type": "integer"
},
"pollingMillis": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Pollingmillis"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"serialBaudrate": {
"title": "Serialbaudrate",
"type": "integer"
},
"host": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Host"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"serialPort": {
"title": "Serialport",
"type": "string"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"messageMaxLength": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagemaxlength"
},
"deviceConfig": {
"title": "Deviceconfig",
"type": "string"
},
"bindPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindport"
},
"messageConvertBinary": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconvertbinary"
},
"messageCharset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagecharset"
},
"messageDelimiters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagedelimiters"
},
"updateOnWrite": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Updateonwrite"
},
"usernamePassword": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Usernamepassword"
},
"agentStatus": {
"title": "Agentstatus",
"type": "string"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"oAuthGrant": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Oauthgrant"
},
"stopbits": {
"title": "Stopbits",
"type": "string"
},
"port": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Port"
},
"messageStripDelimiter": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagestripdelimiter"
},
"location": {
"title": "Location",
"type": "string"
},
"bindHost": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindhost"
}
},
"required": [
"notes",
"parity",
"agentDisabled",
"dataBits",
"serialBaudrate",
"serialPort",
"deviceConfig",
"agentStatus",
"stopbits",
"location"
],
"title": "ModbusSerialAgent"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'ElectricityProducerAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"powerExportMin": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Powerexportmin"
},
"notes": {
"title": "Notes",
"type": "string"
},
"powerImportMax": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Powerimportmax"
},
"carbonImport": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Carbonimport"
},
"energyImportTotal": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Energyimporttotal"
},
"powerForecast": {
"title": "Powerforecast",
"type": "number"
},
"efficiencyImport": {
"anyOf": [
{
"maximum": 100,
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Efficiencyimport"
},
"energyExportTotal": {
"title": "Energyexporttotal",
"type": "number"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"tariffImport": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Tariffimport"
},
"powerSetpoint": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Powersetpoint"
},
"powerExportMax": {
"title": "Powerexportmax",
"type": "number"
},
"powerImportMin": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Powerimportmin"
},
"tariffExport": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Tariffexport"
},
"efficiencyExport": {
"anyOf": [
{
"maximum": 100,
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Efficiencyexport"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"power": {
"title": "Power",
"type": "number"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
}
},
"required": [
"notes",
"powerForecast",
"energyExportTotal",
"powerExportMax",
"location",
"power"
],
"title": "ElectricityProducerAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'UDPAgent' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"bindPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindport"
},
"messageConvertBinary": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconvertbinary"
},
"messageCharset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagecharset"
},
"messageConvertHex": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconverthex"
},
"agentDisabled": {
"title": "Agentdisabled",
"type": "boolean"
},
"messageDelimiters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagedelimiters"
},
"updateOnWrite": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Updateonwrite"
},
"usernamePassword": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Usernamepassword"
},
"agentStatus": {
"title": "Agentstatus",
"type": "string"
},
"pollingMillis": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Pollingmillis"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"oAuthGrant": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Oauthgrant"
},
"serialBaudrate": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialbaudrate"
},
"port": {
"title": "Port",
"type": "string"
},
"messageStripDelimiter": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagestripdelimiter"
},
"host": {
"title": "Host",
"type": "string"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"serialPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialport"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"messageMaxLength": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagemaxlength"
},
"bindHost": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindhost"
}
},
"required": [
"notes",
"agentDisabled",
"agentStatus",
"port",
"host",
"location"
],
"title": "UDPAgent"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'OpenWeatherMapAgent' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"ApiKey": {
"title": "Apikey",
"type": "string"
},
"ProvisionWeatherAsset": {
"title": "Provisionweatherasset",
"type": "boolean"
},
"messageConvertHex": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconverthex"
},
"agentDisabled": {
"title": "Agentdisabled",
"type": "boolean"
},
"pollingMillis": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Pollingmillis"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"serialBaudrate": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialbaudrate"
},
"host": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Host"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"serialPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialport"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"messageMaxLength": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagemaxlength"
},
"bindPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindport"
},
"messageConvertBinary": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconvertbinary"
},
"messageCharset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagecharset"
},
"messageDelimiters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagedelimiters"
},
"updateOnWrite": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Updateonwrite"
},
"usernamePassword": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Usernamepassword"
},
"agentStatus": {
"title": "Agentstatus",
"type": "string"
},
"Attribution": {
"title": "Attribution",
"type": "string"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"oAuthGrant": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Oauthgrant"
},
"port": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Port"
},
"messageStripDelimiter": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagestripdelimiter"
},
"location": {
"title": "Location",
"type": "string"
},
"bindHost": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindhost"
}
},
"required": [
"notes",
"ApiKey",
"ProvisionWeatherAsset",
"agentDisabled",
"agentStatus",
"Attribution",
"location"
],
"title": "OpenWeatherMapAgent"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'WebsocketAgent' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"messageConvertHex": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconverthex"
},
"agentDisabled": {
"title": "Agentdisabled",
"type": "boolean"
},
"pollingMillis": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Pollingmillis"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"pingDisabled": {
"title": "Pingdisabled",
"type": "boolean"
},
"serialBaudrate": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialbaudrate"
},
"host": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Host"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"serialPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialport"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"messageMaxLength": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagemaxlength"
},
"connectURL": {
"title": "Connecturl",
"type": "string"
},
"bindPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindport"
},
"messageConvertBinary": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconvertbinary"
},
"messageCharset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagecharset"
},
"messageDelimiters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagedelimiters"
},
"updateOnWrite": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Updateonwrite"
},
"usernamePassword": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Usernamepassword"
},
"agentStatus": {
"title": "Agentstatus",
"type": "string"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"oAuthGrant": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Oauthgrant"
},
"connectSubscriptions": {
"items": {
"type": "string"
},
"title": "Connectsubscriptions",
"type": "array"
},
"port": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Port"
},
"messageStripDelimiter": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagestripdelimiter"
},
"location": {
"title": "Location",
"type": "string"
},
"connectHeaders": {
"title": "Connectheaders",
"type": "string"
},
"bindHost": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindhost"
}
},
"required": [
"notes",
"agentDisabled",
"pingDisabled",
"connectURL",
"agentStatus",
"connectSubscriptions",
"location",
"connectHeaders"
],
"title": "WebsocketAgent"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'ElectricVehicleAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"energyLevelPercentage": {
"maximum": 100,
"minimum": 0,
"title": "Energylevelpercentage",
"type": "integer"
},
"powerExportMin": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Powerexportmin"
},
"notes": {
"title": "Notes",
"type": "string"
},
"energyLevelPercentageMin": {
"maximum": 100,
"minimum": 0,
"title": "Energylevelpercentagemin",
"type": "integer"
},
"supportsExport": {
"title": "Supportsexport",
"type": "boolean"
},
"chargerID": {
"title": "Chargerid",
"type": "string"
},
"efficiencyImport": {
"maximum": 100,
"minimum": 0,
"title": "Efficiencyimport",
"type": "integer"
},
"energyCapacity": {
"title": "Energycapacity",
"type": "number"
},
"vehicleCategory": {
"title": "Vehiclecategory",
"type": "string"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"tariffImport": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Tariffimport"
},
"powerSetpoint": {
"title": "Powersetpoint",
"type": "number"
},
"energyLevel": {
"title": "Energylevel",
"type": "number"
},
"tariffExport": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Tariffexport"
},
"efficiencyExport": {
"maximum": 100,
"minimum": 0,
"title": "Efficiencyexport",
"type": "integer"
},
"mileageCharged": {
"title": "Mileagecharged",
"type": "number"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"power": {
"title": "Power",
"type": "number"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"supportsImport": {
"title": "Supportsimport",
"type": "boolean"
},
"mileageCapacity": {
"title": "Mileagecapacity",
"type": "integer"
},
"chargeCycles": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Chargecycles"
},
"connectorType": {
"title": "Connectortype",
"type": "string"
},
"mileageMin": {
"title": "Mileagemin",
"type": "integer"
},
"powerImportMax": {
"title": "Powerimportmax",
"type": "number"
},
"odometer": {
"title": "Odometer",
"type": "integer"
},
"carbonImport": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Carbonimport"
},
"energyImportTotal": {
"title": "Energyimporttotal",
"type": "number"
},
"forceCharge": {
"title": "Forcecharge",
"type": "string"
},
"chargerConnected": {
"title": "Chargerconnected",
"type": "boolean"
},
"energyExportTotal": {
"title": "Energyexporttotal",
"type": "number"
},
"energyLevelSchedule": {
"anyOf": [
{
"items": {
"items": {
"type": "integer"
},
"type": "array"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Energylevelschedule"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"energyType": {
"title": "Energytype",
"type": "string"
},
"energyLevelPercentageMax": {
"maximum": 100,
"minimum": 0,
"title": "Energylevelpercentagemax",
"type": "integer"
},
"powerExportMax": {
"title": "Powerexportmax",
"type": "number"
},
"powerImportMin": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Powerimportmin"
},
"location": {
"title": "Location",
"type": "string"
}
},
"required": [
"energyLevelPercentage",
"notes",
"energyLevelPercentageMin",
"supportsExport",
"chargerID",
"efficiencyImport",
"energyCapacity",
"vehicleCategory",
"powerSetpoint",
"energyLevel",
"efficiencyExport",
"mileageCharged",
"power",
"supportsImport",
"mileageCapacity",
"connectorType",
"mileageMin",
"powerImportMax",
"odometer",
"energyImportTotal",
"forceCharge",
"chargerConnected",
"energyExportTotal",
"energyType",
"energyLevelPercentageMax",
"powerExportMax",
"location"
],
"title": "ElectricVehicleAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'StorageSimulatorAgent' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"bindPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindport"
},
"messageConvertBinary": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconvertbinary"
},
"messageCharset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagecharset"
},
"messageConvertHex": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconverthex"
},
"agentDisabled": {
"title": "Agentdisabled",
"type": "boolean"
},
"messageDelimiters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagedelimiters"
},
"updateOnWrite": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Updateonwrite"
},
"usernamePassword": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Usernamepassword"
},
"agentStatus": {
"title": "Agentstatus",
"type": "string"
},
"pollingMillis": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Pollingmillis"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"oAuthGrant": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Oauthgrant"
},
"serialBaudrate": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialbaudrate"
},
"port": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Port"
},
"messageStripDelimiter": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagestripdelimiter"
},
"host": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Host"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"serialPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialport"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"messageMaxLength": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagemaxlength"
},
"bindHost": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindhost"
}
},
"required": [
"notes",
"agentDisabled",
"agentStatus",
"location"
],
"title": "StorageSimulatorAgent"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'SimulatorAgent' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"bindPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindport"
},
"messageConvertBinary": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconvertbinary"
},
"messageCharset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagecharset"
},
"messageConvertHex": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconverthex"
},
"agentDisabled": {
"title": "Agentdisabled",
"type": "boolean"
},
"messageDelimiters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagedelimiters"
},
"updateOnWrite": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Updateonwrite"
},
"usernamePassword": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Usernamepassword"
},
"agentStatus": {
"title": "Agentstatus",
"type": "string"
},
"pollingMillis": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Pollingmillis"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"oAuthGrant": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Oauthgrant"
},
"serialBaudrate": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialbaudrate"
},
"port": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Port"
},
"messageStripDelimiter": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagestripdelimiter"
},
"host": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Host"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"serialPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialport"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"messageMaxLength": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagemaxlength"
},
"bindHost": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindhost"
}
},
"required": [
"notes",
"agentDisabled",
"agentStatus",
"location"
],
"title": "SimulatorAgent"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'ThermostatAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"temperatureSetpoint": {
"title": "Temperaturesetpoint",
"type": "number"
},
"temperature": {
"title": "Temperature",
"type": "number"
},
"cooling": {
"title": "Cooling",
"type": "boolean"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
}
},
"required": [
"notes",
"temperatureSetpoint",
"temperature",
"cooling",
"location"
],
"title": "ThermostatAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'ParkingAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"spacesTotal": {
"title": "Spacestotal",
"type": "integer"
},
"notes": {
"title": "Notes",
"type": "string"
},
"priceDaily": {
"title": "Pricedaily",
"type": "number"
},
"spacesBuffer": {
"title": "Spacesbuffer",
"type": "integer"
},
"priceHourly": {
"title": "Pricehourly",
"type": "number"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"spacesOpen": {
"title": "Spacesopen",
"type": "integer"
},
"spacesOccupied": {
"title": "Spacesoccupied",
"type": "integer"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
}
},
"required": [
"spacesTotal",
"notes",
"priceDaily",
"spacesBuffer",
"priceHourly",
"location",
"spacesOpen",
"spacesOccupied"
],
"title": "ParkingAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'ArtnetLightAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"groupId": {
"title": "Groupid",
"type": "integer"
},
"colourRGB": {
"title": "Colourrgb",
"type": "string"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"requiredValues": {
"items": {
"type": "string"
},
"title": "Requiredvalues",
"type": "array"
},
"brightness": {
"maximum": 100,
"minimum": 0,
"title": "Brightness",
"type": "integer"
},
"colourTemperature": {
"maximum": 10000,
"minimum": 1000,
"title": "Colourtemperature",
"type": "integer"
},
"universe": {
"title": "Universe",
"type": "integer"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"lightId": {
"title": "Lightid",
"type": "integer"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"lEDCount": {
"title": "Ledcount",
"type": "integer"
},
"onOff": {
"title": "Onoff",
"type": "boolean"
}
},
"required": [
"notes",
"groupId",
"colourRGB",
"requiredValues",
"brightness",
"colourTemperature",
"universe",
"location",
"lightId",
"lEDCount",
"onOff"
],
"title": "ArtnetLightAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'WeatherAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"sunIrradiance": {
"title": "Sunirradiance",
"type": "number"
},
"rainfall": {
"title": "Rainfall",
"type": "number"
},
"notes": {
"title": "Notes",
"type": "string"
},
"uVIndex": {
"title": "Uvindex",
"type": "number"
},
"sunAzimuth": {
"title": "Sunazimuth",
"type": "number"
},
"cloudCoverage": {
"anyOf": [
{
"maximum": 100,
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Cloudcoverage"
},
"sunZenith": {
"title": "Sunzenith",
"type": "number"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"windGustSpeed": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Windgustspeed"
},
"probabilityOfPrecipitation": {
"anyOf": [
{
"maximum": 1,
"minimum": 0,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Probabilityofprecipitation"
},
"temperature": {
"title": "Temperature",
"type": "number"
},
"humidity": {
"maximum": 100,
"minimum": 0,
"title": "Humidity",
"type": "integer"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"windDirection": {
"title": "Winddirection",
"type": "string"
},
"sunAltitude": {
"title": "Sunaltitude",
"type": "number"
},
"windSpeed": {
"title": "Windspeed",
"type": "number"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"atmosphericPressure": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Atmosphericpressure"
}
},
"required": [
"sunIrradiance",
"rainfall",
"notes",
"uVIndex",
"sunAzimuth",
"sunZenith",
"temperature",
"humidity",
"location",
"windDirection",
"sunAltitude",
"windSpeed"
],
"title": "WeatherAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'ZWaveAgent' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"bindPort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindport"
},
"messageConvertBinary": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconvertbinary"
},
"messageCharset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagecharset"
},
"messageConvertHex": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messageconverthex"
},
"agentDisabled": {
"title": "Agentdisabled",
"type": "boolean"
},
"messageDelimiters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagedelimiters"
},
"updateOnWrite": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Updateonwrite"
},
"usernamePassword": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Usernamepassword"
},
"agentStatus": {
"title": "Agentstatus",
"type": "string"
},
"pollingMillis": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Pollingmillis"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"oAuthGrant": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Oauthgrant"
},
"serialBaudrate": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Serialbaudrate"
},
"port": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Port"
},
"messageStripDelimiter": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagestripdelimiter"
},
"host": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Host"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"serialPort": {
"title": "Serialport",
"type": "string"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"messageMaxLength": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Messagemaxlength"
},
"bindHost": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Bindhost"
}
},
"required": [
"notes",
"agentDisabled",
"agentStatus",
"location",
"serialPort"
],
"title": "ZWaveAgent"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'ShipAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"MSSINumber": {
"title": "Mssinumber",
"type": "integer"
},
"length": {
"title": "Length",
"type": "integer"
},
"speed": {
"title": "Speed",
"type": "number"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"shipType": {
"title": "Shiptype",
"type": "string"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"ENINumber": {
"title": "Eninumber",
"type": "integer"
},
"IMONumber": {
"title": "Imonumber",
"type": "integer"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"direction": {
"title": "Direction",
"type": "string"
}
},
"required": [
"notes",
"MSSINumber",
"length",
"speed",
"shipType",
"location",
"ENINumber",
"IMONumber",
"direction"
],
"title": "ShipAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'EnvironmentSensorAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"particlesPM2_5": {
"title": "Particlespm2 5",
"type": "integer"
},
"NO2Level": {
"title": "No2Level",
"type": "integer"
},
"particlesPM1": {
"title": "Particlespm1",
"type": "integer"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"particlesPM10": {
"title": "Particlespm10",
"type": "integer"
},
"ozoneLevel": {
"title": "Ozonelevel",
"type": "integer"
},
"temperature": {
"title": "Temperature",
"type": "number"
},
"relativeHumidity": {
"title": "Relativehumidity",
"type": "number"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
}
},
"required": [
"notes",
"particlesPM2_5",
"NO2Level",
"particlesPM1",
"particlesPM10",
"ozoneLevel",
"temperature",
"relativeHumidity",
"location"
],
"title": "EnvironmentSensorAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'ElectricitySupplierAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"powerExportMin": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Powerexportmin"
},
"notes": {
"title": "Notes",
"type": "string"
},
"energyLocal": {
"title": "Energylocal",
"type": "number"
},
"efficiencyImport": {
"anyOf": [
{
"maximum": 100,
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Efficiencyimport"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
},
"carbonCost": {
"title": "Carboncost",
"type": "number"
},
"tariffImport": {
"title": "Tariffimport",
"type": "number"
},
"powerSetpoint": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Powersetpoint"
},
"energyRenewableShare": {
"title": "Energyrenewableshare",
"type": "number"
},
"tariffExport": {
"title": "Tariffexport",
"type": "number"
},
"efficiencyExport": {
"anyOf": [
{
"maximum": 100,
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Efficiencyexport"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"financialCost": {
"title": "Financialcost",
"type": "number"
},
"power": {
"title": "Power",
"type": "number"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"carbonExport": {
"title": "Carbonexport",
"type": "number"
},
"powerImportMax": {
"title": "Powerimportmax",
"type": "number"
},
"carbonImport": {
"title": "Carbonimport",
"type": "number"
},
"energyImportTotal": {
"title": "Energyimporttotal",
"type": "number"
},
"energySelfConsumption": {
"title": "Energyselfconsumption",
"type": "number"
},
"energyExportTotal": {
"title": "Energyexporttotal",
"type": "number"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"energyAutarky": {
"title": "Energyautarky",
"type": "number"
},
"powerExportMax": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Powerexportmax"
},
"powerImportMin": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Powerimportmin"
},
"location": {
"title": "Location",
"type": "string"
}
},
"required": [
"notes",
"energyLocal",
"carbonCost",
"tariffImport",
"energyRenewableShare",
"tariffExport",
"financialCost",
"power",
"carbonExport",
"powerImportMax",
"carbonImport",
"energyImportTotal",
"energySelfConsumption",
"energyExportTotal",
"energyAutarky",
"location"
],
"title": "ElectricitySupplierAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'ThingAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"notes": {
"title": "Notes",
"type": "string"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
}
},
"required": [
"notes",
"location"
],
"title": "ThingAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Create a new 'CityAsset' in the OpenRemote platform.
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"additionalProperties": true,
"type": "object",
"description": "Attributes of the asset to create.",
"properties": {
"country": {
"title": "Country",
"type": "string"
},
"notes": {
"title": "Notes",
"type": "string"
},
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "City"
},
"location": {
"title": "Location",
"type": "string"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"region": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Region"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"manufacturer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Manufacturer"
}
},
"required": [
"country",
"notes",
"location"
],
"title": "CityAsset"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"parentId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"realm": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"attributes",
"name"
]
}Retrieve the asset type information of each available asset type
{
"properties": {},
"type": "object"
}Retrieve the asset type information of an asset type
{
"properties": {
"asset_type": {
"type": "string"
}
},
"required": [
"asset_type"
],
"type": "object"
}Retrieve all realms.
{
"properties": {},
"type": "object"
}Retrieve details about the currently authenticated and active realm.
{
"properties": {
"realm_name": {
"type": "string"
}
},
"required": [
"realm_name"
],
"type": "object"
}