REC API Reference

• points
  • getGet 'Point' entities.
  • post[Not Implemented Yet] Create a new 'Point' object.
  • get[Not Implemented Yet] Get a specific 'Point' object.
  • put[Not Implemented Yet] Update an existing 'Point' entity.
  • patch[Not Implemented Yet] Update a single property on a specific 'Point' object.
  • del[Not Implemented Yet] Delete a 'Point' object.
• alarms
  • getGet 'Alarm' entities.
  • post[Not Implemented Yet] Create a new 'Alarm' object.
  • get[Not Implemented Yet] Get a specific 'Alarm' object.
  • put[Not Implemented Yet] Update an existing 'Alarm' entity.
  • patch[Not Implemented Yet] Update a single property on a specific 'Alarm' object.
  • del[Not Implemented Yet] Delete a 'Alarm' object.
• commands
  • getGet 'Command' entities.
  • post[Not Implemented Yet] Create a new 'Command' object.
  • get[Not Implemented Yet] Get a specific 'Command' object.
  • put[Not Implemented Yet] Update an existing 'Command' entity.
  • patch[Not Implemented Yet] Update a single property on a specific 'Command' object.
  • del[Not Implemented Yet] Delete a 'Command' object.
• parameters
  • getGet 'Parameter' entities.
  • post[Not Implemented Yet] Create a new 'Parameter' object.
  • get[Not Implemented Yet] Get a specific 'Parameter' object.
  • put[Not Implemented Yet] Update an existing 'Parameter' entity.
  • patch[Not Implemented Yet] Update a single property on a specific 'Parameter' object.
  • del[Not Implemented Yet] Delete a 'Parameter' object.
• sensors
  • getGet 'Sensor' entities.
  • post[Not Implemented Yet] Create a new 'Sensor' object.
  • get[Not Implemented Yet] Get a specific 'Sensor' object.
  • put[Not Implemented Yet] Update an existing 'Sensor' entity.
  • patch[Not Implemented Yet] Update a single property on a specific 'Sensor' object.
  • del[Not Implemented Yet] Delete a 'Sensor' object.
• setpoints
  • getGet 'Setpoint' entities.
  • post[Not Implemented Yet] Create a new 'Setpoint' object.
  • get[Not Implemented Yet] Get a specific 'Setpoint' object.
  • put[Not Implemented Yet] Update an existing 'Setpoint' entity.
  • patch[Not Implemented Yet] Update a single property on a specific 'Setpoint' object.
  • del[Not Implemented Yet] Delete a 'Setpoint' object.
• statuspoints
  • getGet 'Status' entities.
  • post[Not Implemented Yet] Create a new 'Status' object.
  • get[Not Implemented Yet] Get a specific 'Status' object.
  • put[Not Implemented Yet] Update an existing 'Status' entity.
  • patch[Not Implemented Yet] Update a single property on a specific 'Status' object.
  • del[Not Implemented Yet] Delete a 'Status' object.
• agents
  • get[Not Implemented Yet] Get 'Agent' entities.
  • post[Not Implemented Yet] Create a new 'Agent' object.
  • get[Not Implemented Yet] Get a specific 'Agent' object.
  • put[Not Implemented Yet] Update an existing 'Agent' entity.
  • patch[Not Implemented Yet] Update a single property on a specific 'Agent' object.
  • del[Not Implemented Yet] Delete a 'Agent' object.
• assets
  • getGet 'Asset' entities.
  • post[Not Implemented Yet] Create a new 'Asset' object.
  • get[Not Implemented Yet] Get a specific 'Asset' object.
  • put[Not Implemented Yet] Update an existing 'Asset' entity.
  • patch[Not Implemented Yet] Update a single property on a specific 'Asset' object.
  • del[Not Implemented Yet] Delete a 'Asset' object.
• buildings
  • get[Not Implemented Yet] Get 'Building' entities.
  • post[Not Implemented Yet] Create a new 'Building' object.
  • get[Not Implemented Yet] Get a specific 'Building' object.
  • put[Not Implemented Yet] Update an existing 'Building' entity.
  • patch[Not Implemented Yet] Update a single property on a specific 'Building' object.
  • del[Not Implemented Yet] Delete a 'Building' object.
• buildingelements
  • getGet 'Building element' entities.
  • post[Not Implemented Yet] Create a new 'Building element' object.
  • get[Not Implemented Yet] Get a specific 'Building element' object.
  • put[Not Implemented Yet] Update an existing 'Building element' entity.
  • patch[Not Implemented Yet] Update a single property on a specific 'Building element' object.
  • del[Not Implemented Yet] Delete a 'Building element' object.
• collections
  • get[Not Implemented Yet] Get 'Collection' entities.
  • post[Not Implemented Yet] Create a new 'Collection' object.
  • get[Not Implemented Yet] Get a specific 'Collection' object.
  • put[Not Implemented Yet] Update an existing 'Collection' entity.
  • patch[Not Implemented Yet] Update a single property on a specific 'Collection' object.
  • del[Not Implemented Yet] Delete a 'Collection' object.
• events
  • get[Not Implemented Yet] Get 'Event' entities.
  • post[Not Implemented Yet] Create a new 'Event' object.
  • get[Not Implemented Yet] Get a specific 'Event' object.
  • put[Not Implemented Yet] Update an existing 'Event' entity.
  • patch[Not Implemented Yet] Update a single property on a specific 'Event' object.
  • del[Not Implemented Yet] Delete a 'Event' object.
• observations
  • getGet 'Observation event' entities.
  • post[Not Implemented Yet] Create a new 'Observation event' object.
  • get[Not Implemented Yet] Get a specific 'Observation event' object.
  • put[Not Implemented Yet] Update an existing 'Observation event' entity.
  • patch[Not Implemented Yet] Update a single property on a specific 'Observation event' object.
  • del[Not Implemented Yet] Delete a 'Observation event' object.
• actuations
  • get[Not Implemented Yet] Get 'Actuation event' entities.
  • postCreate a new 'Actuation event' object.
  • get[Not Implemented Yet] Get a specific 'Actuation event' object.
  • put[Not Implemented Yet] Update an existing 'Actuation event' entity.
  • patch[Not Implemented Yet] Update a single property on a specific 'Actuation event' object.
  • del[Not Implemented Yet] Delete a 'Actuation event' object.
• exceptions
  • get[Not Implemented Yet] Get 'Exception event' entities.
  • post[Not Implemented Yet] Create a new 'Exception event' object.
  • get[Not Implemented Yet] Get a specific 'Exception event' object.
  • put[Not Implemented Yet] Update an existing 'Exception event' entity.
  • patch[Not Implemented Yet] Update a single property on a specific 'Exception event' object.
  • del[Not Implemented Yet] Delete a 'Exception event' object.
• information
  • get[Not Implemented Yet] Get 'Information' entities.
  • post[Not Implemented Yet] Create a new 'Information' object.
  • get[Not Implemented Yet] Get a specific 'Information' object.
  • put[Not Implemented Yet] Update an existing 'Information' entity.
  • patch[Not Implemented Yet] Update a single property on a specific 'Information' object.
  • del[Not Implemented Yet] Delete a 'Information' object.
• spaces
  • getGet 'Space' entities.
  • post[Not Implemented Yet] Create a new 'Space' object.
  • get[Not Implemented Yet] Get a specific 'Space' object.
  • put[Not Implemented Yet] Update an existing 'Space' entity.
  • patch[Not Implemented Yet] Update a single property on a specific 'Space' object.
  • del[Not Implemented Yet] Delete a 'Space' object.
• documents
  • get[Not Implemented Yet] Get 'Document' entities.
  • post[Not Implemented Yet] Create a new 'Document' object.
  • get[Not Implemented Yet] Get a specific 'Document' object.
  • put[Not Implemented Yet] Update an existing 'Document' entity.
  • patch[Not Implemented Yet] Update a single property on a specific 'Document' object.
  • del[Not Implemented Yet] Delete a 'Document' object.
• levels
  • get[Not Implemented Yet] Get 'Level' entities.
  • post[Not Implemented Yet] Create a new 'Level' object.
  • get[Not Implemented Yet] Get a specific 'Level' object.
  • put[Not Implemented Yet] Update an existing 'Level' entity.
  • patch[Not Implemented Yet] Update a single property on a specific 'Level' object.
  • del[Not Implemented Yet] Delete a 'Level' object.
• sites
  • get[Not Implemented Yet] Get 'Site' entities.
  • post[Not Implemented Yet] Create a new 'Site' object.
  • get[Not Implemented Yet] Get a specific 'Site' object.
  • put[Not Implemented Yet] Update an existing 'Site' entity.
  • patch[Not Implemented Yet] Update a single property on a specific 'Site' object.
  • del[Not Implemented Yet] Delete a 'Site' object.
• subbuildings
  • get[Not Implemented Yet] Get 'Sub-building' entities.
  • post[Not Implemented Yet] Create a new 'Sub-building' object.
  • get[Not Implemented Yet] Get a specific 'Sub-building' object.
  • put[Not Implemented Yet] Update an existing 'Sub-building' entity.
  • patch[Not Implemented Yet] Update a single property on a specific 'Sub-building' object.
  • del[Not Implemented Yet] Delete a 'Sub-building' object.
• rooms
  • get[Not Implemented Yet] Get 'Room' entities.
  • post[Not Implemented Yet] Create a new 'Room' object.
  • get[Not Implemented Yet] Get a specific 'Room' object.
  • put[Not Implemented Yet] Update an existing 'Room' entity.
  • patch[Not Implemented Yet] Update a single property on a specific 'Room' object.
  • del[Not Implemented Yet] Delete a 'Room' object.
• zones
  • get[Not Implemented Yet] Get 'Zone' entities.
  • post[Not Implemented Yet] Create a new 'Zone' object.
  • get[Not Implemented Yet] Get a specific 'Zone' object.
  • put[Not Implemented Yet] Update an existing 'Zone' entity.
  • patch[Not Implemented Yet] Update a single property on a specific 'Zone' object.
  • del[Not Implemented Yet] Delete a 'Zone' object.

API docs by Redocly

RealEstateCore.Ontology.DTDLv2 (4.0.0.24)

Download OpenAPI specification:Download

URL: https://github.com/RealEstateCore/rec License: BSD-3-Clause

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

https://api.relynk.io/rec/v4.0.0/points

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": {

  • "@base": "http://example.com",
  • "hydra": "http://www.w3.org/ns/hydra/core#"

  },
• "@type": "hydra:Collection",
• "hydra:totalItems": 0,
• "hydra:view": {

  • "@id": "http://example.com",
  • "@type": "hydra:PartialCollectionView",
  • "hydra:first": "string",
  • "hydra:previous": "string",
  • "hydra:next": "string",
  • "hydra:last": "string"

  },
• "hydra:member": [

  • {

    • "@context": "https://dev.realestatecore.io/contexts/Point.jsonld",
    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1",
    • "isPointOf": [

      • {

        • "@id": "string",
        • "@type": "string"

        }

      ],
    • "aggregate": "string",
    • "customProperties": "string",
    • "customTags": "string",
    • "hasQuantity": "string",
    • "hasSubstance": "string",
    • "identifiers": "string",
    • "name": "string"

    }

  ]

}

[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

https://api.relynk.io/rec/v4.0.0/points

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Point.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Point;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "aggregate": "string",
• "customProperties": "string",
• "customTags": "string",
• "hasQuantity": "string",
• "hasSubstance": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 201
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Point.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Point;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "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

https://api.relynk.io/rec/v4.0.0/points/{id}

Response samples

• 200

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Point.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Point;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "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

https://api.relynk.io/rec/v4.0.0/points/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Point.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Point;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "aggregate": "string",
• "customProperties": "string",
• "customTags": "string",
• "hasQuantity": "string",
• "hasSubstance": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Point.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Point;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "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 '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

https://api.relynk.io/rec/v4.0.0/points/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Point.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Point;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "aggregate": "string",
• "customProperties": "string",
• "customTags": "string",
• "hasQuantity": "string",
• "hasSubstance": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Point.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Point;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "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

https://api.relynk.io/rec/v4.0.0/points/{id}

alarms

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

https://api.relynk.io/rec/v4.0.0/alarms

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": {

  • "@base": "http://example.com",
  • "hydra": "http://www.w3.org/ns/hydra/core#"

  },
• "@type": "hydra:Collection",
• "hydra:totalItems": 0,
• "hydra:view": {

  • "@id": "http://example.com",
  • "@type": "hydra:PartialCollectionView",
  • "hydra:first": "string",
  • "hydra:previous": "string",
  • "hydra:next": "string",
  • "hydra:last": "string"

  },
• "hydra:member": [

  • {

    • "@context": "https://dev.realestatecore.io/contexts/Alarm.jsonld",
    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Alarm;1",
    • "isPointOf": [

      • {

        • "@id": "string",
        • "@type": "string"

        }

      ],
    • "lastKnownValue": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:ExceptionEvent;1",
      • "@context": "https://dev.realestatecore.io/contexts/ExceptionEvent.jsonld",
      • "sourcePoint": {

        • "@id": "string",
        • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

        },
      • "value": "string",
      • "customProperties": "string",
      • "customTags": "string",
      • "end": "2019-08-24T14:15:22Z",
      • "identifiers": "string",
      • "name": "string",
      • "start": "2019-08-24T14:15:22Z",
      • "timestamp": "2019-08-24T14:15:22Z"

      },
    • "aggregate": "string",
    • "customProperties": "string",
    • "customTags": "string",
    • "hasQuantity": "string",
    • "hasSubstance": "string",
    • "identifiers": "string",
    • "name": "string"

    }

  ]

}

[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

https://api.relynk.io/rec/v4.0.0/alarms

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Alarm.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Alarm;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "lastKnownValue": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ExceptionEvent;1",
  • "@context": "https://dev.realestatecore.io/contexts/ExceptionEvent.jsonld",
  • "sourcePoint": {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    },
  • "value": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "identifiers": "string",
  • "name": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "timestamp": "2019-08-24T14:15:22Z"

  },
• "aggregate": "string",
• "customProperties": "string",
• "customTags": "string",
• "hasQuantity": "string",
• "hasSubstance": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 201
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Alarm.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Alarm;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "lastKnownValue": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ExceptionEvent;1",
  • "@context": "https://dev.realestatecore.io/contexts/ExceptionEvent.jsonld",
  • "sourcePoint": {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    },
  • "value": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "identifiers": "string",
  • "name": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "timestamp": "2019-08-24T14:15:22Z"

  },
• "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

https://api.relynk.io/rec/v4.0.0/alarms/{id}

Response samples

• 200

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Alarm.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Alarm;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "lastKnownValue": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ExceptionEvent;1",
  • "@context": "https://dev.realestatecore.io/contexts/ExceptionEvent.jsonld",
  • "sourcePoint": {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    },
  • "value": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "identifiers": "string",
  • "name": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "timestamp": "2019-08-24T14:15:22Z"

  },
• "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

https://api.relynk.io/rec/v4.0.0/alarms/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Alarm.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Alarm;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "lastKnownValue": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ExceptionEvent;1",
  • "@context": "https://dev.realestatecore.io/contexts/ExceptionEvent.jsonld",
  • "sourcePoint": {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    },
  • "value": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "identifiers": "string",
  • "name": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "timestamp": "2019-08-24T14:15:22Z"

  },
• "aggregate": "string",
• "customProperties": "string",
• "customTags": "string",
• "hasQuantity": "string",
• "hasSubstance": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Alarm.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Alarm;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "lastKnownValue": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ExceptionEvent;1",
  • "@context": "https://dev.realestatecore.io/contexts/ExceptionEvent.jsonld",
  • "sourcePoint": {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    },
  • "value": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "identifiers": "string",
  • "name": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "timestamp": "2019-08-24T14:15:22Z"

  },
• "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

https://api.relynk.io/rec/v4.0.0/alarms/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Alarm.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Alarm;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "lastKnownValue": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ExceptionEvent;1",
  • "@context": "https://dev.realestatecore.io/contexts/ExceptionEvent.jsonld",
  • "sourcePoint": {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    },
  • "value": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "identifiers": "string",
  • "name": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "timestamp": "2019-08-24T14:15:22Z"

  },
• "aggregate": "string",
• "customProperties": "string",
• "customTags": "string",
• "hasQuantity": "string",
• "hasSubstance": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Alarm.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Alarm;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "lastKnownValue": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ExceptionEvent;1",
  • "@context": "https://dev.realestatecore.io/contexts/ExceptionEvent.jsonld",
  • "sourcePoint": {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    },
  • "value": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "identifiers": "string",
  • "name": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "timestamp": "2019-08-24T14:15:22Z"

  },
• "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

https://api.relynk.io/rec/v4.0.0/alarms/{id}

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

https://api.relynk.io/rec/v4.0.0/commands

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": {

  • "@base": "http://example.com",
  • "hydra": "http://www.w3.org/ns/hydra/core#"

  },
• "@type": "hydra:Collection",
• "hydra:totalItems": 0,
• "hydra:view": {

  • "@id": "http://example.com",
  • "@type": "hydra:PartialCollectionView",
  • "hydra:first": "string",
  • "hydra:previous": "string",
  • "hydra:next": "string",
  • "hydra:last": "string"

  },
• "hydra:member": [

  • {

    • "@context": "https://dev.realestatecore.io/contexts/Command.jsonld",
    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Command;1",
    • "isPointOf": [

      • {

        • "@id": "string",
        • "@type": "string"

        }

      ],
    • "lastKnownValue": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:ActuationEvent;1",
      • "@context": "https://dev.realestatecore.io/contexts/ActuationEvent.jsonld",
      • "targetPoint": [

        • {

          • "@id": "string",
          • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

          }

        ],
      • "value": "string",
      • "customProperties": "string",
      • "customTags": "string",
      • "end": "2019-08-24T14:15:22Z",
      • "identifiers": "string",
      • "name": "string",
      • "start": "2019-08-24T14:15:22Z",
      • "timestamp": "2019-08-24T14:15:22Z"

      },
    • "aggregate": "string",
    • "customProperties": "string",
    • "customTags": "string",
    • "hasQuantity": "string",
    • "hasSubstance": "string",
    • "identifiers": "string",
    • "name": "string"

    }

  ]

}

[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

https://api.relynk.io/rec/v4.0.0/commands

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Command.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Command;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "lastKnownValue": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ActuationEvent;1",
  • "@context": "https://dev.realestatecore.io/contexts/ActuationEvent.jsonld",
  • "targetPoint": [

    • {

      • "@id": "string",
      • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

      }

    ],
  • "value": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "identifiers": "string",
  • "name": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "timestamp": "2019-08-24T14:15:22Z"

  },
• "aggregate": "string",
• "customProperties": "string",
• "customTags": "string",
• "hasQuantity": "string",
• "hasSubstance": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 201
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Command.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Command;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "lastKnownValue": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ActuationEvent;1",
  • "@context": "https://dev.realestatecore.io/contexts/ActuationEvent.jsonld",
  • "targetPoint": [

    • {

      • "@id": "string",
      • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

      }

    ],
  • "value": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "identifiers": "string",
  • "name": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "timestamp": "2019-08-24T14:15:22Z"

  },
• "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

https://api.relynk.io/rec/v4.0.0/commands/{id}

Response samples

• 200

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Command.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Command;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "lastKnownValue": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ActuationEvent;1",
  • "@context": "https://dev.realestatecore.io/contexts/ActuationEvent.jsonld",
  • "targetPoint": [

    • {

      • "@id": "string",
      • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

      }

    ],
  • "value": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "identifiers": "string",
  • "name": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "timestamp": "2019-08-24T14:15:22Z"

  },
• "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

https://api.relynk.io/rec/v4.0.0/commands/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Command.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Command;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "lastKnownValue": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ActuationEvent;1",
  • "@context": "https://dev.realestatecore.io/contexts/ActuationEvent.jsonld",
  • "targetPoint": [

    • {

      • "@id": "string",
      • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

      }

    ],
  • "value": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "identifiers": "string",
  • "name": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "timestamp": "2019-08-24T14:15:22Z"

  },
• "aggregate": "string",
• "customProperties": "string",
• "customTags": "string",
• "hasQuantity": "string",
• "hasSubstance": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Command.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Command;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "lastKnownValue": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ActuationEvent;1",
  • "@context": "https://dev.realestatecore.io/contexts/ActuationEvent.jsonld",
  • "targetPoint": [

    • {

      • "@id": "string",
      • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

      }

    ],
  • "value": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "identifiers": "string",
  • "name": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "timestamp": "2019-08-24T14:15:22Z"

  },
• "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

https://api.relynk.io/rec/v4.0.0/commands/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Command.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Command;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "lastKnownValue": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ActuationEvent;1",
  • "@context": "https://dev.realestatecore.io/contexts/ActuationEvent.jsonld",
  • "targetPoint": [

    • {

      • "@id": "string",
      • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

      }

    ],
  • "value": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "identifiers": "string",
  • "name": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "timestamp": "2019-08-24T14:15:22Z"

  },
• "aggregate": "string",
• "customProperties": "string",
• "customTags": "string",
• "hasQuantity": "string",
• "hasSubstance": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Command.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Command;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "lastKnownValue": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ActuationEvent;1",
  • "@context": "https://dev.realestatecore.io/contexts/ActuationEvent.jsonld",
  • "targetPoint": [

    • {

      • "@id": "string",
      • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

      }

    ],
  • "value": "string",
  • "customProperties": "string",
  • "customTags": "string",
  • "end": "2019-08-24T14:15:22Z",
  • "identifiers": "string",
  • "name": "string",
  • "start": "2019-08-24T14:15:22Z",
  • "timestamp": "2019-08-24T14:15:22Z"

  },
• "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

https://api.relynk.io/rec/v4.0.0/commands/{id}

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

https://api.relynk.io/rec/v4.0.0/parameters

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": {

  • "@base": "http://example.com",
  • "hydra": "http://www.w3.org/ns/hydra/core#"

  },
• "@type": "hydra:Collection",
• "hydra:totalItems": 0,
• "hydra:view": {

  • "@id": "http://example.com",
  • "@type": "hydra:PartialCollectionView",
  • "hydra:first": "string",
  • "hydra:previous": "string",
  • "hydra:next": "string",
  • "hydra:last": "string"

  },
• "hydra:member": [

  • {

    • "@context": "https://dev.realestatecore.io/contexts/Parameter.jsonld",
    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Parameter;1",
    • "isPointOf": [

      • {

        • "@id": "string",
        • "@type": "string"

        }

      ],
    • "lastKnownValue": "string",
    • "aggregate": "string",
    • "customProperties": "string",
    • "customTags": "string",
    • "hasQuantity": "string",
    • "hasSubstance": "string",
    • "identifiers": "string",
    • "name": "string"

    }

  ]

}

[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

https://api.relynk.io/rec/v4.0.0/parameters

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Parameter.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Parameter;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "lastKnownValue": "string",
• "aggregate": "string",
• "customProperties": "string",
• "customTags": "string",
• "hasQuantity": "string",
• "hasSubstance": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 201
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Parameter.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Parameter;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "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

https://api.relynk.io/rec/v4.0.0/parameters/{id}

Response samples

• 200

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Parameter.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Parameter;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "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

https://api.relynk.io/rec/v4.0.0/parameters/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Parameter.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Parameter;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "lastKnownValue": "string",
• "aggregate": "string",
• "customProperties": "string",
• "customTags": "string",
• "hasQuantity": "string",
• "hasSubstance": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Parameter.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Parameter;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "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

https://api.relynk.io/rec/v4.0.0/parameters/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Parameter.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Parameter;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "lastKnownValue": "string",
• "aggregate": "string",
• "customProperties": "string",
• "customTags": "string",
• "hasQuantity": "string",
• "hasSubstance": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Parameter.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Parameter;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "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

https://api.relynk.io/rec/v4.0.0/parameters/{id}

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

https://api.relynk.io/rec/v4.0.0/sensors

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": {

  • "@base": "http://example.com",
  • "hydra": "http://www.w3.org/ns/hydra/core#"

  },
• "@type": "hydra:Collection",
• "hydra:totalItems": 0,
• "hydra:view": {

  • "@id": "http://example.com",
  • "@type": "hydra:PartialCollectionView",
  • "hydra:first": "string",
  • "hydra:previous": "string",
  • "hydra:next": "string",
  • "hydra:last": "string"

  },
• "hydra:member": [

  • {

    • "@context": "https://dev.realestatecore.io/contexts/Sensor.jsonld",
    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Sensor;1",
    • "isPointOf": [

      • {

        • "@id": "string",
        • "@type": "string"

        }

      ],
    • "aggregate": "string",
    • "customProperties": "string",
    • "customTags": "string",
    • "hasQuantity": "string",
    • "hasSubstance": "string",
    • "identifiers": "string",
    • "name": "string"

    }

  ]

}

[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

https://api.relynk.io/rec/v4.0.0/sensors

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Sensor.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Sensor;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "aggregate": "string",
• "customProperties": "string",
• "customTags": "string",
• "hasQuantity": "string",
• "hasSubstance": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 201
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Sensor.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Sensor;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "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

https://api.relynk.io/rec/v4.0.0/sensors/{id}

Response samples

• 200

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Sensor.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Sensor;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "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

https://api.relynk.io/rec/v4.0.0/sensors/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Sensor.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Sensor;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "aggregate": "string",
• "customProperties": "string",
• "customTags": "string",
• "hasQuantity": "string",
• "hasSubstance": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Sensor.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Sensor;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "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 '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

https://api.relynk.io/rec/v4.0.0/sensors/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Sensor.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Sensor;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "aggregate": "string",
• "customProperties": "string",
• "customTags": "string",
• "hasQuantity": "string",
• "hasSubstance": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Sensor.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Sensor;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "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

https://api.relynk.io/rec/v4.0.0/sensors/{id}

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

https://api.relynk.io/rec/v4.0.0/setpoints

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": {

  • "@base": "http://example.com",
  • "hydra": "http://www.w3.org/ns/hydra/core#"

  },
• "@type": "hydra:Collection",
• "hydra:totalItems": 0,
• "hydra:view": {

  • "@id": "http://example.com",
  • "@type": "hydra:PartialCollectionView",
  • "hydra:first": "string",
  • "hydra:previous": "string",
  • "hydra:next": "string",
  • "hydra:last": "string"

  },
• "hydra:member": [

  • {

    • "@context": "https://dev.realestatecore.io/contexts/Setpoint.jsonld",
    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Setpoint;1",
    • "isPointOf": [

      • {

        • "@id": "string",
        • "@type": "string"

        }

      ],
    • "lastKnownValue": "string",
    • "aggregate": "string",
    • "customProperties": "string",
    • "customTags": "string",
    • "hasQuantity": "string",
    • "hasSubstance": "string",
    • "identifiers": "string",
    • "name": "string"

    }

  ]

}

[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

https://api.relynk.io/rec/v4.0.0/setpoints

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Setpoint.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Setpoint;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "lastKnownValue": "string",
• "aggregate": "string",
• "customProperties": "string",
• "customTags": "string",
• "hasQuantity": "string",
• "hasSubstance": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 201
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Setpoint.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Setpoint;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "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

https://api.relynk.io/rec/v4.0.0/setpoints/{id}

Response samples

• 200

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Setpoint.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Setpoint;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "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

https://api.relynk.io/rec/v4.0.0/setpoints/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Setpoint.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Setpoint;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "lastKnownValue": "string",
• "aggregate": "string",
• "customProperties": "string",
• "customTags": "string",
• "hasQuantity": "string",
• "hasSubstance": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Setpoint.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Setpoint;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "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

https://api.relynk.io/rec/v4.0.0/setpoints/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Setpoint.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Setpoint;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "lastKnownValue": "string",
• "aggregate": "string",
• "customProperties": "string",
• "customTags": "string",
• "hasQuantity": "string",
• "hasSubstance": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Setpoint.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Setpoint;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "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

https://api.relynk.io/rec/v4.0.0/setpoints/{id}

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

https://api.relynk.io/rec/v4.0.0/statuspoints

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": {

  • "@base": "http://example.com",
  • "hydra": "http://www.w3.org/ns/hydra/core#"

  },
• "@type": "hydra:Collection",
• "hydra:totalItems": 0,
• "hydra:view": {

  • "@id": "http://example.com",
  • "@type": "hydra:PartialCollectionView",
  • "hydra:first": "string",
  • "hydra:previous": "string",
  • "hydra:next": "string",
  • "hydra:last": "string"

  },
• "hydra:member": [

  • {

    • "@context": "https://dev.realestatecore.io/contexts/Status.jsonld",
    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Status;1",
    • "isPointOf": [

      • {

        • "@id": "string",
        • "@type": "string"

        }

      ],
    • "lastKnownValue": "string",
    • "aggregate": "string",
    • "customProperties": "string",
    • "customTags": "string",
    • "hasQuantity": "string",
    • "hasSubstance": "string",
    • "identifiers": "string",
    • "name": "string"

    }

  ]

}

[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

https://api.relynk.io/rec/v4.0.0/statuspoints

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Status.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Status;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "lastKnownValue": "string",
• "aggregate": "string",
• "customProperties": "string",
• "customTags": "string",
• "hasQuantity": "string",
• "hasSubstance": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 201
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Status.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Status;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "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

https://api.relynk.io/rec/v4.0.0/statuspoints/{id}

Response samples

• 200

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Status.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Status;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "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

https://api.relynk.io/rec/v4.0.0/statuspoints/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Status.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Status;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "lastKnownValue": "string",
• "aggregate": "string",
• "customProperties": "string",
• "customTags": "string",
• "hasQuantity": "string",
• "hasSubstance": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Status.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Status;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "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

https://api.relynk.io/rec/v4.0.0/statuspoints/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Status.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Status;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "lastKnownValue": "string",
• "aggregate": "string",
• "customProperties": "string",
• "customTags": "string",
• "hasQuantity": "string",
• "hasSubstance": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Status.jsonld",
• "@id": "string",
• "@type": "dtmi:org:brickschema:schema:Brick:Status;1",
• "isPointOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "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

https://api.relynk.io/rec/v4.0.0/statuspoints/{id}

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

https://api.relynk.io/rec/v4.0.0/agents

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": {

  • "@base": "http://example.com",
  • "hydra": "http://www.w3.org/ns/hydra/core#"

  },
• "@type": "hydra:Collection",
• "hydra:totalItems": 0,
• "hydra:view": {

  • "@id": "http://example.com",
  • "@type": "hydra:PartialCollectionView",
  • "hydra:first": "string",
  • "hydra:previous": "string",
  • "hydra:next": "string",
  • "hydra:last": "string"

  },
• "hydra:member": [

  • {

    • "@context": "https://dev.realestatecore.io/contexts/Agent.jsonld",
    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1",
    • "isMemberOf": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Organization;1"

        }

      ],
    • "owns": [

      • {

        • "@id": "string",
        • "@type": "string"

        }

      ],
    • "memberOf": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Organization;1"

        }

      ],
    • "customProperties": "string",
    • "customTags": "string",
    • "identifiers": "string",
    • "name": "string"

    }

  ]

}

[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

https://api.relynk.io/rec/v4.0.0/agents

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Agent.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Agent;1",
• "isMemberOf": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Organization;1"

    }

  ],
• "owns": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "memberOf": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Organization;1"

    }

  ],
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 201
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Agent.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Agent;1",
• "isMemberOf": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Organization;1"

    }

  ],
• "owns": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "memberOf": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Organization;1"

    }

  ],
• "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

https://api.relynk.io/rec/v4.0.0/agents/{id}

Response samples

• 200

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Agent.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Agent;1",
• "isMemberOf": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Organization;1"

    }

  ],
• "owns": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "memberOf": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Organization;1"

    }

  ],
• "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

https://api.relynk.io/rec/v4.0.0/agents/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Agent.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Agent;1",
• "isMemberOf": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Organization;1"

    }

  ],
• "owns": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "memberOf": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Organization;1"

    }

  ],
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Agent.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Agent;1",
• "isMemberOf": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Organization;1"

    }

  ],
• "owns": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "memberOf": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Organization;1"

    }

  ],
• "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

https://api.relynk.io/rec/v4.0.0/agents/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Agent.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Agent;1",
• "isMemberOf": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Organization;1"

    }

  ],
• "owns": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "memberOf": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Organization;1"

    }

  ],
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Agent.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Agent;1",
• "isMemberOf": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Organization;1"

    }

  ],
• "owns": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "memberOf": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Organization;1"

    }

  ],
• "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

https://api.relynk.io/rec/v4.0.0/agents/{id}

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

https://api.relynk.io/rec/v4.0.0/assets

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": {

  • "@base": "http://example.com",
  • "hydra": "http://www.w3.org/ns/hydra/core#"

  },
• "@type": "hydra:Collection",
• "hydra:totalItems": 0,
• "hydra:view": {

  • "@id": "http://example.com",
  • "@type": "hydra:PartialCollectionView",
  • "hydra:first": "string",
  • "hydra:previous": "string",
  • "hydra:next": "string",
  • "hydra:last": "string"

  },
• "hydra:member": [

  • {

    • "@context": "https://dev.realestatecore.io/contexts/Asset.jsonld",
    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Asset;1",
    • "commissionedBy": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Agent;1"

        }

      ],
    • "documentation": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Document;1"

        }

      ],
    • "geometry": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:Geometry;1"

      },
    • "hasPart": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Asset;1"

        }

      ],
    • "hasPoint": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

        }

      ],
    • "installedBy": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Agent;1"

        }

      ],
    • "isPartOf": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Asset;1"

        }

      ],
    • "locatedIn": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Space;1"

        }

      ],
    • "manufacturedBy": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Agent;1"

        }

      ],
    • "mountedOn": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

      },
    • "servicedBy": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Agent;1"

        }

      ],
    • "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] 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

https://api.relynk.io/rec/v4.0.0/assets

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Asset.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Asset;1",
• "commissionedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Asset;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "installedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "isPartOf": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Asset;1"

    }

  ],
• "locatedIn": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "manufacturedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "mountedOn": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

  },
• "servicedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "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

• 201
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Asset.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Asset;1",
• "commissionedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Asset;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "installedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "isPartOf": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Asset;1"

    }

  ],
• "locatedIn": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "manufacturedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "mountedOn": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

  },
• "servicedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "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

https://api.relynk.io/rec/v4.0.0/assets/{id}

Response samples

• 200

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Asset.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Asset;1",
• "commissionedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Asset;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "installedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "isPartOf": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Asset;1"

    }

  ],
• "locatedIn": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "manufacturedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "mountedOn": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

  },
• "servicedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "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

https://api.relynk.io/rec/v4.0.0/assets/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Asset.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Asset;1",
• "commissionedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Asset;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "installedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "isPartOf": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Asset;1"

    }

  ],
• "locatedIn": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "manufacturedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "mountedOn": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

  },
• "servicedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "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

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Asset.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Asset;1",
• "commissionedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Asset;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "installedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "isPartOf": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Asset;1"

    }

  ],
• "locatedIn": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "manufacturedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "mountedOn": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

  },
• "servicedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "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 a single property on a specific 'Asset' object.

path Parameters

id required

string Id of 'Asset' 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/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

https://api.relynk.io/rec/v4.0.0/assets/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Asset.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Asset;1",
• "commissionedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Asset;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "installedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "isPartOf": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Asset;1"

    }

  ],
• "locatedIn": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "manufacturedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "mountedOn": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

  },
• "servicedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "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

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Asset.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Asset;1",
• "commissionedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Asset;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "installedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "isPartOf": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Asset;1"

    }

  ],
• "locatedIn": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "manufacturedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "mountedOn": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

  },
• "servicedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "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] Delete a 'Asset' object.

path Parameters

id required

string Id of 'Asset' to delete.

Responses

https://api.relynk.io/rec/v4.0.0/assets/{id}

buildings

[Not Implemented Yet] Get 'Building' 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 'address'.
	object (StringFilter) Filter value on relationship 'adjacentElement'.
	object (StringFilter) Filter value on relationship 'architectedBy'.
	object (StringFilter) Filter value on relationship 'constructedBy'.
	object (StringFilter) Filter value on relationship 'containsElement'.
	object (StringFilter) Filter value on relationship 'documentation'.
	object (StringFilter) Filter value on relationship 'hasPoint'.
	object (StringFilter) Filter value on relationship 'intersectingElement'.
	object (StringFilter) Filter value on relationship 'isFedBy'.
	object (StringFilter) Filter value on relationship 'operatedBy'.
	object (StringFilter) Filter value on relationship 'ownedBy'.
	object (StringFilter) Filter value on relationship 'geometry'.
	object (StringFilter) Filter value on relationship 'georeference'.
	object (StringFilter) Filter value on relationship 'hasPart'.
	object (StringFilter) Filter value on relationship 'isLocationOf'.
	object (StringFilter) Filter value on relationship 'isPartOf'.
	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

https://api.relynk.io/rec/v4.0.0/buildings

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": {

  • "@base": "http://example.com",
  • "hydra": "http://www.w3.org/ns/hydra/core#"

  },
• "@type": "hydra:Collection",
• "hydra:totalItems": 0,
• "hydra:view": {

  • "@id": "http://example.com",
  • "@type": "hydra:PartialCollectionView",
  • "hydra:first": "string",
  • "hydra:previous": "string",
  • "hydra:next": "string",
  • "hydra:last": "string"

  },
• "hydra:member": [

  • {

    • "@context": "https://dev.realestatecore.io/contexts/Building.jsonld",
    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Building;1",
    • "address": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

        }

      ],
    • "adjacentElement": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

        }

      ],
    • "architectedBy": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Agent;1"

        }

      ],
    • "constructedBy": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Agent;1"

        }

      ],
    • "containsElement": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

        }

      ],
    • "documentation": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Document;1"

        }

      ],
    • "hasPoint": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

        }

      ],
    • "intersectingElement": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

        }

      ],
    • "isFedBy": [

      • {

        • "@id": "string",
        • "@type": "string"

        }

      ],
    • "operatedBy": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Agent;1"

        }

      ],
    • "ownedBy": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Agent;1"

        }

      ],
    • "geometry": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:Geometry;1"

      },
    • "georeference": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:Georeference;1"

      },
    • "hasPart": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Space;1"

        }

      ],
    • "isLocationOf": [

      • {

        • "@id": "string",
        • "@type": "string"

        }

      ],
    • "isPartOf": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:Space;1"

      },
    • "area": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
      • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
      • "grossArea": 0.1,
      • "netArea": 0.1,
      • "rentableArea": 0.1,
      • "customProperties": "string",
      • "customTags": "string",
      • "identifiers": "string",
      • "name": "string"

      },
    • "capacity": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
      • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
      • "maxOccupancy": 0,
      • "seatingCapacity": 0,
      • "customProperties": "string",
      • "customTags": "string",
      • "identifiers": "string",
      • "name": "string"

      },
    • "customProperties": "string",
    • "customTags": "string",
    • "identifiers": "string",
    • "name": "string"

    }

  ]

}

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

Request Body schema: application/ld+json

New 'Building' entity that is to be added.

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

Responses

https://api.relynk.io/rec/v4.0.0/buildings

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Building.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Building;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 201
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Building.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Building;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Building' to return.

Responses

https://api.relynk.io/rec/v4.0.0/buildings/{id}

Response samples

• 200

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Building.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Building;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Building' to update.

Request Body schema: application/ld+json

Updated data for 'Building' entity.

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

Responses

https://api.relynk.io/rec/v4.0.0/buildings/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Building.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Building;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Building.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Building;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Building' 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/Building.jsonld"
@id	string
@type	string Default: "dtmi:org:w3id:rec:Building;1"
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	object
	object
	Array of objects
	Array of objects
	object
	object (ArchitectureArea)
	object (ArchitectureCapacity)
customProperties	string
customTags	string
identifiers	string
name	string

Responses

https://api.relynk.io/rec/v4.0.0/buildings/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Building.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Building;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Building.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Building;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Building' to delete.

Responses

https://api.relynk.io/rec/v4.0.0/buildings/{id}

buildingelements

Get 'Building element' 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 'documentation'.
	object (StringFilter) Filter value on relationship 'hasPart'.
	object (StringFilter) Filter value on relationship 'isPartOf'.
	object (StringFilter) Filter value on relationship 'locatedIn'.
	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

https://api.relynk.io/rec/v4.0.0/buildingelements

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": {

  • "@base": "http://example.com",
  • "hydra": "http://www.w3.org/ns/hydra/core#"

  },
• "@type": "hydra:Collection",
• "hydra:totalItems": 0,
• "hydra:view": {

  • "@id": "http://example.com",
  • "@type": "hydra:PartialCollectionView",
  • "hydra:first": "string",
  • "hydra:previous": "string",
  • "hydra:next": "string",
  • "hydra:last": "string"

  },
• "hydra:member": [

  • {

    • "@context": "https://dev.realestatecore.io/contexts/BuildingElement.jsonld",
    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1",
    • "documentation": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Document;1"

        }

      ],
    • "hasPart": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

        }

      ],
    • "isPartOf": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

      },
    • "locatedIn": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:Architecture;1"

      },
    • "customProperties": "string",
    • "customTags": "string",
    • "identifiers": "string",
    • "name": "string"

    }

  ]

}

[Not Implemented Yet] Create a new 'Building element' object.

Request Body schema: application/ld+json

New 'Building element' entity that is to be added.

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

Responses

https://api.relynk.io/rec/v4.0.0/buildingelements

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/BuildingElement.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:BuildingElement;1",
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

  },
• "locatedIn": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Architecture;1"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 201
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/BuildingElement.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:BuildingElement;1",
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

  },
• "locatedIn": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Architecture;1"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

[Not Implemented Yet] Get a specific 'Building element' object.

path Parameters

id required

string Id of 'Building element' to return.

Responses

https://api.relynk.io/rec/v4.0.0/buildingelements/{id}

Response samples

• 200

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/BuildingElement.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:BuildingElement;1",
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

  },
• "locatedIn": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Architecture;1"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

[Not Implemented Yet] Update an existing 'Building element' entity.

path Parameters

id required

string Id of 'Building element' to update.

Request Body schema: application/ld+json

Updated data for 'Building element' entity.

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

Responses

https://api.relynk.io/rec/v4.0.0/buildingelements/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/BuildingElement.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:BuildingElement;1",
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

  },
• "locatedIn": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Architecture;1"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/BuildingElement.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:BuildingElement;1",
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

  },
• "locatedIn": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Architecture;1"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Building element' 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/BuildingElement.jsonld"
@id	string
@type	string Default: "dtmi:org:w3id:rec:BuildingElement;1"
	Array of objects
	Array of objects
	object
	object
customProperties	string
customTags	string
identifiers	string
name	string

Responses

https://api.relynk.io/rec/v4.0.0/buildingelements/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/BuildingElement.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:BuildingElement;1",
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

  },
• "locatedIn": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Architecture;1"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/BuildingElement.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:BuildingElement;1",
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

  },
• "locatedIn": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Architecture;1"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

[Not Implemented Yet] Delete a 'Building element' object.

path Parameters

id required

string Id of 'Building element' to delete.

Responses

https://api.relynk.io/rec/v4.0.0/buildingelements/{id}

collections

[Not Implemented Yet] Get 'Collection' 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 'documentation'.
	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

https://api.relynk.io/rec/v4.0.0/collections

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": {

  • "@base": "http://example.com",
  • "hydra": "http://www.w3.org/ns/hydra/core#"

  },
• "@type": "hydra:Collection",
• "hydra:totalItems": 0,
• "hydra:view": {

  • "@id": "http://example.com",
  • "@type": "hydra:PartialCollectionView",
  • "hydra:first": "string",
  • "hydra:previous": "string",
  • "hydra:next": "string",
  • "hydra:last": "string"

  },
• "hydra:member": [

  • {

    • "@context": "https://dev.realestatecore.io/contexts/Collection.jsonld",
    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Collection;1",
    • "documentation": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Document;1"

        }

      ],
    • "customProperties": "string",
    • "customTags": "string",
    • "identifiers": "string",
    • "name": "string"

    }

  ]

}

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

Request Body schema: application/ld+json

New 'Collection' entity that is to be added.

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

Responses

https://api.relynk.io/rec/v4.0.0/collections

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Collection.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Collection;1",
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 201
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Collection.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Collection;1",
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Collection' to return.

Responses

https://api.relynk.io/rec/v4.0.0/collections/{id}

Response samples

• 200

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Collection.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Collection;1",
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Collection' to update.

Request Body schema: application/ld+json

Updated data for 'Collection' entity.

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

Responses

https://api.relynk.io/rec/v4.0.0/collections/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Collection.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Collection;1",
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Collection.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Collection;1",
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Collection' 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/Collection.jsonld"
@id	string
@type	string Default: "dtmi:org:w3id:rec:Collection;1"
	Array of objects
customProperties	string
customTags	string
identifiers	string
name	string

Responses

https://api.relynk.io/rec/v4.0.0/collections/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Collection.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Collection;1",
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Collection.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Collection;1",
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Collection' to delete.

Responses

https://api.relynk.io/rec/v4.0.0/collections/{id}

events

[Not Implemented Yet] Get 'Event' 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 property 'customProperties'.
	object (StringFilter) Filter value on property 'customTags'.
	object (DateTimeFilter) Filter value on property 'end'.
	object (StringFilter) Filter value on property 'identifiers'.
	object (StringFilter) Filter value on property 'name'.
	object (DateTimeFilter) Filter value on property 'start'.
	object (DateTimeFilter) Filter value on property 'timestamp'.

Responses

https://api.relynk.io/rec/v4.0.0/events

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": {

  • "@base": "http://example.com",
  • "hydra": "http://www.w3.org/ns/hydra/core#"

  },
• "@type": "hydra:Collection",
• "hydra:totalItems": 0,
• "hydra:view": {

  • "@id": "http://example.com",
  • "@type": "hydra:PartialCollectionView",
  • "hydra:first": "string",
  • "hydra:previous": "string",
  • "hydra:next": "string",
  • "hydra:last": "string"

  },
• "hydra:member": [

  • {

    • "@context": "https://dev.realestatecore.io/contexts/Event.jsonld",
    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Event;1",
    • "customProperties": "string",
    • "customTags": "string",
    • "end": "2019-08-24T14:15:22Z",
    • "identifiers": "string",
    • "name": "string",
    • "start": "2019-08-24T14:15:22Z",
    • "timestamp": "2019-08-24T14:15:22Z"

    }

  ]

}

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

Request Body schema: application/ld+json

New 'Event' entity that is to be added.

@context required	string Default: "https://dev.realestatecore.io/contexts/Event.jsonld"
@id	string
@type	string Default: "dtmi:org:w3id:rec:Event;1"
customProperties	string
customTags	string
end	string <date-time>
identifiers	string
name	string
start	string <date-time>
timestamp	string <date-time>

Responses

https://api.relynk.io/rec/v4.0.0/events

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Event.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Event;1",
• "customProperties": "string",
• "customTags": "string",
• "end": "2019-08-24T14:15:22Z",
• "identifiers": "string",
• "name": "string",
• "start": "2019-08-24T14:15:22Z",
• "timestamp": "2019-08-24T14:15:22Z"

}

Response samples

• 201
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Event.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Event;1",
• "customProperties": "string",
• "customTags": "string",
• "end": "2019-08-24T14:15:22Z",
• "identifiers": "string",
• "name": "string",
• "start": "2019-08-24T14:15:22Z",
• "timestamp": "2019-08-24T14:15:22Z"

}

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

path Parameters

id required

string Id of 'Event' to return.

Responses

https://api.relynk.io/rec/v4.0.0/events/{id}

Response samples

• 200

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Event.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Event;1",
• "customProperties": "string",
• "customTags": "string",
• "end": "2019-08-24T14:15:22Z",
• "identifiers": "string",
• "name": "string",
• "start": "2019-08-24T14:15:22Z",
• "timestamp": "2019-08-24T14:15:22Z"

}

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

path Parameters

id required

string Id of 'Event' to update.

Request Body schema: application/ld+json

Updated data for 'Event' entity.

@context required	string Default: "https://dev.realestatecore.io/contexts/Event.jsonld"
@id	string
@type	string Default: "dtmi:org:w3id:rec:Event;1"
customProperties	string
customTags	string
end	string <date-time>
identifiers	string
name	string
start	string <date-time>
timestamp	string <date-time>

Responses

https://api.relynk.io/rec/v4.0.0/events/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Event.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Event;1",
• "customProperties": "string",
• "customTags": "string",
• "end": "2019-08-24T14:15:22Z",
• "identifiers": "string",
• "name": "string",
• "start": "2019-08-24T14:15:22Z",
• "timestamp": "2019-08-24T14:15:22Z"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Event.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Event;1",
• "customProperties": "string",
• "customTags": "string",
• "end": "2019-08-24T14:15:22Z",
• "identifiers": "string",
• "name": "string",
• "start": "2019-08-24T14:15:22Z",
• "timestamp": "2019-08-24T14:15:22Z"

}

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

path Parameters

id required

string Id of 'Event' 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/Event.jsonld"
@id	string
@type	string Default: "dtmi:org:w3id:rec:Event;1"
customProperties	string
customTags	string
end	string <date-time>
identifiers	string
name	string
start	string <date-time>
timestamp	string <date-time>

Responses

https://api.relynk.io/rec/v4.0.0/events/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Event.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Event;1",
• "customProperties": "string",
• "customTags": "string",
• "end": "2019-08-24T14:15:22Z",
• "identifiers": "string",
• "name": "string",
• "start": "2019-08-24T14:15:22Z",
• "timestamp": "2019-08-24T14:15:22Z"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Event.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Event;1",
• "customProperties": "string",
• "customTags": "string",
• "end": "2019-08-24T14:15:22Z",
• "identifiers": "string",
• "name": "string",
• "start": "2019-08-24T14:15:22Z",
• "timestamp": "2019-08-24T14:15:22Z"

}

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

path Parameters

id required

string Id of 'Event' to delete.

Responses

https://api.relynk.io/rec/v4.0.0/events/{id}

observations

Get 'Observation event' 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 'sourcePoint'.
	object (StringFilter) Filter value on property 'customProperties'.
	object (StringFilter) Filter value on property 'customTags'.
	object (DateTimeFilter) Filter value on property 'end'.
	object (StringFilter) Filter value on property 'identifiers'.
	object (StringFilter) Filter value on property 'name'.
	object (DateTimeFilter) Filter value on property 'start'.
	object (DateTimeFilter) Filter value on property 'timestamp'.

Responses

https://api.relynk.io/rec/v4.0.0/observations

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": {

  • "@base": "http://example.com",
  • "hydra": "http://www.w3.org/ns/hydra/core#"

  },
• "@type": "hydra:Collection",
• "hydra:totalItems": 0,
• "hydra:view": {

  • "@id": "http://example.com",
  • "@type": "hydra:PartialCollectionView",
  • "hydra:first": "string",
  • "hydra:previous": "string",
  • "hydra:next": "string",
  • "hydra:last": "string"

  },
• "hydra:member": [

  • {

    • "@context": "https://dev.realestatecore.io/contexts/ObservationEvent.jsonld",
    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:ObservationEvent;1",
    • "sourcePoint": {

      • "@id": "string",
      • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

      },
    • "customProperties": "string",
    • "value": null,
    • "customTags": "string",
    • "end": "2019-08-24T14:15:22Z",
    • "identifiers": "string",
    • "name": "string",
    • "start": "2019-08-24T14:15:22Z",
    • "timestamp": "2019-08-24T14:15:22Z"

    }

  ]

}

[Not Implemented Yet] Create a new 'Observation event' object.

Request Body schema: application/ld+json

New 'Observation event' entity that is to be added.

@context required	string Default: "https://dev.realestatecore.io/contexts/ObservationEvent.jsonld"
@id	string
@type	string Default: "dtmi:org:w3id:rec:ObservationEvent;1"
	object
customProperties	string
value	float
customTags	string
end	string <date-time>
identifiers	string
name	string
start	string <date-time>
timestamp	string <date-time>

Responses

https://api.relynk.io/rec/v4.0.0/observations

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/ObservationEvent.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:ObservationEvent;1",
• "sourcePoint": {

  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

  },
• "customProperties": "string",
• "value": null,
• "customTags": "string",
• "end": "2019-08-24T14:15:22Z",
• "identifiers": "string",
• "name": "string",
• "start": "2019-08-24T14:15:22Z",
• "timestamp": "2019-08-24T14:15:22Z"

}

Response samples

• 201
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/ObservationEvent.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:ObservationEvent;1",
• "sourcePoint": {

  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

  },
• "customProperties": "string",
• "value": null,
• "customTags": "string",
• "end": "2019-08-24T14:15:22Z",
• "identifiers": "string",
• "name": "string",
• "start": "2019-08-24T14:15:22Z",
• "timestamp": "2019-08-24T14:15:22Z"

}

[Not Implemented Yet] Get a specific 'Observation event' object.

path Parameters

id required

string Id of 'Observation event' to return.

Responses

https://api.relynk.io/rec/v4.0.0/observations/{id}

Response samples

• 200

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/ObservationEvent.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:ObservationEvent;1",
• "sourcePoint": {

  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

  },
• "customProperties": "string",
• "value": null,
• "customTags": "string",
• "end": "2019-08-24T14:15:22Z",
• "identifiers": "string",
• "name": "string",
• "start": "2019-08-24T14:15:22Z",
• "timestamp": "2019-08-24T14:15:22Z"

}

[Not Implemented Yet] Update an existing 'Observation event' entity.

path Parameters

id required

string Id of 'Observation event' to update.

Request Body schema: application/ld+json

Updated data for 'Observation event' entity.

@context required	string Default: "https://dev.realestatecore.io/contexts/ObservationEvent.jsonld"
@id	string
@type	string Default: "dtmi:org:w3id:rec:ObservationEvent;1"
	object
customProperties	string
value	float
customTags	string
end	string <date-time>
identifiers	string
name	string
start	string <date-time>
timestamp	string <date-time>

Responses

https://api.relynk.io/rec/v4.0.0/observations/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/ObservationEvent.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:ObservationEvent;1",
• "sourcePoint": {

  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

  },
• "customProperties": "string",
• "value": null,
• "customTags": "string",
• "end": "2019-08-24T14:15:22Z",
• "identifiers": "string",
• "name": "string",
• "start": "2019-08-24T14:15:22Z",
• "timestamp": "2019-08-24T14:15:22Z"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/ObservationEvent.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:ObservationEvent;1",
• "sourcePoint": {

  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

  },
• "customProperties": "string",
• "value": null,
• "customTags": "string",
• "end": "2019-08-24T14:15:22Z",
• "identifiers": "string",
• "name": "string",
• "start": "2019-08-24T14:15:22Z",
• "timestamp": "2019-08-24T14:15:22Z"

}

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

path Parameters

id required

string Id of 'Observation event' 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/ObservationEvent.jsonld"
@id	string
@type	string Default: "dtmi:org:w3id:rec:ObservationEvent;1"
	object
customProperties	string
value	float
customTags	string
end	string <date-time>
identifiers	string
name	string
start	string <date-time>
timestamp	string <date-time>

Responses

https://api.relynk.io/rec/v4.0.0/observations/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/ObservationEvent.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:ObservationEvent;1",
• "sourcePoint": {

  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

  },
• "customProperties": "string",
• "value": null,
• "customTags": "string",
• "end": "2019-08-24T14:15:22Z",
• "identifiers": "string",
• "name": "string",
• "start": "2019-08-24T14:15:22Z",
• "timestamp": "2019-08-24T14:15:22Z"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/ObservationEvent.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:ObservationEvent;1",
• "sourcePoint": {

  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

  },
• "customProperties": "string",
• "value": null,
• "customTags": "string",
• "end": "2019-08-24T14:15:22Z",
• "identifiers": "string",
• "name": "string",
• "start": "2019-08-24T14:15:22Z",
• "timestamp": "2019-08-24T14:15:22Z"

}

[Not Implemented Yet] Delete a 'Observation event' object.

path Parameters

id required

string Id of 'Observation event' to delete.

Responses

https://api.relynk.io/rec/v4.0.0/observations/{id}

actuations

[Not Implemented Yet] Get 'Actuation event' 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 'targetPoint'.
	object (StringFilter) Filter value on property 'value'.
	object (StringFilter) Filter value on property 'customProperties'.
	object (StringFilter) Filter value on property 'customTags'.
	object (DateTimeFilter) Filter value on property 'end'.
	object (StringFilter) Filter value on property 'identifiers'.
	object (StringFilter) Filter value on property 'name'.
	object (DateTimeFilter) Filter value on property 'start'.
	object (DateTimeFilter) Filter value on property 'timestamp'.

Responses

https://api.relynk.io/rec/v4.0.0/actuations

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": {

  • "@base": "http://example.com",
  • "hydra": "http://www.w3.org/ns/hydra/core#"

  },
• "@type": "hydra:Collection",
• "hydra:totalItems": 0,
• "hydra:view": {

  • "@id": "http://example.com",
  • "@type": "hydra:PartialCollectionView",
  • "hydra:first": "string",
  • "hydra:previous": "string",
  • "hydra:next": "string",
  • "hydra:last": "string"

  },
• "hydra:member": [

  • {

    • "@context": "https://dev.realestatecore.io/contexts/ActuationEvent.jsonld",
    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:ActuationEvent;1",
    • "targetPoint": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

        }

      ],
    • "value": "string",
    • "customProperties": "string",
    • "customTags": "string",
    • "end": "2019-08-24T14:15:22Z",
    • "identifiers": "string",
    • "name": "string",
    • "start": "2019-08-24T14:15:22Z",
    • "timestamp": "2019-08-24T14:15:22Z"

    }

  ]

}

Create a new 'Actuation event' object.

Request Body schema: application/ld+json

New 'Actuation event' entity that is to be added.

One of

@context required	string Default: "https://dev.realestatecore.io/contexts/ActuationEvent.jsonld"
@id	string
@type	string Default: "dtmi:org:w3id:rec:ActuationEvent;1"
	Array of objects
value	string
customProperties	string
customTags	string
end	string <date-time>
identifiers	string
name	string
start	string <date-time>
timestamp	string <date-time>

Responses

https://api.relynk.io/rec/v4.0.0/actuations

Request samples

• Payload

Content type

application/ld+json

[ ]

Response samples

• 201
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/ActuationEvent.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:ActuationEvent;1",
• "targetPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "value": "string",
• "customProperties": "string",
• "customTags": "string",
• "end": "2019-08-24T14:15:22Z",
• "identifiers": "string",
• "name": "string",
• "start": "2019-08-24T14:15:22Z",
• "timestamp": "2019-08-24T14:15:22Z"

}

[Not Implemented Yet] Get a specific 'Actuation event' object.

path Parameters

id required

string Id of 'Actuation event' to return.

Responses

https://api.relynk.io/rec/v4.0.0/actuations/{id}

Response samples

• 200

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/ActuationEvent.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:ActuationEvent;1",
• "targetPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "value": "string",
• "customProperties": "string",
• "customTags": "string",
• "end": "2019-08-24T14:15:22Z",
• "identifiers": "string",
• "name": "string",
• "start": "2019-08-24T14:15:22Z",
• "timestamp": "2019-08-24T14:15:22Z"

}

[Not Implemented Yet] Update an existing 'Actuation event' entity.

path Parameters

id required

string Id of 'Actuation event' to update.

Request Body schema: application/ld+json

Updated data for 'Actuation event' entity.

@context required	string Default: "https://dev.realestatecore.io/contexts/ActuationEvent.jsonld"
@id	string
@type	string Default: "dtmi:org:w3id:rec:ActuationEvent;1"
	Array of objects
value	string
customProperties	string
customTags	string
end	string <date-time>
identifiers	string
name	string
start	string <date-time>
timestamp	string <date-time>

Responses

https://api.relynk.io/rec/v4.0.0/actuations/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/ActuationEvent.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:ActuationEvent;1",
• "targetPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "value": "string",
• "customProperties": "string",
• "customTags": "string",
• "end": "2019-08-24T14:15:22Z",
• "identifiers": "string",
• "name": "string",
• "start": "2019-08-24T14:15:22Z",
• "timestamp": "2019-08-24T14:15:22Z"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/ActuationEvent.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:ActuationEvent;1",
• "targetPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "value": "string",
• "customProperties": "string",
• "customTags": "string",
• "end": "2019-08-24T14:15:22Z",
• "identifiers": "string",
• "name": "string",
• "start": "2019-08-24T14:15:22Z",
• "timestamp": "2019-08-24T14:15:22Z"

}

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

path Parameters

id required

string Id of 'Actuation event' 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/ActuationEvent.jsonld"
@id	string
@type	string Default: "dtmi:org:w3id:rec:ActuationEvent;1"
	Array of objects
value	string
customProperties	string
customTags	string
end	string <date-time>
identifiers	string
name	string
start	string <date-time>
timestamp	string <date-time>

Responses

https://api.relynk.io/rec/v4.0.0/actuations/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/ActuationEvent.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:ActuationEvent;1",
• "targetPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "value": "string",
• "customProperties": "string",
• "customTags": "string",
• "end": "2019-08-24T14:15:22Z",
• "identifiers": "string",
• "name": "string",
• "start": "2019-08-24T14:15:22Z",
• "timestamp": "2019-08-24T14:15:22Z"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/ActuationEvent.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:ActuationEvent;1",
• "targetPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "value": "string",
• "customProperties": "string",
• "customTags": "string",
• "end": "2019-08-24T14:15:22Z",
• "identifiers": "string",
• "name": "string",
• "start": "2019-08-24T14:15:22Z",
• "timestamp": "2019-08-24T14:15:22Z"

}

[Not Implemented Yet] Delete a 'Actuation event' object.

path Parameters

id required

string Id of 'Actuation event' to delete.

Responses

https://api.relynk.io/rec/v4.0.0/actuations/{id}

exceptions

[Not Implemented Yet] Get 'Exception event' 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 'sourcePoint'.
	object (StringFilter) Filter value on property 'value'.
	object (StringFilter) Filter value on property 'customProperties'.
	object (StringFilter) Filter value on property 'customTags'.
	object (DateTimeFilter) Filter value on property 'end'.
	object (StringFilter) Filter value on property 'identifiers'.
	object (StringFilter) Filter value on property 'name'.
	object (DateTimeFilter) Filter value on property 'start'.
	object (DateTimeFilter) Filter value on property 'timestamp'.

Responses

https://api.relynk.io/rec/v4.0.0/exceptions

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": {

  • "@base": "http://example.com",
  • "hydra": "http://www.w3.org/ns/hydra/core#"

  },
• "@type": "hydra:Collection",
• "hydra:totalItems": 0,
• "hydra:view": {

  • "@id": "http://example.com",
  • "@type": "hydra:PartialCollectionView",
  • "hydra:first": "string",
  • "hydra:previous": "string",
  • "hydra:next": "string",
  • "hydra:last": "string"

  },
• "hydra:member": [

  • {

    • "@context": "https://dev.realestatecore.io/contexts/ExceptionEvent.jsonld",
    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:ExceptionEvent;1",
    • "sourcePoint": {

      • "@id": "string",
      • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

      },
    • "value": "string",
    • "customProperties": "string",
    • "customTags": "string",
    • "end": "2019-08-24T14:15:22Z",
    • "identifiers": "string",
    • "name": "string",
    • "start": "2019-08-24T14:15:22Z",
    • "timestamp": "2019-08-24T14:15:22Z"

    }

  ]

}

[Not Implemented Yet] Create a new 'Exception event' object.

Request Body schema: application/ld+json

New 'Exception event' entity that is to be added.

@context required	string Default: "https://dev.realestatecore.io/contexts/ExceptionEvent.jsonld"
@id	string
@type	string Default: "dtmi:org:w3id:rec:ExceptionEvent;1"
	object
value	string
customProperties	string
customTags	string
end	string <date-time>
identifiers	string
name	string
start	string <date-time>
timestamp	string <date-time>

Responses

https://api.relynk.io/rec/v4.0.0/exceptions

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/ExceptionEvent.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:ExceptionEvent;1",
• "sourcePoint": {

  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

  },
• "value": "string",
• "customProperties": "string",
• "customTags": "string",
• "end": "2019-08-24T14:15:22Z",
• "identifiers": "string",
• "name": "string",
• "start": "2019-08-24T14:15:22Z",
• "timestamp": "2019-08-24T14:15:22Z"

}

Response samples

• 201
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/ExceptionEvent.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:ExceptionEvent;1",
• "sourcePoint": {

  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

  },
• "value": "string",
• "customProperties": "string",
• "customTags": "string",
• "end": "2019-08-24T14:15:22Z",
• "identifiers": "string",
• "name": "string",
• "start": "2019-08-24T14:15:22Z",
• "timestamp": "2019-08-24T14:15:22Z"

}

[Not Implemented Yet] Get a specific 'Exception event' object.

path Parameters

id required

string Id of 'Exception event' to return.

Responses

https://api.relynk.io/rec/v4.0.0/exceptions/{id}

Response samples

• 200

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/ExceptionEvent.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:ExceptionEvent;1",
• "sourcePoint": {

  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

  },
• "value": "string",
• "customProperties": "string",
• "customTags": "string",
• "end": "2019-08-24T14:15:22Z",
• "identifiers": "string",
• "name": "string",
• "start": "2019-08-24T14:15:22Z",
• "timestamp": "2019-08-24T14:15:22Z"

}

[Not Implemented Yet] Update an existing 'Exception event' entity.

path Parameters

id required

string Id of 'Exception event' to update.

Request Body schema: application/ld+json

Updated data for 'Exception event' entity.

@context required	string Default: "https://dev.realestatecore.io/contexts/ExceptionEvent.jsonld"
@id	string
@type	string Default: "dtmi:org:w3id:rec:ExceptionEvent;1"
	object
value	string
customProperties	string
customTags	string
end	string <date-time>
identifiers	string
name	string
start	string <date-time>
timestamp	string <date-time>

Responses

https://api.relynk.io/rec/v4.0.0/exceptions/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/ExceptionEvent.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:ExceptionEvent;1",
• "sourcePoint": {

  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

  },
• "value": "string",
• "customProperties": "string",
• "customTags": "string",
• "end": "2019-08-24T14:15:22Z",
• "identifiers": "string",
• "name": "string",
• "start": "2019-08-24T14:15:22Z",
• "timestamp": "2019-08-24T14:15:22Z"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/ExceptionEvent.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:ExceptionEvent;1",
• "sourcePoint": {

  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

  },
• "value": "string",
• "customProperties": "string",
• "customTags": "string",
• "end": "2019-08-24T14:15:22Z",
• "identifiers": "string",
• "name": "string",
• "start": "2019-08-24T14:15:22Z",
• "timestamp": "2019-08-24T14:15:22Z"

}

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

path Parameters

id required

string Id of 'Exception event' 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/ExceptionEvent.jsonld"
@id	string
@type	string Default: "dtmi:org:w3id:rec:ExceptionEvent;1"
	object
value	string
customProperties	string
customTags	string
end	string <date-time>
identifiers	string
name	string
start	string <date-time>
timestamp	string <date-time>

Responses

https://api.relynk.io/rec/v4.0.0/exceptions/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/ExceptionEvent.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:ExceptionEvent;1",
• "sourcePoint": {

  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

  },
• "value": "string",
• "customProperties": "string",
• "customTags": "string",
• "end": "2019-08-24T14:15:22Z",
• "identifiers": "string",
• "name": "string",
• "start": "2019-08-24T14:15:22Z",
• "timestamp": "2019-08-24T14:15:22Z"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/ExceptionEvent.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:ExceptionEvent;1",
• "sourcePoint": {

  • "@id": "string",
  • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

  },
• "value": "string",
• "customProperties": "string",
• "customTags": "string",
• "end": "2019-08-24T14:15:22Z",
• "identifiers": "string",
• "name": "string",
• "start": "2019-08-24T14:15:22Z",
• "timestamp": "2019-08-24T14:15:22Z"

}

[Not Implemented Yet] Delete a 'Exception event' object.

path Parameters

id required

string Id of 'Exception event' to delete.

Responses

https://api.relynk.io/rec/v4.0.0/exceptions/{id}

information

[Not Implemented Yet] Get 'Information' 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 property 'customProperties'.
	object (StringFilter) Filter value on property 'customTags'.
	object (StringFilter) Filter value on property 'identifiers'.
	object (StringFilter) Filter value on property 'name'.

Responses

https://api.relynk.io/rec/v4.0.0/information

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": {

  • "@base": "http://example.com",
  • "hydra": "http://www.w3.org/ns/hydra/core#"

  },
• "@type": "hydra:Collection",
• "hydra:totalItems": 0,
• "hydra:view": {

  • "@id": "http://example.com",
  • "@type": "hydra:PartialCollectionView",
  • "hydra:first": "string",
  • "hydra:previous": "string",
  • "hydra:next": "string",
  • "hydra:last": "string"

  },
• "hydra:member": [

  • {

    • "@context": "https://dev.realestatecore.io/contexts/Information.jsonld",
    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Information;1",
    • "customProperties": "string",
    • "customTags": "string",
    • "identifiers": "string",
    • "name": "string"

    }

  ]

}

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

Request Body schema: application/ld+json

New 'Information' entity that is to be added.

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

Responses

https://api.relynk.io/rec/v4.0.0/information

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Information.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Information;1",
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 201
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Information.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Information;1",
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Information' to return.

Responses

https://api.relynk.io/rec/v4.0.0/information/{id}

Response samples

• 200

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Information.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Information;1",
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Information' to update.

Request Body schema: application/ld+json

Updated data for 'Information' entity.

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

Responses

https://api.relynk.io/rec/v4.0.0/information/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Information.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Information;1",
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Information.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Information;1",
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Information' 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/Information.jsonld"
@id	string
@type	string Default: "dtmi:org:w3id:rec:Information;1"
customProperties	string
customTags	string
identifiers	string
name	string

Responses

https://api.relynk.io/rec/v4.0.0/information/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Information.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Information;1",
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Information.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Information;1",
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Information' to delete.

Responses

https://api.relynk.io/rec/v4.0.0/information/{id}

spaces

Get 'Space' 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 'geometry'.
	object (StringFilter) Filter value on relationship 'georeference'.
	object (StringFilter) Filter value on relationship 'hasPart'.
	object (StringFilter) Filter value on relationship 'isLocationOf'.
	object (StringFilter) Filter value on relationship 'isPartOf'.
	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

https://api.relynk.io/rec/v4.0.0/spaces

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": {

  • "@base": "http://example.com",
  • "hydra": "http://www.w3.org/ns/hydra/core#"

  },
• "@type": "hydra:Collection",
• "hydra:totalItems": 0,
• "hydra:view": {

  • "@id": "http://example.com",
  • "@type": "hydra:PartialCollectionView",
  • "hydra:first": "string",
  • "hydra:previous": "string",
  • "hydra:next": "string",
  • "hydra:last": "string"

  },
• "hydra:member": [

  • {

    • "@context": "https://dev.realestatecore.io/contexts/Space.jsonld",
    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1",
    • "geometry": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:Geometry;1"

      },
    • "georeference": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:Georeference;1"

      },
    • "hasPart": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Space;1"

        }

      ],
    • "isLocationOf": [

      • {

        • "@id": "string",
        • "@type": "string"

        }

      ],
    • "isPartOf": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:Space;1"

      },
    • "customProperties": "string",
    • "customTags": "string",
    • "identifiers": "string",
    • "name": "string"

    }

  ]

}

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

Request Body schema: application/ld+json

New 'Space' entity that is to be added.

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

Responses

https://api.relynk.io/rec/v4.0.0/spaces

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Space.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Space;1",
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 201
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Space.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Space;1",
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Space' to return.

Responses

https://api.relynk.io/rec/v4.0.0/spaces/{id}

Response samples

• 200

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Space.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Space;1",
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Space' to update.

Request Body schema: application/ld+json

Updated data for 'Space' entity.

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

Responses

https://api.relynk.io/rec/v4.0.0/spaces/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Space.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Space;1",
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Space.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Space;1",
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Space' 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/Space.jsonld"
@id	string
@type	string Default: "dtmi:org:w3id:rec:Space;1"
	object
	object
	Array of objects
	Array of objects
	object
customProperties	string
customTags	string
identifiers	string
name	string

Responses

https://api.relynk.io/rec/v4.0.0/spaces/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Space.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Space;1",
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Space.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Space;1",
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Space' to delete.

Responses

https://api.relynk.io/rec/v4.0.0/spaces/{id}

documents

[Not Implemented Yet] Get 'Document' 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 'documentTopic'.
	object (StringFilter) Filter value on relationship 'url'.
	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

https://api.relynk.io/rec/v4.0.0/documents

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": {

  • "@base": "http://example.com",
  • "hydra": "http://www.w3.org/ns/hydra/core#"

  },
• "@type": "hydra:Collection",
• "hydra:totalItems": 0,
• "hydra:view": {

  • "@id": "http://example.com",
  • "@type": "hydra:PartialCollectionView",
  • "hydra:first": "string",
  • "hydra:previous": "string",
  • "hydra:next": "string",
  • "hydra:last": "string"

  },
• "hydra:member": [

  • {

    • "@context": "https://dev.realestatecore.io/contexts/Document.jsonld",
    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1",
    • "documentTopic": [

      • {

        • "@id": "string",
        • "@type": "string"

        }

      ],
    • "url": [

      • {

        • "@id": "string",
        • "@type": "string"

        }

      ],
    • "customProperties": "string",
    • "customTags": "string",
    • "identifiers": "string",
    • "name": "string"

    }

  ]

}

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

Request Body schema: application/ld+json

New 'Document' entity that is to be added.

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

Responses

https://api.relynk.io/rec/v4.0.0/documents

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Document.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Document;1",
• "documentTopic": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "url": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 201
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Document.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Document;1",
• "documentTopic": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "url": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Document' to return.

Responses

https://api.relynk.io/rec/v4.0.0/documents/{id}

Response samples

• 200

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Document.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Document;1",
• "documentTopic": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "url": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Document' to update.

Request Body schema: application/ld+json

Updated data for 'Document' entity.

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

Responses

https://api.relynk.io/rec/v4.0.0/documents/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Document.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Document;1",
• "documentTopic": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "url": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Document.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Document;1",
• "documentTopic": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "url": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Document' 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/Document.jsonld"
@id	string
@type	string Default: "dtmi:org:w3id:rec:Document;1"
	Array of objects
	Array of objects
customProperties	string
customTags	string
identifiers	string
name	string

Responses

https://api.relynk.io/rec/v4.0.0/documents/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Document.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Document;1",
• "documentTopic": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "url": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Document.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Document;1",
• "documentTopic": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "url": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Document' to delete.

Responses

https://api.relynk.io/rec/v4.0.0/documents/{id}

levels

[Not Implemented Yet] Get 'Level' 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 'address'.
	object (StringFilter) Filter value on relationship 'adjacentElement'.
	object (StringFilter) Filter value on relationship 'architectedBy'.
	object (StringFilter) Filter value on relationship 'constructedBy'.
	object (StringFilter) Filter value on relationship 'containsElement'.
	object (StringFilter) Filter value on relationship 'documentation'.
	object (StringFilter) Filter value on relationship 'hasPoint'.
	object (StringFilter) Filter value on relationship 'intersectingElement'.
	object (StringFilter) Filter value on relationship 'isFedBy'.
	object (StringFilter) Filter value on relationship 'operatedBy'.
	object (StringFilter) Filter value on relationship 'ownedBy'.
	object (StringFilter) Filter value on relationship 'geometry'.
	object (StringFilter) Filter value on relationship 'georeference'.
	object (StringFilter) Filter value on relationship 'hasPart'.
	object (StringFilter) Filter value on relationship 'isLocationOf'.
	object (StringFilter) Filter value on relationship 'isPartOf'.
	object (IntegerFilter) Filter value on property 'levelNumber'.
	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

https://api.relynk.io/rec/v4.0.0/levels

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": {

  • "@base": "http://example.com",
  • "hydra": "http://www.w3.org/ns/hydra/core#"

  },
• "@type": "hydra:Collection",
• "hydra:totalItems": 0,
• "hydra:view": {

  • "@id": "http://example.com",
  • "@type": "hydra:PartialCollectionView",
  • "hydra:first": "string",
  • "hydra:previous": "string",
  • "hydra:next": "string",
  • "hydra:last": "string"

  },
• "hydra:member": [

  • {

    • "@context": "https://dev.realestatecore.io/contexts/Level.jsonld",
    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Level;1",
    • "address": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

        }

      ],
    • "adjacentElement": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

        }

      ],
    • "architectedBy": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Agent;1"

        }

      ],
    • "constructedBy": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Agent;1"

        }

      ],
    • "containsElement": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

        }

      ],
    • "documentation": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Document;1"

        }

      ],
    • "hasPoint": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

        }

      ],
    • "intersectingElement": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

        }

      ],
    • "isFedBy": [

      • {

        • "@id": "string",
        • "@type": "string"

        }

      ],
    • "operatedBy": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Agent;1"

        }

      ],
    • "ownedBy": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Agent;1"

        }

      ],
    • "geometry": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:Geometry;1"

      },
    • "georeference": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:Georeference;1"

      },
    • "hasPart": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Space;1"

        }

      ],
    • "isLocationOf": [

      • {

        • "@id": "string",
        • "@type": "string"

        }

      ],
    • "isPartOf": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:Space;1"

      },
    • "area": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
      • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
      • "grossArea": 0.1,
      • "netArea": 0.1,
      • "rentableArea": 0.1,
      • "customProperties": "string",
      • "customTags": "string",
      • "identifiers": "string",
      • "name": "string"

      },
    • "capacity": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
      • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
      • "maxOccupancy": 0,
      • "seatingCapacity": 0,
      • "customProperties": "string",
      • "customTags": "string",
      • "identifiers": "string",
      • "name": "string"

      },
    • "levelNumber": 0,
    • "customProperties": "string",
    • "customTags": "string",
    • "identifiers": "string",
    • "name": "string"

    }

  ]

}

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

Request Body schema: application/ld+json

New 'Level' entity that is to be added.

@context required	string Default: "https://dev.realestatecore.io/contexts/Level.jsonld"
@id	string
@type	string Default: "dtmi:org:w3id:rec:Level;1"
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	object
	object
	Array of objects
	Array of objects
	object
	object (ArchitectureArea)
	object (ArchitectureCapacity)
levelNumber	integer <int32>
customProperties	string
customTags	string
identifiers	string
name	string

Responses

https://api.relynk.io/rec/v4.0.0/levels

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Level.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Level;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "levelNumber": 0,
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 201
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Level.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Level;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "levelNumber": 0,
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Level' to return.

Responses

https://api.relynk.io/rec/v4.0.0/levels/{id}

Response samples

• 200

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Level.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Level;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "levelNumber": 0,
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Level' to update.

Request Body schema: application/ld+json

Updated data for 'Level' entity.

@context required	string Default: "https://dev.realestatecore.io/contexts/Level.jsonld"
@id	string
@type	string Default: "dtmi:org:w3id:rec:Level;1"
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	object
	object
	Array of objects
	Array of objects
	object
	object (ArchitectureArea)
	object (ArchitectureCapacity)
levelNumber	integer <int32>
customProperties	string
customTags	string
identifiers	string
name	string

Responses

https://api.relynk.io/rec/v4.0.0/levels/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Level.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Level;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "levelNumber": 0,
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Level.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Level;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "levelNumber": 0,
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Level' 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/Level.jsonld"
@id	string
@type	string Default: "dtmi:org:w3id:rec:Level;1"
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	object
	object
	Array of objects
	Array of objects
	object
	object (ArchitectureArea)
	object (ArchitectureCapacity)
levelNumber	integer <int32>
customProperties	string
customTags	string
identifiers	string
name	string

Responses

https://api.relynk.io/rec/v4.0.0/levels/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Level.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Level;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "levelNumber": 0,
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Level.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Level;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "levelNumber": 0,
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Level' to delete.

Responses

https://api.relynk.io/rec/v4.0.0/levels/{id}

sites

[Not Implemented Yet] Get 'Site' 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 'address'.
	object (StringFilter) Filter value on relationship 'adjacentElement'.
	object (StringFilter) Filter value on relationship 'architectedBy'.
	object (StringFilter) Filter value on relationship 'constructedBy'.
	object (StringFilter) Filter value on relationship 'containsElement'.
	object (StringFilter) Filter value on relationship 'documentation'.
	object (StringFilter) Filter value on relationship 'hasPoint'.
	object (StringFilter) Filter value on relationship 'intersectingElement'.
	object (StringFilter) Filter value on relationship 'isFedBy'.
	object (StringFilter) Filter value on relationship 'operatedBy'.
	object (StringFilter) Filter value on relationship 'ownedBy'.
	object (StringFilter) Filter value on relationship 'geometry'.
	object (StringFilter) Filter value on relationship 'georeference'.
	object (StringFilter) Filter value on relationship 'hasPart'.
	object (StringFilter) Filter value on relationship 'isLocationOf'.
	object (StringFilter) Filter value on relationship 'isPartOf'.
	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

https://api.relynk.io/rec/v4.0.0/sites

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": {

  • "@base": "http://example.com",
  • "hydra": "http://www.w3.org/ns/hydra/core#"

  },
• "@type": "hydra:Collection",
• "hydra:totalItems": 0,
• "hydra:view": {

  • "@id": "http://example.com",
  • "@type": "hydra:PartialCollectionView",
  • "hydra:first": "string",
  • "hydra:previous": "string",
  • "hydra:next": "string",
  • "hydra:last": "string"

  },
• "hydra:member": [

  • {

    • "@context": "https://dev.realestatecore.io/contexts/Site.jsonld",
    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Site;1",
    • "address": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

        }

      ],
    • "adjacentElement": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

        }

      ],
    • "architectedBy": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Agent;1"

        }

      ],
    • "constructedBy": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Agent;1"

        }

      ],
    • "containsElement": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

        }

      ],
    • "documentation": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Document;1"

        }

      ],
    • "hasPoint": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

        }

      ],
    • "intersectingElement": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

        }

      ],
    • "isFedBy": [

      • {

        • "@id": "string",
        • "@type": "string"

        }

      ],
    • "operatedBy": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Agent;1"

        }

      ],
    • "ownedBy": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Agent;1"

        }

      ],
    • "geometry": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:Geometry;1"

      },
    • "georeference": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:Georeference;1"

      },
    • "hasPart": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Space;1"

        }

      ],
    • "isLocationOf": [

      • {

        • "@id": "string",
        • "@type": "string"

        }

      ],
    • "isPartOf": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:Space;1"

      },
    • "area": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
      • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
      • "grossArea": 0.1,
      • "netArea": 0.1,
      • "rentableArea": 0.1,
      • "customProperties": "string",
      • "customTags": "string",
      • "identifiers": "string",
      • "name": "string"

      },
    • "capacity": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
      • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
      • "maxOccupancy": 0,
      • "seatingCapacity": 0,
      • "customProperties": "string",
      • "customTags": "string",
      • "identifiers": "string",
      • "name": "string"

      },
    • "customProperties": "string",
    • "customTags": "string",
    • "identifiers": "string",
    • "name": "string"

    }

  ]

}

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

Request Body schema: application/ld+json

New 'Site' entity that is to be added.

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

Responses

https://api.relynk.io/rec/v4.0.0/sites

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Site.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Site;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 201
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Site.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Site;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Site' to return.

Responses

https://api.relynk.io/rec/v4.0.0/sites/{id}

Response samples

• 200

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Site.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Site;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Site' to update.

Request Body schema: application/ld+json

Updated data for 'Site' entity.

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

Responses

https://api.relynk.io/rec/v4.0.0/sites/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Site.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Site;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Site.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Site;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Site' 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/Site.jsonld"
@id	string
@type	string Default: "dtmi:org:w3id:rec:Site;1"
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	object
	object
	Array of objects
	Array of objects
	object
	object (ArchitectureArea)
	object (ArchitectureCapacity)
customProperties	string
customTags	string
identifiers	string
name	string

Responses

https://api.relynk.io/rec/v4.0.0/sites/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Site.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Site;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Site.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Site;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Site' to delete.

Responses

https://api.relynk.io/rec/v4.0.0/sites/{id}

subbuildings

[Not Implemented Yet] Get 'Sub-building' 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 'address'.
	object (StringFilter) Filter value on relationship 'adjacentElement'.
	object (StringFilter) Filter value on relationship 'architectedBy'.
	object (StringFilter) Filter value on relationship 'constructedBy'.
	object (StringFilter) Filter value on relationship 'containsElement'.
	object (StringFilter) Filter value on relationship 'documentation'.
	object (StringFilter) Filter value on relationship 'hasPoint'.
	object (StringFilter) Filter value on relationship 'intersectingElement'.
	object (StringFilter) Filter value on relationship 'isFedBy'.
	object (StringFilter) Filter value on relationship 'operatedBy'.
	object (StringFilter) Filter value on relationship 'ownedBy'.
	object (StringFilter) Filter value on relationship 'geometry'.
	object (StringFilter) Filter value on relationship 'georeference'.
	object (StringFilter) Filter value on relationship 'hasPart'.
	object (StringFilter) Filter value on relationship 'isLocationOf'.
	object (StringFilter) Filter value on relationship 'isPartOf'.
	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

https://api.relynk.io/rec/v4.0.0/subbuildings

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": {

  • "@base": "http://example.com",
  • "hydra": "http://www.w3.org/ns/hydra/core#"

  },
• "@type": "hydra:Collection",
• "hydra:totalItems": 0,
• "hydra:view": {

  • "@id": "http://example.com",
  • "@type": "hydra:PartialCollectionView",
  • "hydra:first": "string",
  • "hydra:previous": "string",
  • "hydra:next": "string",
  • "hydra:last": "string"

  },
• "hydra:member": [

  • {

    • "@context": "https://dev.realestatecore.io/contexts/SubBuilding.jsonld",
    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:SubBuilding;1",
    • "address": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

        }

      ],
    • "adjacentElement": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

        }

      ],
    • "architectedBy": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Agent;1"

        }

      ],
    • "constructedBy": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Agent;1"

        }

      ],
    • "containsElement": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

        }

      ],
    • "documentation": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Document;1"

        }

      ],
    • "hasPoint": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

        }

      ],
    • "intersectingElement": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

        }

      ],
    • "isFedBy": [

      • {

        • "@id": "string",
        • "@type": "string"

        }

      ],
    • "operatedBy": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Agent;1"

        }

      ],
    • "ownedBy": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Agent;1"

        }

      ],
    • "geometry": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:Geometry;1"

      },
    • "georeference": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:Georeference;1"

      },
    • "hasPart": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Space;1"

        }

      ],
    • "isLocationOf": [

      • {

        • "@id": "string",
        • "@type": "string"

        }

      ],
    • "isPartOf": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:Space;1"

      },
    • "area": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
      • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
      • "grossArea": 0.1,
      • "netArea": 0.1,
      • "rentableArea": 0.1,
      • "customProperties": "string",
      • "customTags": "string",
      • "identifiers": "string",
      • "name": "string"

      },
    • "capacity": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
      • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
      • "maxOccupancy": 0,
      • "seatingCapacity": 0,
      • "customProperties": "string",
      • "customTags": "string",
      • "identifiers": "string",
      • "name": "string"

      },
    • "customProperties": "string",
    • "customTags": "string",
    • "identifiers": "string",
    • "name": "string"

    }

  ]

}

[Not Implemented Yet] Create a new 'Sub-building' object.

Request Body schema: application/ld+json

New 'Sub-building' entity that is to be added.

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

Responses

https://api.relynk.io/rec/v4.0.0/subbuildings

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/SubBuilding.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:SubBuilding;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 201
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/SubBuilding.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:SubBuilding;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

[Not Implemented Yet] Get a specific 'Sub-building' object.

path Parameters

id required

string Id of 'Sub-building' to return.

Responses

https://api.relynk.io/rec/v4.0.0/subbuildings/{id}

Response samples

• 200

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/SubBuilding.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:SubBuilding;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

[Not Implemented Yet] Update an existing 'Sub-building' entity.

path Parameters

id required

string Id of 'Sub-building' to update.

Request Body schema: application/ld+json

Updated data for 'Sub-building' entity.

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

Responses

https://api.relynk.io/rec/v4.0.0/subbuildings/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/SubBuilding.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:SubBuilding;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/SubBuilding.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:SubBuilding;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

[Not Implemented Yet] Update a single property on a specific 'Sub-building' object.

path Parameters

id required

string Id of 'Sub-building' 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/SubBuilding.jsonld"
@id	string
@type	string Default: "dtmi:org:w3id:rec:SubBuilding;1"
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	object
	object
	Array of objects
	Array of objects
	object
	object (ArchitectureArea)
	object (ArchitectureCapacity)
customProperties	string
customTags	string
identifiers	string
name	string

Responses

https://api.relynk.io/rec/v4.0.0/subbuildings/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/SubBuilding.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:SubBuilding;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/SubBuilding.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:SubBuilding;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

[Not Implemented Yet] Delete a 'Sub-building' object.

path Parameters

id required

string Id of 'Sub-building' to delete.

Responses

https://api.relynk.io/rec/v4.0.0/subbuildings/{id}

rooms

[Not Implemented Yet] Get 'Room' 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 'address'.
	object (StringFilter) Filter value on relationship 'adjacentElement'.
	object (StringFilter) Filter value on relationship 'architectedBy'.
	object (StringFilter) Filter value on relationship 'constructedBy'.
	object (StringFilter) Filter value on relationship 'containsElement'.
	object (StringFilter) Filter value on relationship 'documentation'.
	object (StringFilter) Filter value on relationship 'hasPoint'.
	object (StringFilter) Filter value on relationship 'intersectingElement'.
	object (StringFilter) Filter value on relationship 'isFedBy'.
	object (StringFilter) Filter value on relationship 'operatedBy'.
	object (StringFilter) Filter value on relationship 'ownedBy'.
	object (StringFilter) Filter value on relationship 'geometry'.
	object (StringFilter) Filter value on relationship 'georeference'.
	object (StringFilter) Filter value on relationship 'hasPart'.
	object (StringFilter) Filter value on relationship 'isLocationOf'.
	object (StringFilter) Filter value on relationship 'isPartOf'.
	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

https://api.relynk.io/rec/v4.0.0/rooms

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": {

  • "@base": "http://example.com",
  • "hydra": "http://www.w3.org/ns/hydra/core#"

  },
• "@type": "hydra:Collection",
• "hydra:totalItems": 0,
• "hydra:view": {

  • "@id": "http://example.com",
  • "@type": "hydra:PartialCollectionView",
  • "hydra:first": "string",
  • "hydra:previous": "string",
  • "hydra:next": "string",
  • "hydra:last": "string"

  },
• "hydra:member": [

  • {

    • "@context": "https://dev.realestatecore.io/contexts/Room.jsonld",
    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Room;1",
    • "address": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

        }

      ],
    • "adjacentElement": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

        }

      ],
    • "architectedBy": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Agent;1"

        }

      ],
    • "constructedBy": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Agent;1"

        }

      ],
    • "containsElement": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

        }

      ],
    • "documentation": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Document;1"

        }

      ],
    • "hasPoint": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

        }

      ],
    • "intersectingElement": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

        }

      ],
    • "isFedBy": [

      • {

        • "@id": "string",
        • "@type": "string"

        }

      ],
    • "operatedBy": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Agent;1"

        }

      ],
    • "ownedBy": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Agent;1"

        }

      ],
    • "geometry": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:Geometry;1"

      },
    • "georeference": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:Georeference;1"

      },
    • "hasPart": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Space;1"

        }

      ],
    • "isLocationOf": [

      • {

        • "@id": "string",
        • "@type": "string"

        }

      ],
    • "isPartOf": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:Space;1"

      },
    • "area": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
      • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
      • "grossArea": 0.1,
      • "netArea": 0.1,
      • "rentableArea": 0.1,
      • "customProperties": "string",
      • "customTags": "string",
      • "identifiers": "string",
      • "name": "string"

      },
    • "capacity": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
      • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
      • "maxOccupancy": 0,
      • "seatingCapacity": 0,
      • "customProperties": "string",
      • "customTags": "string",
      • "identifiers": "string",
      • "name": "string"

      },
    • "customProperties": "string",
    • "customTags": "string",
    • "identifiers": "string",
    • "name": "string"

    }

  ]

}

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

Request Body schema: application/ld+json

New 'Room' entity that is to be added.

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

Responses

https://api.relynk.io/rec/v4.0.0/rooms

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Room.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Room;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 201
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Room.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Room;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Room' to return.

Responses

https://api.relynk.io/rec/v4.0.0/rooms/{id}

Response samples

• 200

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Room.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Room;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Room' to update.

Request Body schema: application/ld+json

Updated data for 'Room' entity.

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

Responses

https://api.relynk.io/rec/v4.0.0/rooms/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Room.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Room;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Room.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Room;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Room' 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/Room.jsonld"
@id	string
@type	string Default: "dtmi:org:w3id:rec:Room;1"
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	object
	object
	Array of objects
	Array of objects
	object
	object (ArchitectureArea)
	object (ArchitectureCapacity)
customProperties	string
customTags	string
identifiers	string
name	string

Responses

https://api.relynk.io/rec/v4.0.0/rooms/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Room.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Room;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Room.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Room;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Room' to delete.

Responses

https://api.relynk.io/rec/v4.0.0/rooms/{id}

zones

[Not Implemented Yet] Get 'Zone' 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 'address'.
	object (StringFilter) Filter value on relationship 'adjacentElement'.
	object (StringFilter) Filter value on relationship 'architectedBy'.
	object (StringFilter) Filter value on relationship 'constructedBy'.
	object (StringFilter) Filter value on relationship 'containsElement'.
	object (StringFilter) Filter value on relationship 'documentation'.
	object (StringFilter) Filter value on relationship 'hasPoint'.
	object (StringFilter) Filter value on relationship 'intersectingElement'.
	object (StringFilter) Filter value on relationship 'isFedBy'.
	object (StringFilter) Filter value on relationship 'operatedBy'.
	object (StringFilter) Filter value on relationship 'ownedBy'.
	object (StringFilter) Filter value on relationship 'geometry'.
	object (StringFilter) Filter value on relationship 'georeference'.
	object (StringFilter) Filter value on relationship 'hasPart'.
	object (StringFilter) Filter value on relationship 'isLocationOf'.
	object (StringFilter) Filter value on relationship 'isPartOf'.
	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

https://api.relynk.io/rec/v4.0.0/zones

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": {

  • "@base": "http://example.com",
  • "hydra": "http://www.w3.org/ns/hydra/core#"

  },
• "@type": "hydra:Collection",
• "hydra:totalItems": 0,
• "hydra:view": {

  • "@id": "http://example.com",
  • "@type": "hydra:PartialCollectionView",
  • "hydra:first": "string",
  • "hydra:previous": "string",
  • "hydra:next": "string",
  • "hydra:last": "string"

  },
• "hydra:member": [

  • {

    • "@context": "https://dev.realestatecore.io/contexts/Zone.jsonld",
    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Zone;1",
    • "address": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

        }

      ],
    • "adjacentElement": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

        }

      ],
    • "architectedBy": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Agent;1"

        }

      ],
    • "constructedBy": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Agent;1"

        }

      ],
    • "containsElement": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

        }

      ],
    • "documentation": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Document;1"

        }

      ],
    • "hasPoint": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

        }

      ],
    • "intersectingElement": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

        }

      ],
    • "isFedBy": [

      • {

        • "@id": "string",
        • "@type": "string"

        }

      ],
    • "operatedBy": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Agent;1"

        }

      ],
    • "ownedBy": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Agent;1"

        }

      ],
    • "geometry": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:Geometry;1"

      },
    • "georeference": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:Georeference;1"

      },
    • "hasPart": [

      • {

        • "@id": "string",
        • "@type": "dtmi:org:w3id:rec:Space;1"

        }

      ],
    • "isLocationOf": [

      • {

        • "@id": "string",
        • "@type": "string"

        }

      ],
    • "isPartOf": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:Space;1"

      },
    • "area": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
      • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
      • "grossArea": 0.1,
      • "netArea": 0.1,
      • "rentableArea": 0.1,
      • "customProperties": "string",
      • "customTags": "string",
      • "identifiers": "string",
      • "name": "string"

      },
    • "capacity": {

      • "@id": "string",
      • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
      • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
      • "maxOccupancy": 0,
      • "seatingCapacity": 0,
      • "customProperties": "string",
      • "customTags": "string",
      • "identifiers": "string",
      • "name": "string"

      },
    • "customProperties": "string",
    • "customTags": "string",
    • "identifiers": "string",
    • "name": "string"

    }

  ]

}

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

Request Body schema: application/ld+json

New 'Zone' entity that is to be added.

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

Responses

https://api.relynk.io/rec/v4.0.0/zones

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Zone.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Zone;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 201
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Zone.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Zone;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Zone' to return.

Responses

https://api.relynk.io/rec/v4.0.0/zones/{id}

Response samples

• 200

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Zone.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Zone;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Zone' to update.

Request Body schema: application/ld+json

Updated data for 'Zone' entity.

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

Responses

https://api.relynk.io/rec/v4.0.0/zones/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Zone.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Zone;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Zone.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Zone;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Zone' 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/Zone.jsonld"
@id	string
@type	string Default: "dtmi:org:w3id:rec:Zone;1"
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	Array of objects
	object
	object
	Array of objects
	Array of objects
	object
	object (ArchitectureArea)
	object (ArchitectureCapacity)
customProperties	string
customTags	string
identifiers	string
name	string

Responses

https://api.relynk.io/rec/v4.0.0/zones/{id}

Request samples

• Payload

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Zone.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Zone;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

Response samples

• 200
• 400

Content type

application/ld+json

{

• "@context": "https://dev.realestatecore.io/contexts/Zone.jsonld",
• "@id": "string",
• "@type": "dtmi:org:w3id:rec:Zone;1",
• "address": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:PostalAddress;1"

    }

  ],
• "adjacentElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "architectedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "constructedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "containsElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "documentation": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Document;1"

    }

  ],
• "hasPoint": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:brickschema:schema:Brick:Point;1"

    }

  ],
• "intersectingElement": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:BuildingElement;1"

    }

  ],
• "isFedBy": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "operatedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "ownedBy": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Agent;1"

    }

  ],
• "geometry": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Geometry;1"

  },
• "georeference": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Georeference;1"

  },
• "hasPart": [

  • {

    • "@id": "string",
    • "@type": "dtmi:org:w3id:rec:Space;1"

    }

  ],
• "isLocationOf": [

  • {

    • "@id": "string",
    • "@type": "string"

    }

  ],
• "isPartOf": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:Space;1"

  },
• "area": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureArea;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureArea.jsonld",
  • "grossArea": 0.1,
  • "netArea": 0.1,
  • "rentableArea": 0.1,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "capacity": {

  • "@id": "string",
  • "@type": "dtmi:org:w3id:rec:ArchitectureCapacity;1",
  • "@context": "https://dev.realestatecore.io/contexts/ArchitectureCapacity.jsonld",
  • "maxOccupancy": 0,
  • "seatingCapacity": 0,
  • "customProperties": "string",
  • "customTags": "string",
  • "identifiers": "string",
  • "name": "string"

  },
• "customProperties": "string",
• "customTags": "string",
• "identifiers": "string",
• "name": "string"

}

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

path Parameters

id required

string Id of 'Zone' to delete.

Responses

https://api.relynk.io/rec/v4.0.0/zones/{id}