Propertyrelay

Description

The change processor module tracks changes in one property and based on that triggers a change in a different device or service.

API

Endpoints

POST

Create Property Relay

GET

List Property Relay Settings

DEL

Delete Property Relay Settings

GET

Get Property Relay Setting

PATCH

Update Property Relay Setting

DEL

Delete Property Relay Setting

Create Property Relay

Creates a new property relay that can handle property changes based on a different device.

POST

/api/v1/propertyrelay

Access

This endpoint requires create permission for the resource propertyrelay.

Request Body

Name	Description
input object
input.serviceIdentifier string	The service identifier for a service of the device. Can be seen as the interface name where services with the same identifier contain the same properties.
input.propertyIdentifier integer	The identifier of the property
input.deviceIdentifier string	The unique device identifier. Albeit being case insensitive, the upper case representation is used throughout the API. Pattern: ^(\S.)?(\\*|[a-zA-Z0-9=-]+)$
input.value	The value that triggers the change processor. The value is compared with type equality (===).
Alternative 1
Alternative 1string
Alternative 2boolean
Alternative 2number
output object
output.serviceIdentifier string	The service identifier for a service of the device. Can be seen as the interface name where services with the same identifier contain the same properties.
output.propertyIdentifier integer	The identifier of the property
output.deviceIdentifier string	The unique device identifier. Albeit being case insensitive, the upper case representation is used throughout the API. Pattern: ^(\S.)?(\\*|[a-zA-Z0-9=-]+)$
output.value	The value that the output will be set to once the input condition is matched.
Alternative 1
Alternative 1string
Alternative 2boolean
Alternative 2number
output.propertyType stringenum	The type of the property. Possible values: INT64, INT32, INT16, INT8, UINT64, UINT32, UINT16, UINT8, FLOAT, FLOAT64, DATETIME, STRING, BOOL, UUID, BIN, BIN_STREAM, STRING_STREAM

Response

Name	Description
propertyRelayIdentifier string	Identifier for the specific change process handler.

List Property Relay Settings

Returns all currently available property relay settings.

GET

/api/v1/propertyrelay

Access

This endpoint requires read permission for the resource propertyrelay.

Query Parameter

Name	Description
depth integeroptional	Due to the fact that some resources follow certain hierarchies, the depth query parameter can be used to include nested information in the response. This can be used to minimize roundtrips and is generally advised for.

Response

Name	Description

Delete Property Relay Settings

Deletes all currently available property relay settings.

DELETE

/api/v1/propertyrelay

Access

This endpoint requires delete permission for the resource propertyrelay.

Response

This endpoint simply returns Status 204 to indicate a successful operation and to save bandwidth.

Get Property Relay Setting

Returns a single property relay setting based on the uuid provided.

GET

/api/v1/propertyrelay/:propertyRelayIdentifier

Access

This endpoint requires read permission for the resource propertyrelay.

URL Parameter

Name	Description
propertyRelayIdentifier string	Identifier for the specific change process handler.

Response

Name	Description
input object
input.serviceIdentifier string	The service identifier for a service of the device. Can be seen as the interface name where services with the same identifier contain the same properties.
input.propertyIdentifier integer	The identifier of the property
input.deviceIdentifier string	The unique device identifier. Albeit being case insensitive, the upper case representation is used throughout the API. Pattern: ^(\S.)?(\\*|[a-zA-Z0-9=-]+)$
input.value	The value that triggers the change processor. The value is compared with type equality (===).
Alternative 1
Alternative 1string
Alternative 2boolean
Alternative 2number
output object
output.serviceIdentifier string	The service identifier for a service of the device. Can be seen as the interface name where services with the same identifier contain the same properties.
output.propertyIdentifier integer	The identifier of the property
output.deviceIdentifier string	The unique device identifier. Albeit being case insensitive, the upper case representation is used throughout the API. Pattern: ^(\S.)?(\\*|[a-zA-Z0-9=-]+)$
output.value	The value that the output will be set to once the input condition is matched.
Alternative 1
Alternative 1string
Alternative 2boolean
Alternative 2number
output.propertyType stringenum	The type of the property. Possible values: INT64, INT32, INT16, INT8, UINT64, UINT32, UINT16, UINT8, FLOAT, FLOAT64, DATETIME, STRING, BOOL, UUID, BIN, BIN_STREAM, STRING_STREAM

Update Property Relay Setting

Updates, based on the provided uuid, the property setting.

PATCH

/api/v1/propertyrelay/:propertyRelayIdentifier

Access

This endpoint requires update permission for the resource propertyrelay.

URL Parameter

Name	Description
propertyRelayIdentifier string	Identifier for the specific change process handler.

Request Body

Name	Description
input objectoptional
input.serviceIdentifier stringoptional	The service identifier for a service of the device. Can be seen as the interface name where services with the same identifier contain the same properties.
input.propertyIdentifier integeroptional	The identifier of the property
input.deviceIdentifier stringoptional	The unique device identifier. Albeit being case insensitive, the upper case representation is used throughout the API. Pattern: ^(\S.)?(\\*|[a-zA-Z0-9=-]+)$
input.value optional	The value that triggers the change processor. The value is compared with type equality (===).
Alternative 1
Alternative 1string
Alternative 2boolean
Alternative 2number
output objectoptional
output.serviceIdentifier stringoptional	The service identifier for a service of the device. Can be seen as the interface name where services with the same identifier contain the same properties.
output.propertyIdentifier integeroptional	The identifier of the property
output.deviceIdentifier stringoptional	The unique device identifier. Albeit being case insensitive, the upper case representation is used throughout the API. Pattern: ^(\S.)?(\\*|[a-zA-Z0-9=-]+)$
output.value optional	The value that the output will be set to once the input condition is matched.
Alternative 1
Alternative 1string
Alternative 2boolean
Alternative 2number
output.propertyType stringoptionalenum	The type of the property. Possible values: INT64, INT32, INT16, INT8, UINT64, UINT32, UINT16, UINT8, FLOAT, FLOAT64, DATETIME, STRING, BOOL, UUID, BIN, BIN_STREAM, STRING_STREAM

Response

This endpoint simply returns Status 204 to indicate a successful operation and to save bandwidth.

Delete Property Relay Setting

Delete the property relay setting based on the chosen uuid if present.

DELETE

/api/v1/propertyrelay/:propertyRelayIdentifier

Access

This endpoint requires delete permission for the resource propertyrelay.

URL Parameter

Name	Description
propertyRelayIdentifier string	Identifier for the specific change process handler.

Response

This endpoint simply returns Status 204 to indicate a successful operation and to save bandwidth.