BuildingMinds DigitalTwin Core (preview)
Het BuildingMinds Core Platform biedt REST API's. Met de BuildingMinds DigitalTwin Core-API kunt u de Digital Building Twin-masterdata lezen en vermelden, zoals gebouwen, verdiepingen en ruimten en hun eigenschappen.
Deze connector is beschikbaar in de volgende producten en regio's:
| Dienst | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Logic-apps | Standaard | Alle Logic Apps-regio's , met uitzondering van het volgende: - Azure Government-regio's - Azure China-regio's - Us Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-regio's , met uitzondering van het volgende: - Amerikaanse overheid (GCC) - Amerikaanse overheid (GCC High) - China Cloud beheerd door 21Vianet - Us Department of Defense (DoD) |
| Contactpersoon | |
|---|---|
| Naam | Ondersteuning voor BuildingMinds |
| URL | https://buildingminds.com/services/customer-support |
| E-mailen | support@buildingminds.com |
| Connectormetagegevens | |
|---|---|
| Uitgever | BuildingMinds |
| Webpagina | https://buildingminds.com/ |
| Privacybeleid | https://buildingminds.com/privacy-policy |
| Categorieën | Gegevens |
De BuildingMinds Digital Twin Core Connector verbindt alle gegevensbronnen via één gecentraliseerd platform. Gebruik het BuildingMinds Platform als één bron van waarheid en werk uw andere toepassingen bij met nauwkeurige informatie over sites en gebouwen met behulp van deze connector.
Vereiste voorwaarden
U hebt een account nodig op het BuildindMinds Platform en een gebruiker met de juiste autorisatie voor het gebruik van de connector. Neem contact met ons op of https://buildingminds.com/services/customer-supportsupport@buildingminds.com.
Aan de slag met uw connector
Een veelvoorkomende use case is het instellen van een geautomatiseerde werkstroom tussen de BuildingMinds Digital Twin Core Connector en een ERP-systeem om up-to-datumgegevens van uw gebouwen op te halen.
Adresgegevens ophalen voor verschillende gebouwen
- Gebruik de actie
GetBuildingsom de hoofdgegevens van alle gebouwen op te halen. Standaard worden de eerste 20 items weergegeven in het antwoord. Als u de standaardinstelling wilt wijzigen, gebruikt u de queryparameters$skipen$top. - Selecteer de verschillende eigenschappen van de objectgegevens die u wilt overdragen naar het ERP-systeem. Zie Antwoordeigenschappen onder Adressen voor meer informatie.
Adresgegevens ophalen voor een specifiek gebouw
- Haal de bouw-id op waarvoor u de adresgegevens wilt ophalen met behulp van de actie
GetBuildings. - Gebruik de actie
GetBuildingById. - Selecteer de eigenschappen in het antwoord dat u wilt overdragen. Zie Antwoordeigenschappen onder Adressen voor meer informatie.
Alle gebouwen ophalen die deel uitmaken van een portfolio
- Haal de portfolio-id op waarvoor u de bijbehorende gebouwen wilt ophalen met behulp van de actie
GetPortfolios. - Gebruik de actie
GetPortfolioById. - Selecteer de antwoordeigenschap
associatedBuildingIds.
Reactie
Gebouw
Eigenschappen
| Naam | Description |
|---|---|
id |
Unieke id voor het gebouw binnen het BuildingMinds-platform. |
type |
Objecttype. In dit geval is het objecttype een gebouw. |
tid |
Tenant-id |
title |
Bouwnaam |
validFrom |
Datum van waaruit het gebouw geldig is. |
validTo |
Datum totdat het gebouw geldig is. |
changedBy |
Gebruikers-id van de gebruiker die het gebouw heeft gewijzigd. |
changedOn |
Datum waarop het gebouw voor het laatst is gewijzigd. |
createdOn |
Datum waarop het gebouw is gemaakt. |
internalId |
Id die is gedefinieerd door de gebruiker. |
externalId |
Unieke id van een extern systeem dat wordt gebruikt als een toepassing van derden in het BuildingMinds-platform. |
locationPath |
Bevat de id, typeen title van de site waartoe het gebouw behoort. |
imageIds |
Wanneer afbeeldingen voor het gebouw worden geüpload, worden de afbeeldings-id's weergegeven. |
parentId |
Id van de site waartoe het gebouw behoort. |
typeOfBuilding |
Bouwtype zoals Office of Residential. |
typeOfOwnership |
Type eigendom, zoals Vrije eigendom of Part-ownership. |
associatedLandIds |
Land dat aan dit gebouw is gekoppeld. |
constructionYear |
Jaar waarop het gebouw werd gebouwd. |
grossArea |
Gebiedsobject met de eigenschappen value, uniten metricValue. |
mainAddressExternalId |
Id voor het hoofdadres van het gebouw voor het geval er verschillende adressen zijn opgeslagen voor dat gebouw. |
addresses |
Object met een of meer adressen. Zie Adressen voor meer informatie over adreseigenschappen. |
parentHierarchies |
Een aangepast hiërarchie-element waaraan het gebouw is toegewezen. |
Addresses
Eigenschappen
| Naam | Description |
|---|---|
id |
Unieke id voor het gebouw binnen het BuildingMinds-platform. |
type |
Objecttype. In dit geval is het objecttype een adres. |
tid |
Tenant-id |
externalId |
Unieke id van een extern systeem of een automatisch gegenereerde id voor een specifieke wijziging van een gebruiker via de gebruikersinterface, zoals een verplaatste kaartpincode. |
street |
Straatnaam |
houseNumber |
Huisnummer |
postalCode |
Postcode of postcode |
city |
City |
country |
Country |
changedBy |
Gebruikers-id van de gebruiker die het adres heeft gewijzigd. |
changedOn |
Datum waarop het adres voor het laatst is gewijzigd. |
createdOn |
Datum waarop het adres is gemaakt. |
resolutionStatus |
Status als de oplossing van het adres is geslaagd. |
latitude |
Geocoördinaten van het adres. |
longitude |
Geocoördinaten van het adres. |
region |
Regio |
continent |
Continent |
Portefeuille
Eigenschappen
| Naam | Description |
|---|---|
id |
Unieke id voor de portfolio binnen het BuildingMinds-platform. |
type |
Objecttype. In dit geval is het objecttype een portfolio. |
createdOn |
De datum waarop de portfolio is gemaakt. |
changedOn |
Datum waarop de portfolio voor het laatst is gewijzigd. |
changedBy |
Gebruikers-id van de gebruiker die de portfolio heeft gewijzigd. |
title |
Portfolionaam |
validFrom |
De datum van waaruit de portefeuille geldig is. |
validTo |
Datum totdat de portefeuille geldig is. |
owner |
Portfolio-eigenaar |
buildingGrossArea |
Gebiedsobject met de eigenschappen value, uniten metricValue voor alle gebouwen van de portfolio. |
landGrossArea |
Gebiedsobject met de eigenschappen value, uniten metricValue voor alle landen van de portfolio. |
internalId |
Id die is gedefinieerd door de gebruiker. |
externalId |
Unieke id van een extern systeem dat wordt gebruikt als een toepassing van derden in het BuildingMinds-platform. |
associatedBuildingIds |
Gebouwen die aan deze portfolio zijn gekoppeld. |
associatedLandIds |
Land dat aan deze portfolio is gekoppeld. |
Beperkingslimieten
| Name | Aanroepen | Verlengingsperiode |
|---|---|---|
| API-aanroepen per verbinding | 100 | 60 seconden |
Acties
| Alle buitengebieden ophalen |
Alle buitengebieden ophalen voor de tenants van de aangemelde gebruiker |
| Alle daken ophalen |
Alle daken ophalen voor de tenants van de aangemelde gebruiker |
| Alle gebouwen ophalen |
Alle gebouwen ophalen voor de tenants van de aangemelde gebruiker |
| Alle gevels ophalen |
Haal alle facades op voor de tenants van de aangemelde gebruiker |
| Alle landen ophalen |
Alle landen ophalen voor de tenants van de gebruiker die momenteel zijn aangemeld |
| Alle portfolio's ophalen |
Alle portfolio's ophalen voor de tenants van de momenteel aangemelde gebruiker |
| Alle sites ophalen |
Alle sites ophalen voor de tenants van de gebruiker die momenteel zijn aangemeld |
| Alle spaties ophalen |
Alle ruimten ophalen voor de tenants van de aangemelde gebruiker |
| Alle subgebieden ophalen |
Alle subgebieden ophalen voor de tenants van de gebruiker die momenteel zijn aangemeld |
| Alle verdiepingen ophalen |
Alle verdiepingen ophalen voor de tenants van de aangemelde gebruiker |
| De lijst met gekoppelde entiteiten ophalen |
De lijst met spaties ophalen van een bepaald type dat is gekoppeld aan de opgegeven ruimte-entiteit |
| De lijst met niet-gekoppelde entiteiten ophalen |
De lijst met spaties van een bepaald type ophalen die niet zijn gekoppeld aan de ruimte van een ander opgegeven type |
| Haalt de informatie op over het bestaan van kinderen in een gebouw |
Haalt de informatie op over het bestaan van kinderen in een gebouw |
| Haalt de informatie op over het bestaan van kinderen in een portfolio |
Haalt de informatie op over het bestaan van kinderen in een portfolio |
| Haalt de informatie op over het bestaan van kinderen op een buitengebied |
Haalt de informatie op over het bestaan van kinderen op een buitengebied |
| Haalt de informatie op over het bestaan van kinderen op een dak |
Haalt de informatie op over het bestaan van kinderen op een dak |
| Haalt de informatie op over het bestaan van kinderen op een gevel |
Haalt de informatie op over het bestaan van kinderen op een gevel |
| Haalt de informatie op over het bestaan van kinderen op een land |
Haalt de informatie op over het bestaan van kinderen op een land |
| Haalt de informatie op over het bestaan van kinderen op een ruimte |
Haalt de informatie op over het bestaan van kinderen op een ruimte |
| Haalt de informatie op over het bestaan van kinderen op een site |
Haalt de informatie op over het bestaan van kinderen op een site |
| Haalt de informatie op over het bestaan van kinderen op een subgebied |
Haalt de informatie op over het bestaan van kinderen op een subgebied |
| Haalt de informatie op over het bestaan van kinderen op een vloer |
Haalt de informatie op over het bestaan van kinderen op een vloer |
| Haalt een land op met de opgegeven id |
Haalt een land op met de opgegeven id |
| Haalt een subgebied op met de opgegeven id |
Haalt een subgebied op met de opgegeven id |
| Haalt een vloer op met de opgegeven id |
Haalt een vloer op met de opgegeven id |
| Hiermee haalt u een gevel met de opgegeven id op |
Hiermee haalt u een gevel met de opgegeven id op |
| Hiermee haalt u een outsidearea met de opgegeven id op |
Hiermee haalt u een outsidearea met de opgegeven id op |
| Hiermee haalt u een portfolio op met de opgegeven id |
Hiermee haalt u een portfolio op met de opgegeven id |
| Hiermee haalt u een site op met de opgegeven id |
Hiermee haalt u een site op met de opgegeven id |
| Hiermee haalt u een spatie op met de opgegeven id |
Hiermee haalt u een spatie op met de opgegeven id |
| Krijgt een buidling met de opgegeven id |
Hiermee haalt u een gebouw op met de opgegeven id |
| Krijgt een dak met de opgegeven id |
Krijgt een dak met de opgegeven id |
Alle buitengebieden ophalen
Alle buitengebieden ophalen voor de tenants van de aangemelde gebruiker
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Stoppen
|
$top | string |
Deze parameter wordt gebruikt voor paginering en bepaalt het maximum aantal items dat moet worden geretourneerd vanuit de back-end. Standaard is 20. |
|
|
Overslaan
|
$skip | string |
Deze parameter wordt gebruikt voor paginering en markeert het beginpunt van het nemen van de items. De standaardwaarde is 0 |
Retouren
Alle daken ophalen
Alle daken ophalen voor de tenants van de aangemelde gebruiker
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Stoppen
|
$top | string |
Deze parameter wordt gebruikt voor paginering en bepaalt het maximum aantal items dat moet worden geretourneerd vanuit de back-end. Standaard is 20. |
|
|
Overslaan
|
$skip | string |
Deze parameter wordt gebruikt voor paginering en markeert het beginpunt van het nemen van de items. De standaardwaarde is 0 |
Retouren
Alle gebouwen ophalen
Alle gebouwen ophalen voor de tenants van de aangemelde gebruiker
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Stoppen
|
$top | string |
Deze parameter wordt gebruikt voor paginering en bepaalt het maximum aantal items dat moet worden geretourneerd vanuit de back-end. Standaard is 20. |
|
|
Overslaan
|
$skip | string |
Deze parameter wordt gebruikt voor paginering en markeert het beginpunt van het nemen van de items. De standaardwaarde is 0 |
Retouren
Alle gevels ophalen
Haal alle facades op voor de tenants van de aangemelde gebruiker
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Stoppen
|
$top | string |
Deze parameter wordt gebruikt voor paginering en bepaalt het maximum aantal items dat moet worden geretourneerd vanuit de back-end. Standaard is 20. |
|
|
Overslaan
|
$skip | string |
Deze parameter wordt gebruikt voor paginering en markeert het beginpunt van het nemen van de items. De standaardwaarde is 0 |
Retouren
Alle landen ophalen
Alle landen ophalen voor de tenants van de gebruiker die momenteel zijn aangemeld
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Stoppen
|
$top | string |
Deze parameter wordt gebruikt voor paginering en bepaalt het maximum aantal items dat moet worden geretourneerd vanuit de back-end. Standaard is 20. |
|
|
Overslaan
|
$skip | string |
Deze parameter wordt gebruikt voor paginering en markeert het beginpunt van het nemen van de items. De standaardwaarde is 0 |
Retouren
Alle portfolio's ophalen
Alle portfolio's ophalen voor de tenants van de momenteel aangemelde gebruiker
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Stoppen
|
$top | string |
Deze parameter wordt gebruikt voor paginering en bepaalt het maximum aantal items dat moet worden geretourneerd vanuit de back-end. Standaard is 20. |
|
|
Overslaan
|
$skip | string |
Deze parameter wordt gebruikt voor paginering en markeert het beginpunt van het nemen van de items. De standaardwaarde is 0 |
Retouren
Alle sites ophalen
Alle sites ophalen voor de tenants van de gebruiker die momenteel zijn aangemeld
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Stoppen
|
$top | string |
Deze parameter wordt gebruikt voor paginering en bepaalt het maximum aantal items dat moet worden geretourneerd vanuit de back-end. Standaard is 20. |
|
|
Overslaan
|
$skip | string |
Deze parameter wordt gebruikt voor paginering en markeert het beginpunt van het nemen van de items. De standaardwaarde is 0 |
Retouren
Alle spaties ophalen
Alle ruimten ophalen voor de tenants van de aangemelde gebruiker
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Stoppen
|
$top | string |
Deze parameter wordt gebruikt voor paginering en bepaalt het maximum aantal items dat moet worden geretourneerd vanuit de back-end. Standaard is 20. |
|
|
Overslaan
|
$skip | string |
Deze parameter wordt gebruikt voor paginering en markeert het beginpunt van het nemen van de items. De standaardwaarde is 0 |
Retouren
Alle subgebieden ophalen
Alle subgebieden ophalen voor de tenants van de gebruiker die momenteel zijn aangemeld
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Stoppen
|
$top | string |
Deze parameter wordt gebruikt voor paginering en bepaalt het maximum aantal items dat moet worden geretourneerd vanuit de back-end. Standaard is 20. |
|
|
Overslaan
|
$skip | string |
Deze parameter wordt gebruikt voor paginering en markeert het beginpunt van het nemen van de items. De standaardwaarde is 0 |
Retouren
Alle verdiepingen ophalen
Alle verdiepingen ophalen voor de tenants van de aangemelde gebruiker
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Stoppen
|
$top | string |
Deze parameter wordt gebruikt voor paginering en bepaalt het maximum aantal items dat moet worden geretourneerd vanuit de back-end. Standaard is 20. |
|
|
Overslaan
|
$skip | string |
Deze parameter wordt gebruikt voor paginering en markeert het beginpunt van het nemen van de items. De standaardwaarde is 0 |
Retouren
De lijst met gekoppelde entiteiten ophalen
De lijst met spaties ophalen van een bepaald type dat is gekoppeld aan de opgegeven ruimte-entiteit
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Spatietype
|
spaceType | True | string |
Beschrijft het soort ruimte |
|
Spatie-id
|
id | True | string |
Indeling - uuid. Unieke id voor spatie |
|
Gekoppeld type
|
associatedType | True | string |
Beschrijft het soort gekoppelde ruimte |
|
Overslaan
|
$skip | string |
Deze parameter wordt gebruikt voor paginering en markeert het beginpunt van het nemen van de items. De standaardwaarde is 0 |
|
|
Stoppen
|
$top | string |
Deze parameter wordt gebruikt voor paginering en bepaalt het maximum aantal items dat moet worden geretourneerd vanuit de back-end. Standaard is 20. |
Retouren
De lijst met niet-gekoppelde entiteiten ophalen
De lijst met spaties van een bepaald type ophalen die niet zijn gekoppeld aan de ruimte van een ander opgegeven type
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Spatietype
|
spaceType | True | string |
Beschrijft het soort ruimte |
|
Gekoppeld type
|
associatedType | True | string |
Beschrijft het soort gekoppelde ruimte |
|
Query voor spatie-id
|
spaceid | string |
Indeling - uuid. Optionele id van de gekoppelde ruimte die moet worden opgenomen in de resultaten |
Haalt de informatie op over het bestaan van kinderen in een gebouw
Haalt de informatie op over het bestaan van kinderen in een gebouw
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Spatie-id
|
id | True | string |
Indeling - uuid. Unieke id voor spatie |
Haalt de informatie op over het bestaan van kinderen in een portfolio
Haalt de informatie op over het bestaan van kinderen in een portfolio
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Spatie-id
|
id | True | string |
Indeling - uuid. Unieke id voor spatie |
Haalt de informatie op over het bestaan van kinderen op een buitengebied
Haalt de informatie op over het bestaan van kinderen op een buitengebied
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Spatie-id
|
id | True | string |
Indeling - uuid. Unieke id voor spatie |
Haalt de informatie op over het bestaan van kinderen op een dak
Haalt de informatie op over het bestaan van kinderen op een dak
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Spatie-id
|
id | True | string |
Indeling - uuid. Unieke id voor spatie |
Haalt de informatie op over het bestaan van kinderen op een gevel
Haalt de informatie op over het bestaan van kinderen op een gevel
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Spatie-id
|
id | True | string |
Indeling - uuid. Unieke id voor spatie |
Haalt de informatie op over het bestaan van kinderen op een land
Haalt de informatie op over het bestaan van kinderen op een land
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Spatie-id
|
id | True | string |
Indeling - uuid. Unieke id voor spatie |
Haalt de informatie op over het bestaan van kinderen op een ruimte
Haalt de informatie op over het bestaan van kinderen op een ruimte
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Spatie-id
|
id | True | string |
Indeling - uuid. Unieke id voor spatie |
Haalt de informatie op over het bestaan van kinderen op een site
Haalt de informatie op over het bestaan van kinderen op een site
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Spatie-id
|
id | True | string |
Indeling - uuid. Unieke id voor spatie |
Haalt de informatie op over het bestaan van kinderen op een subgebied
Haalt de informatie op over het bestaan van kinderen op een subgebied
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Spatie-id
|
id | True | string |
Indeling - uuid. Unieke id voor spatie |
Haalt de informatie op over het bestaan van kinderen op een vloer
Haalt de informatie op over het bestaan van kinderen op een vloer
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Spatie-id
|
id | True | string |
Indeling - uuid. Unieke id voor spatie |
Haalt een land op met de opgegeven id
Haalt een land op met de opgegeven id
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Spatie-id
|
id | True | string |
Indeling - uuid. Unieke id voor spatie |
Retouren
- Body
- Land
Haalt een subgebied op met de opgegeven id
Haalt een subgebied op met de opgegeven id
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Spatie-id
|
id | True | string |
Indeling - uuid. Unieke id voor spatie |
Retouren
- Body
- Subarea
Haalt een vloer op met de opgegeven id
Haalt een vloer op met de opgegeven id
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Spatie-id
|
id | True | string |
Indeling - uuid. Unieke id voor spatie |
Retouren
- Body
- Floor
Hiermee haalt u een gevel met de opgegeven id op
Hiermee haalt u een gevel met de opgegeven id op
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Spatie-id
|
id | True | string |
Indeling - uuid. Unieke id voor spatie |
Retouren
- Body
- Facade
Hiermee haalt u een outsidearea met de opgegeven id op
Hiermee haalt u een outsidearea met de opgegeven id op
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Spatie-id
|
id | True | string |
Indeling - uuid. Unieke id voor spatie |
Retouren
- Body
- Outsidearea
Hiermee haalt u een portfolio op met de opgegeven id
Hiermee haalt u een portfolio op met de opgegeven id
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Spatie-id
|
id | True | string |
Indeling - uuid. Unieke id voor spatie |
Retouren
- Body
- Portfolio
Hiermee haalt u een site op met de opgegeven id
Hiermee haalt u een site op met de opgegeven id
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Spatie-id
|
id | True | string |
Indeling - uuid. Unieke id voor spatie |
Retouren
- Body
- Site
Hiermee haalt u een spatie op met de opgegeven id
Hiermee haalt u een spatie op met de opgegeven id
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Spatie-id
|
id | True | string |
Indeling - uuid. Unieke id voor spatie |
Retouren
- Body
- Space
Krijgt een buidling met de opgegeven id
Hiermee haalt u een gebouw op met de opgegeven id
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Spatie-id
|
id | True | string |
Indeling - uuid. Unieke id voor spatie |
Retouren
- Body
- Building
Krijgt een dak met de opgegeven id
Krijgt een dak met de opgegeven id
Parameters
| Name | Sleutel | Vereist | Type | Description |
|---|---|---|---|---|
|
Spatie-id
|
id | True | string |
Indeling - uuid. Unieke id voor spatie |
Retouren
- Body
- Roof
Definities
CurrencyValueType
| Name | Pad | Type | Description |
|---|---|---|---|
|
waarde
|
value | number | |
|
eenheid
|
unit | string |
AreaValueType
| Name | Pad | Type | Description |
|---|---|---|---|
|
waarde
|
value | number | |
|
eenheid
|
unit | string | |
|
metricValue
|
metricValue | number |
LocationPathType
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | string | |
|
title
|
title | string | |
|
type
|
type | string |
LocationPathArrayType
| Name | Pad | Type | Description |
|---|---|---|---|
|
Artikelen
|
LocationPathType |
SpaceTypeOfUseEnum
OutsideAreaType
Entiteitstype
SpaceTypeOfOwnership
AddressType
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | uuid |
moet worden gedefinieerd in POST/PUT-aanvragen voor bestaande adressen alleen in de gevallen waarin het bestaande adres hier is toegevoegd in plaats van id's-matrix |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Alleen lezen |
|
changedBy
|
changedBy | string |
Alleen lezen |
|
straat
|
street | string | |
|
huisnummer
|
houseNumber | string | |
|
postalCode
|
postalCode | string | |
|
city
|
city | string | |
|
country
|
country | string |
ISO 3166-1 alfa-3 landcodes, bijvoorbeeld CAN, USA, DEU |
|
region
|
region | string | |
|
tijdzone
|
timeZone | string | |
|
brievenbus
|
postBox | string | |
|
postBoxPostCode
|
postBoxPostCode | string | |
|
phone
|
phone | string | |
|
externId
|
externalId | uuid |
Externe id van adres moet worden gegenereerd aan de clientzijde bij het maken van een nieuw adres |
|
breedtegraad
|
latitude | float |
Laditiudecoördinaat voor adres |
|
lengtegraad
|
longitude | float |
lengtegraadcoördinaat voor adres |
Portefeuille
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Alleen lezen |
|
changedBy
|
changedBy | string |
Alleen lezen |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tijd
|
tid | uuid |
tenant-id |
|
title
|
title | string | |
|
beschrijving
|
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 | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Alleen lezen |
|
changedBy
|
changedBy | string |
Alleen lezen |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tijd
|
tid | uuid |
tenant-id |
|
title
|
title | string | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
buildingGrossArea
|
buildingGrossArea | AreaValueType | |
|
outsideareaGrossArea
|
outsideareaGrossArea | AreaValueType | |
|
mainAddressExternalId
|
mainAddressExternalId | uuid |
externalId van een van de adressen uit de verzameling linkedAddresses moet hier worden geplaatst om het hoofdadres te maken |
|
addresses
|
addresses | array of AddressType | |
|
typeOfSite
|
typeOfSite | SpaceTypeOfUseEnum | |
|
imageIds
|
imageIds | array of uuid | |
|
internalId
|
internalId | uuid | |
|
furtherInformation
|
furtherInformation | string |
Gebouw
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Alleen lezen |
|
changedBy
|
changedBy | string |
Alleen lezen |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tijd
|
tid | uuid |
tenant-id |
|
associatedPortfolioId
|
associatedPortfolioId | uuid | |
|
ouder-ID
|
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 | |
|
bouwjaar
|
constructionYear | date | |
|
yearOfLastRefurbishment
|
yearOfLastRefurbishment | date | |
|
grossArea
|
grossArea | AreaValueType | |
|
buildingPurchaseCost
|
buildingPurchaseCost | CurrencyValueType | |
|
hasMonumentProtection
|
hasMonumentProtection | boolean | |
|
numberOfFloors
|
numberOfFloors | integer | |
|
numberOf BasementFloors
|
numberOf BasementFloors | integer |
Vloer
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Alleen lezen |
|
changedBy
|
changedBy | string |
Alleen lezen |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tijd
|
tid | uuid |
tenant-id |
|
title
|
title | string | |
|
ouder-ID
|
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 |
Ruimte
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Alleen lezen |
|
changedBy
|
changedBy | string |
Alleen lezen |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tijd
|
tid | uuid |
tenant-id |
|
title
|
title | string | |
|
ouder-ID
|
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 |
Dak
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Alleen lezen |
|
changedBy
|
changedBy | string |
Alleen lezen |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tijd
|
tid | uuid |
tenant-id |
|
title
|
title | string | |
|
ouder-ID
|
parentId | uuid | |
|
internalId
|
internalId | uuid | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
furtherInformation
|
furtherInformation | string | |
|
materiaal
|
material | string | |
|
grossArea
|
grossArea | AreaValueType | |
|
imageIds
|
imageIds | array of uuid |
Gevel
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Alleen lezen |
|
changedBy
|
changedBy | string |
Alleen lezen |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tijd
|
tid | uuid |
tenant-id |
|
title
|
title | string | |
|
ouder-ID
|
parentId | uuid | |
|
internalId
|
internalId | uuid | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
furtherInformation
|
furtherInformation | string | |
|
materiaal
|
material | string | |
|
grossArea
|
grossArea | AreaValueType | |
|
imageIds
|
imageIds | array of uuid |
Buitengebied
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Alleen lezen |
|
changedBy
|
changedBy | string |
Alleen lezen |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tijd
|
tid | uuid |
tenant-id |
|
title
|
title | string | |
|
ouder-ID
|
parentId | uuid | |
|
internalId
|
internalId | uuid | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
furtherInformation
|
furtherInformation | string | |
|
typeOfOutsideArea
|
typeOfOutsideArea | OutsideAreaType | |
|
grossArea
|
grossArea | AreaValueType |
Land
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Alleen lezen |
|
changedBy
|
changedBy | string |
Alleen lezen |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tijd
|
tid | uuid |
tenant-id |
|
title
|
title | string | |
|
ouder-ID
|
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 |
Deelgebied
| Name | Pad | Type | Description |
|---|---|---|---|
|
identiteitskaart
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Alleen lezen |
|
changedBy
|
changedBy | string |
Alleen lezen |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tijd
|
tid | uuid |
tenant-id |
|
title
|
title | string | |
|
ouder-ID
|
parentId | uuid | |
|
internalId
|
internalId | uuid | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
furtherInformation
|
furtherInformation | string |
PortfolioTypeWithPagination
| Name | Pad | Type | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Portfolio |
SiteTypeWithPagination
| Name | Pad | Type | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Site |
BuildingTypeWithPagination
| Name | Pad | Type | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Building |
FloorTypeWithPagination
| Name | Pad | Type | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Floor |
RoofsTypeWithPagination
| Name | Pad | Type | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Roof |
FacadesTypeWithPagination
| Name | Pad | Type | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Facade |
OutsideareasTypeWithPagination
| Name | Pad | Type | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Outsidearea |
SubbareasTypeWithPagination
| Name | Pad | Type | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Subarea |
LandsTypeWithPagination
| Name | Pad | Type | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Land |
SpacesTypeWithPagination
| Name | Pad | Type | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Space |
AssociatedSpacesTypeWithPagination
| Name | Pad | Type | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Space |