GatewayConnection

Connection from a local realm to a remote OpenRemote gateway, including credentials and synchronization rules.

assetSyncRules object

Synchronization rules keyed by asset type; use * as a wildcard.

property name* GatewayAssetSyncRule

Synchronization rules keyed by asset type; use * as a wildcard.

accessPublicReadboolean

addAttributeMeta object

property name* MetaMap

delegate object

property name* MetaItemObject

namestringrequired

Machine-readable name.

Possible values: non-empty, Value must match regular expression ^\w+$

Example: temperature

type object

arrayDimensionsinteger<int32>

constraints object[]

Array [

messagestring

type stringrequired

Possible values: []

]

format object

asBooleanboolean

asDateboolean

asMomentaryboolean

asNumberboolean

asOnOffboolean

asOpenClosedboolean

asPressedReleasedboolean

asSliderboolean

dateStylestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

daystring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

dayPeriodstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

erastring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

fractionalSecondDigitsinteger<int32>

hourstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour12boolean

iso8601boolean

maximumFractionDigitsinteger<int32>

maximumSignificantDigitsinteger<int32>

minimumFractionDigitsinteger<int32>

minimumIntegerDigitsinteger<int32>

minimumSignificantDigitsinteger<int32>

minutestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

momentJsFormatstring

monthstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

multilineboolean

resolutionnumber

secondstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

timeStylestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

timeZoneNamestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

useGroupingboolean

weekstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

weekdaystring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

yearstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

jsonTypestring

metaUseOnlyboolean

namestring

Possible values: Value must match regular expression ^\w+(\[\])?$

unitsstring[]

property name* MetaItemObject

namestringrequired

Machine-readable name.

Possible values: non-empty, Value must match regular expression ^\w+$

Example: temperature

type object

arrayDimensionsinteger<int32>

constraints object[]

Array [

messagestring

type stringrequired

Possible values: []

]

format object

asBooleanboolean

asDateboolean

asMomentaryboolean

asNumberboolean

asOnOffboolean

asOpenClosedboolean

asPressedReleasedboolean

asSliderboolean

dateStylestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

daystring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

dayPeriodstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

erastring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

fractionalSecondDigitsinteger<int32>

hourstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

hour12boolean

iso8601boolean

maximumFractionDigitsinteger<int32>

maximumSignificantDigitsinteger<int32>

minimumFractionDigitsinteger<int32>

minimumIntegerDigitsinteger<int32>

minimumSignificantDigitsinteger<int32>

minutestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

momentJsFormatstring

monthstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

multilineboolean

resolutionnumber

secondstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

timeStylestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

timeZoneNamestring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

useGroupingboolean

weekstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

weekdaystring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

yearstring

Possible values: [numeric, 2-digit, full, long, medium, short, narrow]

jsonTypestring

metaUseOnlyboolean

namestring

Possible values: Value must match regular expression ^\w+(\[\])?$

unitsstring[]

excludeAttributeMeta object

property name* string[]

Array [

string

]

excludeAttributesstring[]

attributeFilters object[]

Ordered attribute-event filters; the first matching filter is applied.

Array [

deltanumber<double>

durationstring

durationParsedMillisinteger<int64>

matcher object

Composable asset search request. Populated filters are combined to restrict results; limit and offset provide pagination.

accessstring

Requested visibility class relative to the caller.

Possible values: [PRIVATE, PROTECTED, PUBLIC]

attributes object

groups []

Array [

circular(LogicGroupAttributePredicate)

]

items object[]

Array [

meta object[]

Array [

name object

String matcher supporting exact, prefix, suffix, or contains matching, case sensitivity, and negation.

caseSensitiveboolean

matchstring

Possible values: [EXACT, BEGIN, END, CONTAINS]

negateboolean

valuestring

negatedboolean

pathobject[]

value object

predicateType stringrequired

Possible values: []

]

name object

String matcher supporting exact, prefix, suffix, or contains matching, case sensitivity, and negation.

caseSensitiveboolean

matchstring

Possible values: [EXACT, BEGIN, END, CONTAINS]

negateboolean

valuestring

negatedboolean

pathobject[]

previousValue object

predicateType stringrequired

Possible values: []

timestampOlderThanstring

value object

predicateType stringrequired

Possible values: []

]

operatorstring

Possible values: [AND, OR]

idsstring[]

Match these exact asset identifiers.

limitinteger<int32>

Maximum number of results; zero uses the server default.

Example: 100

names object[]

Array [

caseSensitiveboolean

matchstring

Possible values: [EXACT, BEGIN, END, CONTAINS]

negateboolean

valuestring

]

offsetinteger<int32>

Number of matching results to skip.

Example: 0

orderBy object

Asset result ordering.

descendingboolean

Reverse the default ascending order.

Example: false

propertystring

Asset property used for ordering.

Possible values: [CREATED_ON, NAME, ASSET_TYPE, PARENT_ID, REALM]

Example: NAME

parents object[]

Array [

idstringnullable

Direct parent asset identifier; null selects root assets.

]

paths object[]

Array [

pathstring[]

Ordered asset identifiers in the ancestry path.

]

realm object

Matches an exact realm name.

namestring

Realm name.

Example: building

recursiveboolean

When parent or path filters are used, include matching descendants.

Example: true

select object

Response projection for controlling which asset attributes are returned.

attributesstring[]

Attribute names to include. An empty array excludes all attributes; null returns all attributes.

Example: ["temperature","humidity"]

typesstring[]

Match registered asset type names; base types include their concrete subtypes.

Example: ["ThingAsset"]

userIdsstring[]

Match assets linked to any of these users.

skipAlwaysboolean

valueChangeboolean

]

clientIdstringrequired

Remote identity-provider client identifier.

Possible values: non-empty and <= 255 characters

Example: openremote

clientSecretstring<password>required

Remote identity-provider client secret.

Possible values: >= 36 characters and <= 36 characters

disabledboolean

Keep the configuration but prevent connection and synchronization.

Example: false

hoststringrequired

Remote gateway hostname without a scheme.

Possible values: non-empty and <= 255 characters

Example: gateway.example.com

localRealmstring

Local realm whose assets participate in this gateway connection.

Example: building

portinteger<int32>

Remote HTTPS or HTTP port.

Possible values: >= 1 and <= 65536

Example: 443

realmstring

Realm used to authenticate on the remote gateway.

Example: master

securedboolean

Use TLS for the remote connection; defaults to true.

Example: true

GatewayConnection

{
  "assetSyncRules": {},
  "attributeFilters": [
    {
      "delta": 0,
      "duration": "string",
      "durationParsedMillis": 0,
      "matcher": {
        "access": "PRIVATE",
        "attributes": {
          "groups": [
            null
          ],
          "items": [
            {
              "meta": [
                {
                  "name": {
                    "caseSensitive": true,
                    "match": "EXACT",
                    "negate": true,
                    "value": "string"
                  },
                  "negated": true,
                  "path": [
                    {}
                  ],
                  "value": {
                    "predicateType": "string"
                  }
                }
              ],
              "name": {
                "caseSensitive": true,
                "match": "EXACT",
                "negate": true,
                "value": "string"
              },
              "negated": true,
              "path": [
                {}
              ],
              "previousValue": {
                "predicateType": "string"
              },
              "timestampOlderThan": "string",
              "value": {
                "predicateType": "string"
              }
            }
          ],
          "operator": "AND"
        },
        "ids": [
          "string"
        ],
        "limit": 100,
        "names": [
          {
            "caseSensitive": true,
            "match": "EXACT",
            "negate": true,
            "value": "string"
          }
        ],
        "offset": 0,
        "orderBy": {
          "descending": false,
          "property": "NAME"
        },
        "parents": [
          {
            "id": "string"
          }
        ],
        "paths": [
          {
            "path": [
              "string"
            ]
          }
        ],
        "realm": {
          "name": "building"
        },
        "recursive": true,
        "select": {
          "attributes": [
            "temperature",
            "humidity"
          ]
        },
        "types": [
          "ThingAsset"
        ],
        "userIds": [
          "string"
        ]
      },
      "skipAlways": true,
      "valueChange": true
    }
  ],
  "clientId": "openremote",
  "clientSecret": "string",
  "disabled": false,
  "host": "gateway.example.com",
  "localRealm": "building",
  "port": 443,
  "realm": "master",
  "secured": true
}