Skip to main content
Version: Next

REC API Reference

RealEstateCore.Ontology.DTDLv2 (4.0.0.24)

Download OpenAPI specification:Download

Relynk only supports parts of the RealEstateCore (REC) specification, any endpoint prefixed with [Not Implemented Yet] is currently not supported. RealEstateCore is an ontology model and API specification for building and interfacing against Smart Buildings, whether on individual building or portfolio level. The REC ontology is released in DTDL (Digital Twin Definition Language) and SHACL (RDF Shapes Contraint language) formats; the REC API is expressed as an OpenAPI Specification (a.k.a. Swagger). We also provide a southbound edge API for bandwidth-constrained devices to communicate telemetry, alerts, commands, etc (see GitHub repository).

points

Get 'Point' entities.

query Parameters
page
integer <int32> >= 0
Default: 0

If the result set is large, pagination across the results can be employed; in that case, this parameter defines the page number (zero-indexed) that is requested by the client. The number of items included in each page is defined by the 'size' parameter. Default is 0, i.e., the first results page is returned.

size
integer <int32> [ 0 .. 100 ]
Default: 20

The number of items to display on a returned results page (see the page parameter).

object (SortingSchema)

The field and direction to sort results on.

object (StringFilter)

Filter value on relationship 'isPointOf'.

object (StringFilter)

Filter value on property 'aggregate'.

object (StringFilter)

Filter value on property 'customProperties'.

object (StringFilter)

Filter value on property 'customTags'.

object (StringFilter)

Filter value on property 'hasQuantity'.

object (StringFilter)

Filter value on property 'hasSubstance'.

object (StringFilter)

Filter value on property 'identifiers'.

object (StringFilter)

Filter value on property 'name'.

Responses

Response samples

Content type
application/ld+json
{
  • "@context": {},
  • "@type": "hydra:Collection",
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:member": [
    ]
}

[Not Implemented Yet] Create a new 'Point' object.

Request Body schema: application/ld+json

New 'Point' entity that is to be added.

@context
required
string
Default: "https://dev.realestatecore.io/contexts/Point.jsonld"
@id
string
@type
string
Default: "dtmi:org:brickschema:schema:Brick:Point;1"
Array of objects
aggregate
string
customProperties
string
customTags
string
hasQuantity
string
hasSubstance
string
identifiers
string
name
string

Responses

Request samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Point;1",
  • "isPointOf": [
    ],
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Point;1",
  • "isPointOf": [
    ],
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Get a specific 'Point' object.

path Parameters
id
required
string

Id of 'Point' to return.

Responses

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Point;1",
  • "isPointOf": [
    ],
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Update an existing 'Point' entity.

path Parameters
id
required
string

Id of 'Point' to update.

Request Body schema: application/ld+json

Updated data for 'Point' entity.

@context
required
string
Default: "https://dev.realestatecore.io/contexts/Point.jsonld"
@id
string
@type
string
Default: "dtmi:org:brickschema:schema:Brick:Point;1"
Array of objects
aggregate
string
customProperties
string
customTags
string
hasQuantity
string
hasSubstance
string
identifiers
string
name
string

Responses

Request samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Point;1",
  • "isPointOf": [
    ],
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Point;1",
  • "isPointOf": [
    ],
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Update a single property on a specific 'Point' object.

path Parameters
id
required
string

Id of 'Point' to update.

Request Body schema: application/ld+json

A single JSON key-value pair (plus @context), indicating the property to update and its new value. Note that the Swagger UI does not properly show the size constraint on this parameter; but the underlying OpenAPI Specification document does.

= 2 properties
@context
required
string
Default: "https://dev.realestatecore.io/contexts/Point.jsonld"
@id
string
@type
string
Default: "dtmi:org:brickschema:schema:Brick:Point;1"
Array of objects
aggregate
string
customProperties
string
customTags
string
hasQuantity
string
hasSubstance
string
identifiers
string
name
string

Responses

Request samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Point;1",
  • "isPointOf": [
    ],
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Point;1",
  • "isPointOf": [
    ],
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Delete a 'Point' object.

path Parameters
id
required
string

Id of 'Point' to delete.

Responses

alarms

[Not Implemented Yet] Get 'Alarm' entities.

query Parameters
page
integer <int32> >= 0
Default: 0

If the result set is large, pagination across the results can be employed; in that case, this parameter defines the page number (zero-indexed) that is requested by the client. The number of items included in each page is defined by the 'size' parameter. Default is 0, i.e., the first results page is returned.

size
integer <int32> [ 0 .. 100 ]
Default: 20

The number of items to display on a returned results page (see the page parameter).

object (SortingSchema)

The field and direction to sort results on.

object (StringFilter)

Filter value on relationship 'isPointOf'.

object (StringFilter)

Filter value on property 'aggregate'.

object (StringFilter)

Filter value on property 'customProperties'.

object (StringFilter)

Filter value on property 'customTags'.

object (StringFilter)

Filter value on property 'hasQuantity'.

object (StringFilter)

Filter value on property 'hasSubstance'.

object (StringFilter)

Filter value on property 'identifiers'.

object (StringFilter)

Filter value on property 'name'.

Responses

Response samples

Content type
application/ld+json
{
  • "@context": {},
  • "@type": "hydra:Collection",
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:member": [
    ]
}

[Not Implemented Yet] Create a new 'Alarm' object.

Request Body schema: application/ld+json

New 'Alarm' entity that is to be added.

@context
required
string
Default: "https://dev.realestatecore.io/contexts/Alarm.jsonld"
@id
string
@type
string
Default: "dtmi:org:brickschema:schema:Brick:Alarm;1"
Array of objects
object (ExceptionEvent)
aggregate
string
customProperties
string
customTags
string
hasQuantity
string
hasSubstance
string
identifiers
string
name
string

Responses

Request samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Alarm;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": {
    },
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Alarm;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": {
    },
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Get a specific 'Alarm' object.

path Parameters
id
required
string

Id of 'Alarm' to return.

Responses

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Alarm;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": {
    },
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Update an existing 'Alarm' entity.

path Parameters
id
required
string

Id of 'Alarm' to update.

Request Body schema: application/ld+json

Updated data for 'Alarm' entity.

@context
required
string
Default: "https://dev.realestatecore.io/contexts/Alarm.jsonld"
@id
string
@type
string
Default: "dtmi:org:brickschema:schema:Brick:Alarm;1"
Array of objects
object (ExceptionEvent)
aggregate
string
customProperties
string
customTags
string
hasQuantity
string
hasSubstance
string
identifiers
string
name
string

Responses

Request samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Alarm;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": {
    },
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Alarm;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": {
    },
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Update a single property on a specific 'Alarm' object.

path Parameters
id
required
string

Id of 'Alarm' to update.

Request Body schema: application/ld+json

A single JSON key-value pair (plus @context), indicating the property to update and its new value. Note that the Swagger UI does not properly show the size constraint on this parameter; but the underlying OpenAPI Specification document does.

= 2 properties
@context
required
string
Default: "https://dev.realestatecore.io/contexts/Alarm.jsonld"
@id
string
@type
string
Default: "dtmi:org:brickschema:schema:Brick:Alarm;1"
Array of objects
object (ExceptionEvent)
aggregate
string
customProperties
string
customTags
string
hasQuantity
string
hasSubstance
string
identifiers
string
name
string

Responses

Request samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Alarm;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": {
    },
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Alarm;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": {
    },
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Delete a 'Alarm' object.

path Parameters
id
required
string

Id of 'Alarm' to delete.

Responses

commands

Get 'Command' entities.

query Parameters
page
integer <int32> >= 0
Default: 0

If the result set is large, pagination across the results can be employed; in that case, this parameter defines the page number (zero-indexed) that is requested by the client. The number of items included in each page is defined by the 'size' parameter. Default is 0, i.e., the first results page is returned.

size
integer <int32> [ 0 .. 100 ]
Default: 20

The number of items to display on a returned results page (see the page parameter).

object (SortingSchema)

The field and direction to sort results on.

object (StringFilter)

Filter value on relationship 'isPointOf'.

object (StringFilter)

Filter value on property 'aggregate'.

object (StringFilter)

Filter value on property 'customProperties'.

object (StringFilter)

Filter value on property 'customTags'.

object (StringFilter)

Filter value on property 'hasQuantity'.

object (StringFilter)

Filter value on property 'hasSubstance'.

object (StringFilter)

Filter value on property 'identifiers'.

object (StringFilter)

Filter value on property 'name'.

Responses

Response samples

Content type
application/ld+json
{
  • "@context": {},
  • "@type": "hydra:Collection",
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:member": [
    ]
}

[Not Implemented Yet] Create a new 'Command' object.

Request Body schema: application/ld+json

New 'Command' entity that is to be added.

@context
required
string
Default: "https://dev.realestatecore.io/contexts/Command.jsonld"
@id
string
@type
string
Default: "dtmi:org:brickschema:schema:Brick:Command;1"
Array of objects
object (ActuationEvent)
aggregate
string
customProperties
string
customTags
string
hasQuantity
string
hasSubstance
string
identifiers
string
name
string

Responses

Request samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Command;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": {
    },
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Command;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": {
    },
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Get a specific 'Command' object.

path Parameters
id
required
string

Id of 'Command' to return.

Responses

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Command;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": {
    },
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Update an existing 'Command' entity.

path Parameters
id
required
string

Id of 'Command' to update.

Request Body schema: application/ld+json

Updated data for 'Command' entity.

@context
required
string
Default: "https://dev.realestatecore.io/contexts/Command.jsonld"
@id
string
@type
string
Default: "dtmi:org:brickschema:schema:Brick:Command;1"
Array of objects
object (ActuationEvent)
aggregate
string
customProperties
string
customTags
string
hasQuantity
string
hasSubstance
string
identifiers
string
name
string

Responses

Request samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Command;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": {
    },
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Command;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": {
    },
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Update a single property on a specific 'Command' object.

path Parameters
id
required
string

Id of 'Command' to update.

Request Body schema: application/ld+json

A single JSON key-value pair (plus @context), indicating the property to update and its new value. Note that the Swagger UI does not properly show the size constraint on this parameter; but the underlying OpenAPI Specification document does.

= 2 properties
@context
required
string
Default: "https://dev.realestatecore.io/contexts/Command.jsonld"
@id
string
@type
string
Default: "dtmi:org:brickschema:schema:Brick:Command;1"
Array of objects
object (ActuationEvent)
aggregate
string
customProperties
string
customTags
string
hasQuantity
string
hasSubstance
string
identifiers
string
name
string

Responses

Request samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Command;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": {
    },
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Command;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": {
    },
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Delete a 'Command' object.

path Parameters
id
required
string

Id of 'Command' to delete.

Responses

parameters

Get 'Parameter' entities.

query Parameters
page
integer <int32> >= 0
Default: 0

If the result set is large, pagination across the results can be employed; in that case, this parameter defines the page number (zero-indexed) that is requested by the client. The number of items included in each page is defined by the 'size' parameter. Default is 0, i.e., the first results page is returned.

size
integer <int32> [ 0 .. 100 ]
Default: 20

The number of items to display on a returned results page (see the page parameter).

object (SortingSchema)

The field and direction to sort results on.

object (StringFilter)

Filter value on relationship 'isPointOf'.

object (StringFilter)

Filter value on property 'lastKnownValue'.

object (StringFilter)

Filter value on property 'aggregate'.

object (StringFilter)

Filter value on property 'customProperties'.

object (StringFilter)

Filter value on property 'customTags'.

object (StringFilter)

Filter value on property 'hasQuantity'.

object (StringFilter)

Filter value on property 'hasSubstance'.

object (StringFilter)

Filter value on property 'identifiers'.

object (StringFilter)

Filter value on property 'name'.

Responses

Response samples

Content type
application/ld+json
{
  • "@context": {},
  • "@type": "hydra:Collection",
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:member": [
    ]
}

[Not Implemented Yet] Create a new 'Parameter' object.

Request Body schema: application/ld+json

New 'Parameter' entity that is to be added.

@context
required
string
Default: "https://dev.realestatecore.io/contexts/Parameter.jsonld"
@id
string
@type
string
Default: "dtmi:org:brickschema:schema:Brick:Parameter;1"
Array of objects
lastKnownValue
string
aggregate
string
customProperties
string
customTags
string
hasQuantity
string
hasSubstance
string
identifiers
string
name
string

Responses

Request samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Parameter;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": "string",
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Parameter;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": "string",
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Get a specific 'Parameter' object.

path Parameters
id
required
string

Id of 'Parameter' to return.

Responses

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Parameter;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": "string",
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Update an existing 'Parameter' entity.

path Parameters
id
required
string

Id of 'Parameter' to update.

Request Body schema: application/ld+json

Updated data for 'Parameter' entity.

@context
required
string
Default: "https://dev.realestatecore.io/contexts/Parameter.jsonld"
@id
string
@type
string
Default: "dtmi:org:brickschema:schema:Brick:Parameter;1"
Array of objects
lastKnownValue
string
aggregate
string
customProperties
string
customTags
string
hasQuantity
string
hasSubstance
string
identifiers
string
name
string

Responses

Request samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Parameter;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": "string",
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Parameter;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": "string",
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Update a single property on a specific 'Parameter' object.

path Parameters
id
required
string

Id of 'Parameter' to update.

Request Body schema: application/ld+json

A single JSON key-value pair (plus @context), indicating the property to update and its new value. Note that the Swagger UI does not properly show the size constraint on this parameter; but the underlying OpenAPI Specification document does.

= 2 properties
@context
required
string
Default: "https://dev.realestatecore.io/contexts/Parameter.jsonld"
@id
string
@type
string
Default: "dtmi:org:brickschema:schema:Brick:Parameter;1"
Array of objects
lastKnownValue
string
aggregate
string
customProperties
string
customTags
string
hasQuantity
string
hasSubstance
string
identifiers
string
name
string

Responses

Request samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Parameter;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": "string",
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Parameter;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": "string",
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Delete a 'Parameter' object.

path Parameters
id
required
string

Id of 'Parameter' to delete.

Responses

sensors

Get 'Sensor' entities.

query Parameters
page
integer <int32> >= 0
Default: 0

If the result set is large, pagination across the results can be employed; in that case, this parameter defines the page number (zero-indexed) that is requested by the client. The number of items included in each page is defined by the 'size' parameter. Default is 0, i.e., the first results page is returned.

size
integer <int32> [ 0 .. 100 ]
Default: 20

The number of items to display on a returned results page (see the page parameter).

object (SortingSchema)

The field and direction to sort results on.

object (StringFilter)

Filter value on relationship 'isPointOf'.

object (StringFilter)

Filter value on property 'aggregate'.

object (StringFilter)

Filter value on property 'customProperties'.

object (StringFilter)

Filter value on property 'customTags'.

object (StringFilter)

Filter value on property 'hasQuantity'.

object (StringFilter)

Filter value on property 'hasSubstance'.

object (StringFilter)

Filter value on property 'identifiers'.

object (StringFilter)

Filter value on property 'name'.

Responses

Response samples

Content type
application/ld+json
{
  • "@context": {},
  • "@type": "hydra:Collection",
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:member": [
    ]
}

[Not Implemented Yet] Create a new 'Sensor' object.

Request Body schema: application/ld+json

New 'Sensor' entity that is to be added.

@context
required
string
Default: "https://dev.realestatecore.io/contexts/Sensor.jsonld"
@id
string
@type
string
Default: "dtmi:org:brickschema:schema:Brick:Sensor;1"
Array of objects
aggregate
string
customProperties
string
customTags
string
hasQuantity
string
hasSubstance
string
identifiers
string
name
string

Responses

Request samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Sensor;1",
  • "isPointOf": [
    ],
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Sensor;1",
  • "isPointOf": [
    ],
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Get a specific 'Sensor' object.

path Parameters
id
required
string

Id of 'Sensor' to return.

Responses

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Sensor;1",
  • "isPointOf": [
    ],
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Update an existing 'Sensor' entity.

path Parameters
id
required
string

Id of 'Sensor' to update.

Request Body schema: application/ld+json

Updated data for 'Sensor' entity.

@context
required
string
Default: "https://dev.realestatecore.io/contexts/Sensor.jsonld"
@id
string
@type
string
Default: "dtmi:org:brickschema:schema:Brick:Sensor;1"
Array of objects
aggregate
string
customProperties
string
customTags
string
hasQuantity
string
hasSubstance
string
identifiers
string
name
string

Responses

Request samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Sensor;1",
  • "isPointOf": [
    ],
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Sensor;1",
  • "isPointOf": [
    ],
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Update a single property on a specific 'Sensor' object.

path Parameters
id
required
string

Id of 'Sensor' to update.

Request Body schema: application/ld+json

A single JSON key-value pair (plus @context), indicating the property to update and its new value. Note that the Swagger UI does not properly show the size constraint on this parameter; but the underlying OpenAPI Specification document does.

= 2 properties
@context
required
string
Default: "https://dev.realestatecore.io/contexts/Sensor.jsonld"
@id
string
@type
string
Default: "dtmi:org:brickschema:schema:Brick:Sensor;1"
Array of objects
aggregate
string
customProperties
string
customTags
string
hasQuantity
string
hasSubstance
string
identifiers
string
name
string

Responses

Request samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Sensor;1",
  • "isPointOf": [
    ],
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Sensor;1",
  • "isPointOf": [
    ],
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Delete a 'Sensor' object.

path Parameters
id
required
string

Id of 'Sensor' to delete.

Responses

setpoints

Get 'Setpoint' entities.

query Parameters
page
integer <int32> >= 0
Default: 0

If the result set is large, pagination across the results can be employed; in that case, this parameter defines the page number (zero-indexed) that is requested by the client. The number of items included in each page is defined by the 'size' parameter. Default is 0, i.e., the first results page is returned.

size
integer <int32> [ 0 .. 100 ]
Default: 20

The number of items to display on a returned results page (see the page parameter).

object (SortingSchema)

The field and direction to sort results on.

object (StringFilter)

Filter value on relationship 'isPointOf'.

object (StringFilter)

Filter value on property 'lastKnownValue'.

object (StringFilter)

Filter value on property 'aggregate'.

object (StringFilter)

Filter value on property 'customProperties'.

object (StringFilter)

Filter value on property 'customTags'.

object (StringFilter)

Filter value on property 'hasQuantity'.

object (StringFilter)

Filter value on property 'hasSubstance'.

object (StringFilter)

Filter value on property 'identifiers'.

object (StringFilter)

Filter value on property 'name'.

Responses

Response samples

Content type
application/ld+json
{
  • "@context": {},
  • "@type": "hydra:Collection",
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:member": [
    ]
}

[Not Implemented Yet] Create a new 'Setpoint' object.

Request Body schema: application/ld+json

New 'Setpoint' entity that is to be added.

@context
required
string
Default: "https://dev.realestatecore.io/contexts/Setpoint.jsonld"
@id
string
@type
string
Default: "dtmi:org:brickschema:schema:Brick:Setpoint;1"
Array of objects
lastKnownValue
string
aggregate
string
customProperties
string
customTags
string
hasQuantity
string
hasSubstance
string
identifiers
string
name
string

Responses

Request samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Setpoint;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": "string",
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Setpoint;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": "string",
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Get a specific 'Setpoint' object.

path Parameters
id
required
string

Id of 'Setpoint' to return.

Responses

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Setpoint;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": "string",
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Update an existing 'Setpoint' entity.

path Parameters
id
required
string

Id of 'Setpoint' to update.

Request Body schema: application/ld+json

Updated data for 'Setpoint' entity.

@context
required
string
Default: "https://dev.realestatecore.io/contexts/Setpoint.jsonld"
@id
string
@type
string
Default: "dtmi:org:brickschema:schema:Brick:Setpoint;1"
Array of objects
lastKnownValue
string
aggregate
string
customProperties
string
customTags
string
hasQuantity
string
hasSubstance
string
identifiers
string
name
string

Responses

Request samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Setpoint;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": "string",
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Setpoint;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": "string",
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Update a single property on a specific 'Setpoint' object.

path Parameters
id
required
string

Id of 'Setpoint' to update.

Request Body schema: application/ld+json

A single JSON key-value pair (plus @context), indicating the property to update and its new value. Note that the Swagger UI does not properly show the size constraint on this parameter; but the underlying OpenAPI Specification document does.

= 2 properties
@context
required
string
Default: "https://dev.realestatecore.io/contexts/Setpoint.jsonld"
@id
string
@type
string
Default: "dtmi:org:brickschema:schema:Brick:Setpoint;1"
Array of objects
lastKnownValue
string
aggregate
string
customProperties
string
customTags
string
hasQuantity
string
hasSubstance
string
identifiers
string
name
string

Responses

Request samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Setpoint;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": "string",
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Setpoint;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": "string",
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Delete a 'Setpoint' object.

path Parameters
id
required
string

Id of 'Setpoint' to delete.

Responses

statuspoints

Get 'Status' entities.

query Parameters
page
integer <int32> >= 0
Default: 0

If the result set is large, pagination across the results can be employed; in that case, this parameter defines the page number (zero-indexed) that is requested by the client. The number of items included in each page is defined by the 'size' parameter. Default is 0, i.e., the first results page is returned.

size
integer <int32> [ 0 .. 100 ]
Default: 20

The number of items to display on a returned results page (see the page parameter).

object (SortingSchema)

The field and direction to sort results on.

object (StringFilter)

Filter value on relationship 'isPointOf'.

object (StringFilter)

Filter value on property 'lastKnownValue'.

object (StringFilter)

Filter value on property 'aggregate'.

object (StringFilter)

Filter value on property 'customProperties'.

object (StringFilter)

Filter value on property 'customTags'.

object (StringFilter)

Filter value on property 'hasQuantity'.

object (StringFilter)

Filter value on property 'hasSubstance'.

object (StringFilter)

Filter value on property 'identifiers'.

object (StringFilter)

Filter value on property 'name'.

Responses

Response samples

Content type
application/ld+json
{
  • "@context": {},
  • "@type": "hydra:Collection",
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:member": [
    ]
}

[Not Implemented Yet] Create a new 'Status' object.

Request Body schema: application/ld+json

New 'Status' entity that is to be added.

@context
required
string
Default: "https://dev.realestatecore.io/contexts/Status.jsonld"
@id
string
@type
string
Default: "dtmi:org:brickschema:schema:Brick:Status;1"
Array of objects
lastKnownValue
string
aggregate
string
customProperties
string
customTags
string
hasQuantity
string
hasSubstance
string
identifiers
string
name
string

Responses

Request samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Status;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": "string",
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Status;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": "string",
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Get a specific 'Status' object.

path Parameters
id
required
string

Id of 'Status' to return.

Responses

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Status;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": "string",
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Update an existing 'Status' entity.

path Parameters
id
required
string

Id of 'Status' to update.

Request Body schema: application/ld+json

Updated data for 'Status' entity.

@context
required
string
Default: "https://dev.realestatecore.io/contexts/Status.jsonld"
@id
string
@type
string
Default: "dtmi:org:brickschema:schema:Brick:Status;1"
Array of objects
lastKnownValue
string
aggregate
string
customProperties
string
customTags
string
hasQuantity
string
hasSubstance
string
identifiers
string
name
string

Responses

Request samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Status;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": "string",
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Status;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": "string",
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Update a single property on a specific 'Status' object.

path Parameters
id
required
string

Id of 'Status' to update.

Request Body schema: application/ld+json

A single JSON key-value pair (plus @context), indicating the property to update and its new value. Note that the Swagger UI does not properly show the size constraint on this parameter; but the underlying OpenAPI Specification document does.

= 2 properties
@context
required
string
Default: "https://dev.realestatecore.io/contexts/Status.jsonld"
@id
string
@type
string
Default: "dtmi:org:brickschema:schema:Brick:Status;1"
Array of objects
lastKnownValue
string
aggregate
string
customProperties
string
customTags
string
hasQuantity
string
hasSubstance
string
identifiers
string
name
string

Responses

Request samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Status;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": "string",
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Status;1",
  • "isPointOf": [
    ],
  • "lastKnownValue": "string",
  • "aggregate": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "hasQuantity": "string",
  • "hasSubstance": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Delete a 'Status' object.

path Parameters
id
required
string

Id of 'Status' to delete.

Responses

agents

[Not Implemented Yet] Get 'Agent' entities.

query Parameters
page
integer <int32> >= 0
Default: 0

If the result set is large, pagination across the results can be employed; in that case, this parameter defines the page number (zero-indexed) that is requested by the client. The number of items included in each page is defined by the 'size' parameter. Default is 0, i.e., the first results page is returned.

size
integer <int32> [ 0 .. 100 ]
Default: 20

The number of items to display on a returned results page (see the page parameter).

object (SortingSchema)

The field and direction to sort results on.

object (StringFilter)

Filter value on relationship 'isMemberOf'.

object (StringFilter)

Filter value on relationship 'owns'.

object (StringFilter)

Filter value on relationship 'memberOf'.

object (StringFilter)

Filter value on property 'customProperties'.

object (StringFilter)

Filter value on property 'customTags'.

object (StringFilter)

Filter value on property 'identifiers'.

object (StringFilter)

Filter value on property 'name'.

Responses

Response samples

Content type
application/ld+json
{
  • "@context": {},
  • "@type": "hydra:Collection",
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:member": [
    ]
}

[Not Implemented Yet] Create a new 'Agent' object.

Request Body schema: application/ld+json

New 'Agent' entity that is to be added.

@context
required
string
Default: "https://dev.realestatecore.io/contexts/Agent.jsonld"
@id
string
@type
string
Default: "dtmi:org:w3id:rec:Agent;1"
Array of objects
Array of objects
Array of objects
customProperties
string
customTags
string
identifiers
string
name
string

Responses

Request samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Agent;1",
  • "isMemberOf": [
    ],
  • "owns": [
    ],
  • "memberOf": [
    ],
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Agent;1",
  • "isMemberOf": [
    ],
  • "owns": [
    ],
  • "memberOf": [
    ],
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Get a specific 'Agent' object.

path Parameters
id
required
string

Id of 'Agent' to return.

Responses

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Agent;1",
  • "isMemberOf": [
    ],
  • "owns": [
    ],
  • "memberOf": [
    ],
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Update an existing 'Agent' entity.

path Parameters
id
required
string

Id of 'Agent' to update.

Request Body schema: application/ld+json

Updated data for 'Agent' entity.

@context
required
string
Default: "https://dev.realestatecore.io/contexts/Agent.jsonld"
@id
string
@type
string
Default: "dtmi:org:w3id:rec:Agent;1"
Array of objects
Array of objects
Array of objects
customProperties
string
customTags
string
identifiers
string
name
string

Responses

Request samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Agent;1",
  • "isMemberOf": [
    ],
  • "owns": [
    ],
  • "memberOf": [
    ],
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Agent;1",
  • "isMemberOf": [
    ],
  • "owns": [
    ],
  • "memberOf": [
    ],
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Update a single property on a specific 'Agent' object.

path Parameters
id
required
string

Id of 'Agent' to update.

Request Body schema: application/ld+json

A single JSON key-value pair (plus @context), indicating the property to update and its new value. Note that the Swagger UI does not properly show the size constraint on this parameter; but the underlying OpenAPI Specification document does.

= 2 properties
@context
required
string
Default: "https://dev.realestatecore.io/contexts/Agent.jsonld"
@id
string
@type
string
Default: "dtmi:org:w3id:rec:Agent;1"
Array of objects
Array of objects
Array of objects
customProperties
string
customTags
string
identifiers
string
name
string

Responses

Request samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Agent;1",
  • "isMemberOf": [
    ],
  • "owns": [
    ],
  • "memberOf": [
    ],
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Agent;1",
  • "isMemberOf": [
    ],
  • "owns": [
    ],
  • "memberOf": [
    ],
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"
}

[Not Implemented Yet] Delete a 'Agent' object.

path Parameters
id
required
string

Id of 'Agent' to delete.

Responses

assets

Get 'Asset' entities.

query Parameters
page
integer <int32> >= 0
Default: 0

If the result set is large, pagination across the results can be employed; in that case, this parameter defines the page number (zero-indexed) that is requested by the client. The number of items included in each page is defined by the 'size' parameter. Default is 0, i.e., the first results page is returned.

size
integer <int32> [ 0 .. 100 ]
Default: 20

The number of items to display on a returned results page (see the page parameter).

object (SortingSchema)

The field and direction to sort results on.

object (StringFilter)

Filter value on relationship 'commissionedBy'.

object (StringFilter)

Filter value on relationship 'documentation'.

object (StringFilter)

Filter value on relationship 'geometry'.

object (StringFilter)

Filter value on relationship 'hasPart'.

object (StringFilter)

Filter value on relationship 'hasPoint'.

object (StringFilter)

Filter value on relationship 'installedBy'.

object (StringFilter)

Filter value on relationship 'isPartOf'.

object (StringFilter)

Filter value on relationship 'locatedIn'.

object (StringFilter)

Filter value on relationship 'manufacturedBy'.

object (StringFilter)

Filter value on relationship 'mountedOn'.

object (StringFilter)

Filter value on relationship 'servicedBy'.

object (StringFilter)

Filter value on property 'IPAddress'.

object (StringFilter)

Filter value on property 'MACAddress'.

object (StringFilter)

Filter value on property 'assetTag'.

object (StringFilter)

Filter value on property 'commissioningDate'.

object (StringFilter)

Filter value on property 'customProperties'.

object (StringFilter)

Filter value on property 'customTags'.

object (StringFilter)

Filter value on property 'identifiers'.

object (StringFilter)

Filter value on property 'initialCost'.

object (StringFilter)

Filter value on property 'installationDate'.

object (StringFilter)

Filter value on property 'maintenanceInterval'.

object (StringFilter)

Filter value on property 'modelNumber'.

object (StringFilter)

Filter value on property 'name'.

object (StringFilter)

Filter value on property 'serialNumber'.

object (StringFilter)

Filter value on property 'turnoverDate'.

object (StringFilter)

Filter value on property 'weight'.

Responses

Response samples

Content type
application/ld+json
{
  • "@context": {},
  • "@type": "hydra:Collection",
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:member": [
    ]
}

[Not Implemented Yet] Create a new 'Asset' object.

Request Body schema: application/ld+json

New 'Asset' entity that is to be added.

@context
required
string
Default: "https://dev.realestatecore.io/contexts/Asset.jsonld"
@id
string
@type
string
Default: "dtmi:org:w3id:rec:Asset;1"
Array of objects
Array of objects
object
Array of objects
Array of objects
Array of objects
Array of objects
Array of objects
Array of objects
object
Array of objects
IPAddress
string
MACAddress
string
assetTag
string
commissioningDate
string <date>
customProperties
string
customTags
string
identifiers
string
initialCost
string
installationDate
string <date>
maintenanceInterval
string
modelNumber
string
name
string
serialNumber
string
turnoverDate
string <date>
weight
string

Responses

Request samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Asset;1",
  • "commissionedBy": [
    ],
  • "documentation": [
    ],
  • "geometry": {
    },
  • "hasPart": [
    ],
  • "hasPoint": [
    ],
  • "installedBy": [
    ],
  • "isPartOf": [
    ],
  • "locatedIn": [
    ],
  • "manufacturedBy": [
    ],
  • "mountedOn": {
    },
  • "servicedBy": [
    ],
  • "IPAddress": "string",
  • "MACAddress": "string",
  • "assetTag": "string",
  • "commissioningDate": "2019-08-24",
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "initialCost": "string",
  • "installationDate": "2019-08-24",
  • "maintenanceInterval": "string",
  • "modelNumber": "string",
  • "name": "string",
  • "serialNumber": "string",
  • "turnoverDate": "2019-08-24",
  • "weight": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Asset;1",
  • "commissionedBy": [
    ],
  • "documentation": [
    ],
  • "geometry": {
    },
  • "hasPart": [
    ],
  • "hasPoint": [
    ],
  • "installedBy": [
    ],
  • "isPartOf": [
    ],
  • "locatedIn": [
    ],
  • "manufacturedBy": [
    ],
  • "mountedOn": {
    },
  • "servicedBy": [
    ],
  • "IPAddress": "string",
  • "MACAddress": "string",
  • "assetTag": "string",
  • "commissioningDate": "2019-08-24",
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "initialCost": "string",
  • "installationDate": "2019-08-24",
  • "maintenanceInterval": "string",
  • "modelNumber": "string",
  • "name": "string",
  • "serialNumber": "string",
  • "turnoverDate": "2019-08-24",
  • "weight": "string"
}

[Not Implemented Yet] Get a specific 'Asset' object.

path Parameters
id
required
string

Id of 'Asset' to return.

Responses

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Asset;1",
  • "commissionedBy": [
    ],
  • "documentation": [
    ],
  • "geometry": {
    },
  • "hasPart": [
    ],
  • "hasPoint": [
    ],
  • "installedBy": [
    ],
  • "isPartOf": [
    ],
  • "locatedIn": [
    ],
  • "manufacturedBy": [
    ],
  • "mountedOn": {
    },
  • "servicedBy": [
    ],
  • "IPAddress": "string",
  • "MACAddress": "string",
  • "assetTag": "string",
  • "commissioningDate": "2019-08-24",
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "initialCost": "string",
  • "installationDate": "2019-08-24",
  • "maintenanceInterval": "string",
  • "modelNumber": "string",
  • "name": "string",
  • "serialNumber": "string",
  • "turnoverDate": "2019-08-24",
  • "weight": "string"
}

[Not Implemented Yet] Update an existing 'Asset' entity.

path Parameters
id
required
string

Id of 'Asset' to update.

Request Body schema: application/ld+json

Updated data for 'Asset' entity.

@context
required
string
Default: "https://dev.realestatecore.io/contexts/Asset.jsonld"
@id
string
@type
string
Default: "dtmi:org:w3id:rec:Asset;1"
Array of objects
Array of objects
object
Array of objects
Array of objects
Array of objects
Array of objects
Array of objects
Array of objects
object
Array of objects
IPAddress
string
MACAddress
string
assetTag
string
commissioningDate
string <date>
customProperties
string
customTags
string
identifiers
string
initialCost
string
installationDate
string <date>
maintenanceInterval
string
modelNumber
string
name
string
serialNumber
string
turnoverDate
string <date>
weight
string

Responses

Request samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Asset;1",
  • "commissionedBy": [
    ],
  • "documentation": [
    ],
  • "geometry": {
    },
  • "hasPart": [
    ],
  • "hasPoint": [
    ],
  • "installedBy": [
    ],
  • "isPartOf": [
    ],
  • "locatedIn": [
    ],
  • "manufacturedBy": [
    ],
  • "mountedOn": {
    },
  • "servicedBy": [
    ],
  • "IPAddress": "string",
  • "MACAddress": "string",
  • "assetTag": "string",
  • "commissioningDate": "2019-08-24",
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "initialCost": "string",
  • "installationDate": "2019-08-24",
  • "maintenanceInterval": "string",
  • "modelNumber": "string",
  • "name": "string",
  • "serialNumber": "string",
  • "turnoverDate": "2019-08-24",
  • "weight": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Asset;1",
  • "commissionedBy": [
    ],
  • "documentation": [
    ],
  • "geometry": {
    },
  • "hasPart": [
    ],
  • "hasPoint": [
    ],
  • "installedBy": [
    ],
  • "isPartOf": [
    ],
  • "locatedIn": [
    ],
  • "manufacturedBy": [
    ],
  • "mountedOn": {
    },
  • "servicedBy": [