BuildingMinds DigitalTwin Core (Preview)
The BuildingMinds Core Platform provides REST APIs. With the BuildingMinds DigitalTwin Core API you can read and list the Digital Building Twin masterdata such as buildings, floors and spaces and their properties.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | BuildingMinds Support |
| URL | https://buildingminds.com/services/customer-support |
| [email protected] |
| Connector Metadata | |
|---|---|
| Publisher | BuildingMinds |
| Website | https://buildingminds.com/ |
| Privacy policy | https://buildingminds.com/privacy-policy |
| Categories | Data |
The BuildingMinds Digital Twin Core Connector connects all data sources through a single, centralized platform. Use the BuildingMinds Platform as a single source of truth and update your other applications with accurate information on sites and buildings using this connector.
Prerequisites
You need an account on the BuildindMinds Platform and a user with appropriate authorization to use the connector. Please contact us at ​https://buildingminds.com/services/customer-support or [email protected].
Get started with your connector
A common use case is setting up an automated workflow between the BuildingMinds Digital Twin Core Connector and an ERP system to get up-to-date data of your buildings.
Get address data for several buildings
- To get the master data of all buildings, use the action
GetBuildings. By default, the first 20 items are displayed in the response. To change the default, use the query parameters$skipand$top. - Select the different properties of the object data you want to transfer to the ERP system. For more information, see Response properties under Addresses.
Get address data for a specific building
- Get the building ID for which you want to get the address data using the action
GetBuildings. - Use the action
GetBuildingById. - Select the properties in the response you want to transfer. For more information, see Response properties under Addresses.
Get all buildings that belong to a portfolio
- Get the portfolio ID for which you want to get the associated buildings using the action
GetPortfolios. - Use the action
GetPortfolioById. - Select the response property
associatedBuildingIds.
Response
Building
Properties
| Name | Description |
|---|---|
id |
Unique identifier for the building inside of the BuildingMinds platform. |
type |
Object type. In this case, the object type is a building. |
tid |
Tenant identifier |
title |
Building name |
validFrom |
Date from which the building is valid. |
validTo |
Date until which the building is valid. |
changedBy |
User identifier of the user who changed the building. |
changedOn |
Date when the building was last changed. |
createdOn |
Date when the building was created. |
internalId |
Identifier defined by the user. |
externalId |
Unique identifier from an external system used as a third-party application in the BuildingMinds platform. |
locationPath |
Contains the id, type, and title of the site to which the building belongs. |
imageIds |
When images are uploaded for the building, the image identifiers are displayed. |
parentId |
Identifier of the site to which the building belongs. |
typeOfBuilding |
Building type like Office or Residential. |
typeOfOwnership |
Type of ownership like Freehold or Part-ownership. |
associatedLandIds |
Lands that are associated with this building. |
constructionYear |
Year when the building was constructed. |
grossArea |
Area object containing the properties value, unit, and metricValue. |
mainAddressExternalId |
Identifier for the main address of the building in case there are several addresses saved for that building. |
addresses |
Object containing one or several addresses. For more information on address properties, see Addresses. |
parentHierarchies |
A custom hierarchy element to which the building is assigned. |
Addresses
Properties
| Name | Description |
|---|---|
id |
Unique identifier for the building inside of the BuildingMinds platform. |
type |
Object type. In this case, the object type is an address. |
tid |
Tenant identifier |
externalId |
Unique identifier from an external system or an automatically generated identifier for a user specific change over the user interface like a relocated map pin. |
street |
Street name |
houseNumber |
House number |
postalCode |
Postal code or zip code |
city |
City |
country |
Country |
changedBy |
User identifier of the user who changed the address. |
changedOn |
Date when the address was last changed. |
createdOn |
Date when the address was created. |
resolutionStatus |
Status if the resolution of the address was successful. |
latitude |
Geo-coordinates of the address. |
longitude |
Geo-coordinates of the address. |
region |
Region |
continent |
Continent |
Portfolio
Properties
| Name | Description |
|---|---|
id |
Unique identifier for the portfolio inside of the BuildingMinds platform. |
type |
Object type. In this case, the object type is a portfolio. |
createdOn |
Date when the portfolio was created. |
changedOn |
Date when the portfolio was last changed. |
changedBy |
User identifier of the user who changed the portfolio. |
title |
Portfolio name |
validFrom |
Date from which the portfolio is valid. |
validTo |
Date until which the portfolio is valid. |
owner |
Portfolio owner |
buildingGrossArea |
Area object containing the properties value, unit, and metricValue for all buildings of the portfolio. |
landGrossArea |
Area object containing the properties value, unit, and metricValue for all lands of the portfolio. |
internalId |
Identifier defined by the user. |
externalId |
Unique identifier from an external system used as a third-party application in the BuildingMinds platform. |
associatedBuildingIds |
Buildings that are associated with this portfolio. |
associatedLandIds |
Lands that are associated with this portfolio. |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Get all buildings |
Get all buildings for the currently logged in user's tenants |
| Get all facades |
Get all Facades for the currently logged in user's tenants |
| Get all floors |
Get all floors for the currently logged in user's tenants |
| Get all lands |
Get all lands for the currently logged in user's tenants |
| Get all outsideareas |
Get all outsideareas for the currently logged in user's tenants |
| Get all portfolios |
Get all portfolios for the currently logged in user's tenants |
| Get all roofs |
Get all roofs for the currently logged in user's tenants |
| Get all sites |
Get all sites for the currently logged in user's tenants |
| Get all spaces |
Get all spaces for the currently logged in user's tenants |
| Get all subareas |
Get all subareas for the currently logged in user's tenants |
| Get the list of associated entities |
Get the list of spaces of certain type associated with the provided space entity |
| Get the list of not associated entities |
Get the list of spaces of certain type which are not associated with the space of another provided type |
| Gets a buidling with the given ID |
Gets a building with the given ID |
| Gets a facade with the given ID |
Gets a facade with the given ID |
| Gets a floor with the given ID |
Gets a floor with the given ID |
| Gets a land with the given ID |
Gets a land with the given ID |
| Gets a outsidearea with the given ID |
Gets a outsidearea with the given ID |
| Gets a portfolio with the given ID |
Gets a portfolio with the given ID |
| Gets a roof with the given ID |
Gets a roof with the given ID |
| Gets a site with the given ID |
Gets a site with the given ID |
| Gets a space with the given ID |
Gets a space with the given ID |
| Gets a subarea with the given ID |
Gets a subarea with the given ID |
| Gets the information about the existence of children on a building |
Gets the information about the existence of children on a building |
| Gets the information about the existence of children on a facade |
Gets the information about the existence of children on a facade |
| Gets the information about the existence of children on a floor |
Gets the information about the existence of children on a floor |
| Gets the information about the existence of children on a land |
Gets the information about the existence of children on a land |
| Gets the information about the existence of children on a outsidearea |
Gets the information about the existence of children on a outsidearea |
| Gets the information about the existence of children on a portfolios |
Gets the information about the existence of children on a portfolios |
| Gets the information about the existence of children on a roof |
Gets the information about the existence of children on a roof |
| Gets the information about the existence of children on a site |
Gets the information about the existence of children on a site |
| Gets the information about the existence of children on a space |
Gets the information about the existence of children on a space |
| Gets the information about the existence of children on a subarea |
Gets the information about the existence of children on a subarea |
Get all buildings
Get all buildings for the currently logged in user's tenants
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Stop
|
$top | string |
This parameter is used for pagination and determines the maximum number of items which must be returned from the backend. Default is 20. |
|
|
Skip
|
$skip | string |
This parameter is used for pagination and marks the starting point of taking the items. Default is 0 |
Returns
Get all facades
Get all Facades for the currently logged in user's tenants
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Stop
|
$top | string |
This parameter is used for pagination and determines the maximum number of items which must be returned from the backend. Default is 20. |
|
|
Skip
|
$skip | string |
This parameter is used for pagination and marks the starting point of taking the items. Default is 0 |
Returns
Get all floors
Get all floors for the currently logged in user's tenants
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Stop
|
$top | string |
This parameter is used for pagination and determines the maximum number of items which must be returned from the backend. Default is 20. |
|
|
Skip
|
$skip | string |
This parameter is used for pagination and marks the starting point of taking the items. Default is 0 |
Returns
Get all lands
Get all lands for the currently logged in user's tenants
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Stop
|
$top | string |
This parameter is used for pagination and determines the maximum number of items which must be returned from the backend. Default is 20. |
|
|
Skip
|
$skip | string |
This parameter is used for pagination and marks the starting point of taking the items. Default is 0 |
Returns
Get all outsideareas
Get all outsideareas for the currently logged in user's tenants
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Stop
|
$top | string |
This parameter is used for pagination and determines the maximum number of items which must be returned from the backend. Default is 20. |
|
|
Skip
|
$skip | string |
This parameter is used for pagination and marks the starting point of taking the items. Default is 0 |
Returns
Get all portfolios
Get all portfolios for the currently logged in user's tenants
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Stop
|
$top | string |
This parameter is used for pagination and determines the maximum number of items which must be returned from the backend. Default is 20. |
|
|
Skip
|
$skip | string |
This parameter is used for pagination and marks the starting point of taking the items. Default is 0 |
Returns
Get all roofs
Get all roofs for the currently logged in user's tenants
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Stop
|
$top | string |
This parameter is used for pagination and determines the maximum number of items which must be returned from the backend. Default is 20. |
|
|
Skip
|
$skip | string |
This parameter is used for pagination and marks the starting point of taking the items. Default is 0 |
Returns
Get all sites
Get all sites for the currently logged in user's tenants
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Stop
|
$top | string |
This parameter is used for pagination and determines the maximum number of items which must be returned from the backend. Default is 20. |
|
|
Skip
|
$skip | string |
This parameter is used for pagination and marks the starting point of taking the items. Default is 0 |
Returns
Get all spaces
Get all spaces for the currently logged in user's tenants
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Stop
|
$top | string |
This parameter is used for pagination and determines the maximum number of items which must be returned from the backend. Default is 20. |
|
|
Skip
|
$skip | string |
This parameter is used for pagination and marks the starting point of taking the items. Default is 0 |
Returns
Get all subareas
Get all subareas for the currently logged in user's tenants
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Stop
|
$top | string |
This parameter is used for pagination and determines the maximum number of items which must be returned from the backend. Default is 20. |
|
|
Skip
|
$skip | string |
This parameter is used for pagination and marks the starting point of taking the items. Default is 0 |
Returns
Get the list of associated entities
Get the list of spaces of certain type associated with the provided space entity
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space Type
|
spaceType | True | string |
Describes the kind of space |
|
Space ID
|
id | True | string |
Format - uuid. Space unique identifier |
|
Associated Type
|
associatedType | True | string |
Describes the kind of associated space |
|
Skip
|
$skip | string |
This parameter is used for pagination and marks the starting point of taking the items. Default is 0 |
|
|
Stop
|
$top | string |
This parameter is used for pagination and determines the maximum number of items which must be returned from the backend. Default is 20. |
Returns
Get the list of not associated entities
Get the list of spaces of certain type which are not associated with the space of another provided type
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space Type
|
spaceType | True | string |
Describes the kind of space |
|
Associated Type
|
associatedType | True | string |
Describes the kind of associated space |
|
Space ID Query
|
spaceid | string |
Format - uuid. Optional identifier of associated space to include in the results |
Gets a buidling with the given ID
Gets a building with the given ID
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space ID
|
id | True | string |
Format - uuid. Space unique identifier |
Returns
- Body
- Building
Gets a facade with the given ID
Gets a facade with the given ID
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space ID
|
id | True | string |
Format - uuid. Space unique identifier |
Returns
- Body
- Facade
Gets a floor with the given ID
Gets a floor with the given ID
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space ID
|
id | True | string |
Format - uuid. Space unique identifier |
Returns
- Body
- Floor
Gets a land with the given ID
Gets a land with the given ID
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space ID
|
id | True | string |
Format - uuid. Space unique identifier |
Returns
- Body
- Land
Gets a outsidearea with the given ID
Gets a outsidearea with the given ID
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space ID
|
id | True | string |
Format - uuid. Space unique identifier |
Returns
- Body
- Outsidearea
Gets a portfolio with the given ID
Gets a portfolio with the given ID
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space ID
|
id | True | string |
Format - uuid. Space unique identifier |
Returns
- Body
- Portfolio
Gets a roof with the given ID
Gets a roof with the given ID
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space ID
|
id | True | string |
Format - uuid. Space unique identifier |
Returns
- Body
- Roof
Gets a site with the given ID
Gets a site with the given ID
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space ID
|
id | True | string |
Format - uuid. Space unique identifier |
Returns
- Body
- Site
Gets a space with the given ID
Gets a space with the given ID
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space ID
|
id | True | string |
Format - uuid. Space unique identifier |
Returns
- Body
- Space
Gets a subarea with the given ID
Gets a subarea with the given ID
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space ID
|
id | True | string |
Format - uuid. Space unique identifier |
Returns
- Body
- Subarea
Gets the information about the existence of children on a building
Gets the information about the existence of children on a building
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space ID
|
id | True | string |
Format - uuid. Space unique identifier |
Gets the information about the existence of children on a facade
Gets the information about the existence of children on a facade
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space ID
|
id | True | string |
Format - uuid. Space unique identifier |
Gets the information about the existence of children on a floor
Gets the information about the existence of children on a floor
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space ID
|
id | True | string |
Format - uuid. Space unique identifier |
Gets the information about the existence of children on a land
Gets the information about the existence of children on a land
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space ID
|
id | True | string |
Format - uuid. Space unique identifier |
Gets the information about the existence of children on a outsidearea
Gets the information about the existence of children on a outsidearea
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space ID
|
id | True | string |
Format - uuid. Space unique identifier |
Gets the information about the existence of children on a portfolios
Gets the information about the existence of children on a portfolios
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space ID
|
id | True | string |
Format - uuid. Space unique identifier |
Gets the information about the existence of children on a roof
Gets the information about the existence of children on a roof
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space ID
|
id | True | string |
Format - uuid. Space unique identifier |
Gets the information about the existence of children on a site
Gets the information about the existence of children on a site
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space ID
|
id | True | string |
Format - uuid. Space unique identifier |
Gets the information about the existence of children on a space
Gets the information about the existence of children on a space
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space ID
|
id | True | string |
Format - uuid. Space unique identifier |
Gets the information about the existence of children on a subarea
Gets the information about the existence of children on a subarea
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Space ID
|
id | True | string |
Format - uuid. Space unique identifier |
Definitions
CurrencyValueType
| Name | Path | Type | Description |
|---|---|---|---|
|
value
|
value | number | |
|
unit
|
unit | string |
AreaValueType
| Name | Path | Type | Description |
|---|---|---|---|
|
value
|
value | number | |
|
unit
|
unit | string | |
|
metricValue
|
metricValue | number |
LocationPathType
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string | |
|
title
|
title | string | |
|
type
|
type | string |
LocationPathArrayType
| Name | Path | Type | Description |
|---|---|---|---|
|
Items
|
LocationPathType |
SpaceTypeOfUseEnum
OutsideAreaType
EntityType
SpaceTypeOfOwnership
AddressType
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | uuid |
should be defined in POST/PUT requests for existing addresses only in the cases when existing address was added here instead of ids array |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Read only |
|
changedBy
|
changedBy | string |
Read only |
|
street
|
street | string | |
|
houseNumber
|
houseNumber | string | |
|
postalCode
|
postalCode | string | |
|
city
|
city | string | |
|
country
|
country | string |
ISO 3166-1 alpha-3 Country Codes, e.g. CAN, USA, DEU |
|
region
|
region | string | |
|
timeZone
|
timeZone | string | |
|
postBox
|
postBox | string | |
|
postBoxPostCode
|
postBoxPostCode | string | |
|
phone
|
phone | string | |
|
externalId
|
externalId | uuid |
External id of address, should be generated on a client side when creating new address |
|
latitude
|
latitude | float |
Laditiude coordinate for address |
|
longitude
|
longitude | float |
longitude coordinate for address |
Portfolio
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Read only |
|
changedBy
|
changedBy | string |
Read only |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
tid
|
tid | uuid |
tenant identifier |
|
title
|
title | string | |
|
description
|
description | string | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
owner
|
owner | string | |
|
buildingGrossArea
|
buildingGrossArea | AreaValueType | |
|
landGrossArea
|
landGrossArea | AreaValueType | |
|
associatedLandIds
|
associatedLandIds | array of uuid | |
|
associatedBuildingIds
|
associatedBuildingIds | array of uuid |
Site
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Read only |
|
changedBy
|
changedBy | string |
Read only |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
tid
|
tid | uuid |
tenant identifier |
|
title
|
title | string | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
buildingGrossArea
|
buildingGrossArea | AreaValueType | |
|
outsideareaGrossArea
|
outsideareaGrossArea | AreaValueType | |
|
mainAddressExternalId
|
mainAddressExternalId | uuid |
externalId of one of the addresses from the linkedAddresses collection should be put here to make address main |
|
addresses
|
addresses | array of AddressType | |
|
typeOfSite
|
typeOfSite | SpaceTypeOfUseEnum | |
|
imageIds
|
imageIds | array of uuid | |
|
internalId
|
internalId | uuid | |
|
furtherInformation
|
furtherInformation | string |
Building
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Read only |
|
changedBy
|
changedBy | string |
Read only |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
tid
|
tid | uuid |
tenant identifier |
|
associatedPortfolioId
|
associatedPortfolioId | uuid | |
|
parentId
|
parentId | uuid | |
|
associatedLandIds
|
associatedLandIds | array of uuid | |
|
title
|
title | string | |
|
internalId
|
internalId | uuid | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
addresses
|
addresses | array of AddressType | |
|
responsiblePeopleFullName
|
responsiblePeopleFullName | string | |
|
typeOfOwnership
|
typeOfOwnership | SpaceTypeOfOwnership | |
|
typeOfBuilding
|
typeOfBuilding | string | |
|
imageIds
|
imageIds | array of uuid | |
|
furtherInformation
|
furtherInformation | string | |
|
constructionYear
|
constructionYear | date | |
|
yearOfLastRefurbishment
|
yearOfLastRefurbishment | date | |
|
grossArea
|
grossArea | AreaValueType | |
|
buildingPurchaseCost
|
buildingPurchaseCost | CurrencyValueType | |
|
hasMonumentProtection
|
hasMonumentProtection | boolean | |
|
numberOfFloors
|
numberOfFloors | integer | |
|
numberOf BasementFloors
|
numberOf BasementFloors | integer |
Floor
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Read only |
|
changedBy
|
changedBy | string |
Read only |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
tid
|
tid | uuid |
tenant identifier |
|
title
|
title | string | |
|
parentId
|
parentId | uuid | |
|
internalId
|
internalId | uuid | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
furtherInformation
|
furtherInformation | string | |
|
grossArea
|
grossArea | AreaValueType | |
|
typeOfFloor
|
typeOfFloor | string | |
|
imageIds
|
imageIds | array of uuid |
Space
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Read only |
|
changedBy
|
changedBy | string |
Read only |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
tid
|
tid | uuid |
tenant identifier |
|
title
|
title | string | |
|
parentId
|
parentId | uuid | |
|
internalId
|
internalId | uuid | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
furtherInformation
|
furtherInformation | string | |
|
imageIds
|
imageIds | array of uuid | |
|
grossArea
|
grossArea | AreaValueType | |
|
typeOfSpace
|
typeOfSpace | string |
Roof
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Read only |
|
changedBy
|
changedBy | string |
Read only |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
tid
|
tid | uuid |
tenant identifier |
|
title
|
title | string | |
|
parentId
|
parentId | uuid | |
|
internalId
|
internalId | uuid | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
furtherInformation
|
furtherInformation | string | |
|
material
|
material | string | |
|
grossArea
|
grossArea | AreaValueType | |
|
imageIds
|
imageIds | array of uuid |
Facade
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Read only |
|
changedBy
|
changedBy | string |
Read only |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
tid
|
tid | uuid |
tenant identifier |
|
title
|
title | string | |
|
parentId
|
parentId | uuid | |
|
internalId
|
internalId | uuid | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
furtherInformation
|
furtherInformation | string | |
|
material
|
material | string | |
|
grossArea
|
grossArea | AreaValueType | |
|
imageIds
|
imageIds | array of uuid |
Outsidearea
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Read only |
|
changedBy
|
changedBy | string |
Read only |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
tid
|
tid | uuid |
tenant identifier |
|
title
|
title | string | |
|
parentId
|
parentId | uuid | |
|
internalId
|
internalId | uuid | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
furtherInformation
|
furtherInformation | string | |
|
typeOfOutsideArea
|
typeOfOutsideArea | OutsideAreaType | |
|
grossArea
|
grossArea | AreaValueType |
Land
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Read only |
|
changedBy
|
changedBy | string |
Read only |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
tid
|
tid | uuid |
tenant identifier |
|
title
|
title | string | |
|
parentId
|
parentId | uuid | |
|
internalId
|
internalId | uuid | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
furtherInformation
|
furtherInformation | string | |
|
grossArea
|
grossArea | AreaValueType | |
|
registrationNumberOfDeed
|
registrationNumberOfDeed | array of string | |
|
plotNumber
|
plotNumber | array of string | |
|
subPlotNumber
|
subPlotNumber | array of string | |
|
easementBelongingToDeed
|
easementBelongingToDeed | array of string | |
|
admissableSiteOccupancyIndex
|
admissableSiteOccupancyIndex | number | |
|
admissableCubicIndex
|
admissableCubicIndex | number | |
|
actualFloorSpaceIndex
|
actualFloorSpaceIndex | number | |
|
actualSiteOccupancyIndex
|
actualSiteOccupancyIndex | number | |
|
actualCubicIndex
|
actualCubicIndex | number | |
|
associatedPortfolioId
|
associatedPortfolioId | uuid | |
|
associatedBuildingIds
|
associatedBuildingIds | array of uuid |
Subarea
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Read only |
|
changedBy
|
changedBy | string |
Read only |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
tid
|
tid | uuid |
tenant identifier |
|
title
|
title | string | |
|
parentId
|
parentId | uuid | |
|
internalId
|
internalId | uuid | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
furtherInformation
|
furtherInformation | string |
PortfolioTypeWithPagination
| Name | Path | Type | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Portfolio |
SiteTypeWithPagination
| Name | Path | Type | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Site |
BuildingTypeWithPagination
| Name | Path | Type | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Building |
FloorTypeWithPagination
| Name | Path | Type | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Floor |
RoofsTypeWithPagination
| Name | Path | Type | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Roof |
FacadesTypeWithPagination
| Name | Path | Type | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Facade |
OutsideareasTypeWithPagination
| Name | Path | Type | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Outsidearea |
SubareasTypeWithPagination
| Name | Path | Type | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Subarea |
LandsTypeWithPagination
| Name | Path | Type | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Land |
SpacesTypeWithPagination
| Name | Path | Type | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Space |
AssociatedSpacesTypeWithPagination
| Name | Path | Type | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Space |