BuildingMinds DigitalTwin Core (Vorschau)
Die BuildingMinds Core Platform stellt REST-APIs bereit. Mit der BuildingMinds DigitalTwin Core-API können Sie die Digital Building Twin Masterdata wie Gebäude, Etagen und Räume sowie deren Eigenschaften lesen und auflisten.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Norm | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | BuildingMinds-Unterstützung |
| URL | https://buildingminds.com/services/customer-support |
| support@buildingminds.com |
| Connectormetadaten | |
|---|---|
| Herausgeber | BuildingMinds |
| Webseite | https://buildingminds.com/ |
| Datenschutzrichtlinie | https://buildingminds.com/privacy-policy |
| Kategorien | Daten |
Der BuildingMinds Digital Twin Core Connector verbindet alle Datenquellen über eine einzige zentrale Plattform. Verwenden Sie die BuildingMinds-Plattform als einzige Quelle der Wahrheit und aktualisieren Sie Ihre anderen Anwendungen mit genauen Informationen zu Standorten und Gebäuden mithilfe dieses Connectors.
Voraussetzungen
Sie benötigen ein Konto auf der BuildindMinds-Plattform und einen Benutzer mit entsprechender Autorisierung für die Verwendung des Connectors. Bitte kontaktieren Sie uns unter https://buildingminds.com/services/customer-support oder support@buildingminds.com.
Erste Schritte mit Ihrem Connector
Ein gängiger Anwendungsfall besteht darin, einen automatisierten Workflow zwischen dem BuildingMinds Digital Twin Core Connector und einem ERP-System einzurichten, um up-toAktuelle Daten Ihrer Gebäude zu erhalten.
Abrufen von Adressdaten für mehrere Gebäude
- Verwenden Sie die Aktion
GetBuildings, um die Stammdaten aller Gebäude abzurufen. Standardmäßig werden die ersten 20 Elemente in der Antwort angezeigt. Verwenden Sie zum Ändern des Standardwerts die Abfrageparameter$skipund$top. - Wählen Sie die verschiedenen Eigenschaften der Objektdaten aus, die Sie in das ERP-System übertragen möchten. Weitere Informationen finden Sie unter "Adressen" unter "Antworteigenschaften".
Abrufen von Adressdaten für ein bestimmtes Gebäude
- Rufen Sie die Gebäude-ID ab, für die Sie die Adressdaten mithilfe der Aktion
GetBuildingsabrufen möchten. - Verwenden Sie die Aktion
GetBuildingById. - Wählen Sie die Eigenschaften in der Antwort aus, die Sie übertragen möchten. Weitere Informationen finden Sie unter "Adressen" unter "Antworteigenschaften".
Abrufen aller Gebäude, die zu einem Portfolio gehören
- Rufen Sie die Portfolio-ID ab, für die Sie die zugehörigen Gebäude mithilfe der Aktion
GetPortfoliosabrufen möchten. - Verwenden Sie die Aktion
GetPortfolioById. - Wählen Sie die Antworteigenschaft
associatedBuildingIdsaus.
Antwort
Gebäude
Eigenschaften
| Name | Description |
|---|---|
id |
Eindeutiger Bezeichner für das Gebäude innerhalb der BuildingMinds-Plattform. |
type |
Objekttyp. In diesem Fall ist der Objekttyp ein Gebäude. |
tid |
Mandanten-ID |
title |
Gebäudename |
validFrom |
Datum, ab dem das Gebäude gültig ist. |
validTo |
Datum, bis zu dem das Gebäude gültig ist. |
changedBy |
Benutzer-ID des Benutzers, der das Gebäude geändert hat. |
changedOn |
Datum, an dem das Gebäude zuletzt geändert wurde. |
createdOn |
Datum, an dem das Gebäude erstellt wurde. |
internalId |
Vom Benutzer definierter Bezeichner. |
externalId |
Eindeutiger Bezeichner aus einem externen System, das als Drittanbieteranwendung in der BuildingMinds-Plattform verwendet wird. |
locationPath |
Enthält die id, typeund title der Website, zu der das Gebäude gehört. |
imageIds |
Wenn Bilder für das Gebäude hochgeladen werden, werden die Bildbezeichner angezeigt. |
parentId |
Bezeichner der Website, zu der das Gebäude gehört. |
typeOfBuilding |
Gebäudetyp wie Büro oder Wohngebäude. |
typeOfOwnership |
Art des Eigentums wie Freehold oder Part-Ownership. |
associatedLandIds |
Grundstücke, die mit diesem Gebäude verbunden sind. |
constructionYear |
Jahr, in dem das Gebäude gebaut wurde. |
grossArea |
Area-Objekt, das die Eigenschaften value, unitund metricValue. |
mainAddressExternalId |
Bezeichner für die Hauptadresse des Gebäudes, falls mehrere Adressen für dieses Gebäude gespeichert sind. |
addresses |
Objekt, das eine oder mehrere Adressen enthält. Weitere Informationen zu Adresseigenschaften finden Sie unter Adressen. |
parentHierarchies |
Ein benutzerdefiniertes Hierarchieelement, dem das Gebäude zugewiesen ist. |
Addresses
Eigenschaften
| Name | Description |
|---|---|
id |
Eindeutiger Bezeichner für das Gebäude innerhalb der BuildingMinds-Plattform. |
type |
Objekttyp. In diesem Fall ist der Objekttyp eine Adresse. |
tid |
Mandanten-ID |
externalId |
Eindeutiger Bezeichner aus einem externen System oder einer automatisch generierten ID für eine benutzerspezifische Änderung über die Benutzeroberfläche, z. B. eine verschobene Kartennadel. |
street |
Straßenname |
houseNumber |
Hausnummer |
postalCode |
Postleitzahl oder Postleitzahl |
city |
Stadt |
country |
Country |
changedBy |
Benutzer-ID des Benutzers, der die Adresse geändert hat. |
changedOn |
Datum, an dem die Adresse zuletzt geändert wurde. |
createdOn |
Datum, an dem die Adresse erstellt wurde. |
resolutionStatus |
Status, wenn die Auflösung der Adresse erfolgreich war. |
latitude |
Geokoordinaten der Adresse. |
longitude |
Geokoordinaten der Adresse. |
region |
Region |
continent |
Continent |
Portefeuille
Eigenschaften
| Name | Description |
|---|---|
id |
Eindeutiger Bezeichner für das Portfolio innerhalb der BuildingMinds-Plattform. |
type |
Objekttyp. In diesem Fall ist der Objekttyp ein Portfolio. |
createdOn |
Datum, an dem das Portfolio erstellt wurde. |
changedOn |
Datum, an dem das Portfolio zuletzt geändert wurde. |
changedBy |
Benutzer-ID des Benutzers, der das Portfolio geändert hat. |
title |
Portfolioname |
validFrom |
Datum, ab dem das Portfolio gültig ist. |
validTo |
Datum, bis zu dem das Portfolio gültig ist. |
owner |
Portfoliobesitzer |
buildingGrossArea |
Area-Objekt, das die Eigenschaften value, unitund metricValue für alle Gebäude des Portfolios enthält. |
landGrossArea |
Area-Objekt mit den Eigenschaften value, unit, und metricValue für alle Länder des Portfolios. |
internalId |
Vom Benutzer definierter Bezeichner. |
externalId |
Eindeutiger Bezeichner aus einem externen System, das als Drittanbieteranwendung in der BuildingMinds-Plattform verwendet wird. |
associatedBuildingIds |
Gebäude, die diesem Portfolio zugeordnet sind. |
associatedLandIds |
Grundstücke, die mit diesem Portfolio verbunden sind. |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abrufen aller Außenbereiche |
Abrufen aller outsideareas für die aktuell angemeldeten Mandanten des Benutzers |
| Abrufen aller Gebäude |
Abrufen aller Gebäude für die aktuell angemeldeten Mandanten des Benutzers |
| Abrufen aller Leerzeichen |
Abrufen aller Leerzeichen für die mandanten des aktuell angemeldeten Benutzers |
| Abrufen aller Portfolios |
Abrufen aller Portfolios für die aktuell angemeldeten Mandanten des Benutzers |
| Abrufen aller Unterbereiche |
Abrufen aller Unterbereiche für die mandanten des aktuell angemeldeten Benutzers |
| Abrufen aller Websites |
Abrufen aller Websites für die aktuell angemeldeten Mandanten des Benutzers |
| Abrufen der Liste der zugehörigen Entitäten |
Abrufen der Liste der Leerzeichen eines bestimmten Typs, die der bereitgestellten Raumentität zugeordnet sind |
| Abrufen der Liste nicht zugeordneter Entitäten |
Abrufen der Liste der Leerzeichen bestimmter Typen, die dem Leerzeichen eines anderen angegebenen Typs nicht zugeordnet sind |
| Alle Etagen abrufen |
Abrufen aller Etagen für die aktuell angemeldeten Mandanten des Benutzers |
| Alle Länder abrufen |
Abrufen aller Länder für die mandanten des aktuell angemeldeten Benutzers |
| Holen Sie sich alle Dächer |
Abrufen aller Dächer für die aktuell angemeldeten Mandanten des Benutzers |
| Holen Sie sich alle Fassaden |
Abrufen aller Fassaden für die aktuell angemeldeten Mandanten des Benutzers |
| Ruft die Informationen über das Vorhandensein von Kindern auf einem Außenbereich ab. |
Ruft die Informationen über das Vorhandensein von Kindern auf einem Außenbereich ab. |
| Ruft die Informationen über das Vorhandensein von Kindern auf einem Boden ab. |
Ruft die Informationen über das Vorhandensein von Kindern auf einem Boden ab. |
| Ruft die Informationen über das Vorhandensein von Kindern auf einem Dach ab |
Ruft die Informationen über das Vorhandensein von Kindern auf einem Dach ab |
| Ruft die Informationen über das Vorhandensein von Kindern auf einem Gebäude ab. |
Ruft die Informationen über das Vorhandensein von Kindern auf einem Gebäude ab. |
| Ruft die Informationen über das Vorhandensein von Kindern auf einem Land ab |
Ruft die Informationen über das Vorhandensein von Kindern auf einem Land ab |
| Ruft die Informationen über das Vorhandensein von Kindern auf einer Fassade ab. |
Ruft die Informationen über das Vorhandensein von Kindern auf einer Fassade ab. |
| Ruft die Informationen über das Vorhandensein von Kindern in einem Portfolios ab. |
Ruft die Informationen über das Vorhandensein von Kindern in einem Portfolios ab. |
| Ruft die Informationen über das Vorhandensein von untergeordneten Elementen auf einer Website ab. |
Ruft die Informationen über das Vorhandensein von untergeordneten Elementen auf einer Website ab. |
| Ruft die Informationen über das Vorhandensein von untergeordneten Elementen in einem Raum ab. |
Ruft die Informationen über das Vorhandensein von untergeordneten Elementen in einem Raum ab. |
| Ruft die Informationen über das Vorhandensein von untergeordneten Elementen in einem Unterbereich ab. |
Ruft die Informationen über das Vorhandensein von untergeordneten Elementen in einem Unterbereich ab. |
| Ruft ein Buidling mit der angegebenen ID ab. |
Ruft ein Gebäude mit der angegebenen ID ab |
| Ruft ein Dach mit der angegebenen ID ab |
Ruft ein Dach mit der angegebenen ID ab |
| Ruft ein Land mit der angegebenen ID ab |
Ruft ein Land mit der angegebenen ID ab |
| Ruft ein Leerzeichen mit der angegebenen ID ab. |
Ruft ein Leerzeichen mit der angegebenen ID ab. |
| Ruft ein Portfolio mit der angegebenen ID ab. |
Ruft ein Portfolio mit der angegebenen ID ab. |
| Ruft eine Fassade mit der angegebenen ID ab. |
Ruft eine Fassade mit der angegebenen ID ab. |
| Ruft eine Website mit der angegebenen ID ab. |
Ruft eine Website mit der angegebenen ID ab. |
| Ruft einen Boden mit der angegebenen ID ab. |
Ruft einen Boden mit der angegebenen ID ab. |
| Ruft einen outsidearea mit der angegebenen ID ab. |
Ruft einen outsidearea mit der angegebenen ID ab. |
| Ruft einen Unterbereich mit der angegebenen ID ab. |
Ruft einen Unterbereich mit der angegebenen ID ab. |
Abrufen aller Außenbereiche
Abrufen aller outsideareas für die aktuell angemeldeten Mandanten des Benutzers
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Stopp!
|
$top | string |
Dieser Parameter wird für die Paginierung verwendet und bestimmt die maximale Anzahl von Elementen, die aus dem Back-End zurückgegeben werden müssen. Der Standardwert ist 20. |
|
|
Überspringen
|
$skip | string |
Dieser Parameter wird für die Paginierung verwendet und markiert den Ausgangspunkt der Aufnahme der Elemente. Der Standardwert ist 0. |
Gibt zurück
Abrufen aller Gebäude
Abrufen aller Gebäude für die aktuell angemeldeten Mandanten des Benutzers
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Stopp!
|
$top | string |
Dieser Parameter wird für die Paginierung verwendet und bestimmt die maximale Anzahl von Elementen, die aus dem Back-End zurückgegeben werden müssen. Der Standardwert ist 20. |
|
|
Überspringen
|
$skip | string |
Dieser Parameter wird für die Paginierung verwendet und markiert den Ausgangspunkt der Aufnahme der Elemente. Der Standardwert ist 0. |
Gibt zurück
Abrufen aller Leerzeichen
Abrufen aller Leerzeichen für die mandanten des aktuell angemeldeten Benutzers
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Stopp!
|
$top | string |
Dieser Parameter wird für die Paginierung verwendet und bestimmt die maximale Anzahl von Elementen, die aus dem Back-End zurückgegeben werden müssen. Der Standardwert ist 20. |
|
|
Überspringen
|
$skip | string |
Dieser Parameter wird für die Paginierung verwendet und markiert den Ausgangspunkt der Aufnahme der Elemente. Der Standardwert ist 0. |
Gibt zurück
Abrufen aller Portfolios
Abrufen aller Portfolios für die aktuell angemeldeten Mandanten des Benutzers
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Stopp!
|
$top | string |
Dieser Parameter wird für die Paginierung verwendet und bestimmt die maximale Anzahl von Elementen, die aus dem Back-End zurückgegeben werden müssen. Der Standardwert ist 20. |
|
|
Überspringen
|
$skip | string |
Dieser Parameter wird für die Paginierung verwendet und markiert den Ausgangspunkt der Aufnahme der Elemente. Der Standardwert ist 0. |
Gibt zurück
Abrufen aller Unterbereiche
Abrufen aller Unterbereiche für die mandanten des aktuell angemeldeten Benutzers
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Stopp!
|
$top | string |
Dieser Parameter wird für die Paginierung verwendet und bestimmt die maximale Anzahl von Elementen, die aus dem Back-End zurückgegeben werden müssen. Der Standardwert ist 20. |
|
|
Überspringen
|
$skip | string |
Dieser Parameter wird für die Paginierung verwendet und markiert den Ausgangspunkt der Aufnahme der Elemente. Der Standardwert ist 0. |
Gibt zurück
Abrufen aller Websites
Abrufen aller Websites für die aktuell angemeldeten Mandanten des Benutzers
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Stopp!
|
$top | string |
Dieser Parameter wird für die Paginierung verwendet und bestimmt die maximale Anzahl von Elementen, die aus dem Back-End zurückgegeben werden müssen. Der Standardwert ist 20. |
|
|
Überspringen
|
$skip | string |
Dieser Parameter wird für die Paginierung verwendet und markiert den Ausgangspunkt der Aufnahme der Elemente. Der Standardwert ist 0. |
Gibt zurück
Abrufen der Liste der zugehörigen Entitäten
Abrufen der Liste der Leerzeichen eines bestimmten Typs, die der bereitgestellten Raumentität zugeordnet sind
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Leerzeichentyp
|
spaceType | True | string |
Beschreibt die Art des Raums. |
|
Leerzeichen-ID
|
id | True | string |
Format - uuid. Eindeutiger Leerraumbezeichner |
|
Zugeordneter Typ
|
associatedType | True | string |
Beschreibt die Art des zugeordneten Raums. |
|
Überspringen
|
$skip | string |
Dieser Parameter wird für die Paginierung verwendet und markiert den Ausgangspunkt der Aufnahme der Elemente. Der Standardwert ist 0. |
|
|
Stopp!
|
$top | string |
Dieser Parameter wird für die Paginierung verwendet und bestimmt die maximale Anzahl von Elementen, die aus dem Back-End zurückgegeben werden müssen. Der Standardwert ist 20. |
Gibt zurück
Abrufen der Liste nicht zugeordneter Entitäten
Abrufen der Liste der Leerzeichen bestimmter Typen, die dem Leerzeichen eines anderen angegebenen Typs nicht zugeordnet sind
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Leerzeichentyp
|
spaceType | True | string |
Beschreibt die Art des Raums. |
|
Zugeordneter Typ
|
associatedType | True | string |
Beschreibt die Art des zugeordneten Raums. |
|
Leerzeichen-ID-Abfrage
|
spaceid | string |
Format - uuid. Optionaler Bezeichner des zugeordneten Leerraums, der in die Ergebnisse eingeschlossen werden soll |
Alle Etagen abrufen
Abrufen aller Etagen für die aktuell angemeldeten Mandanten des Benutzers
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Stopp!
|
$top | string |
Dieser Parameter wird für die Paginierung verwendet und bestimmt die maximale Anzahl von Elementen, die aus dem Back-End zurückgegeben werden müssen. Der Standardwert ist 20. |
|
|
Überspringen
|
$skip | string |
Dieser Parameter wird für die Paginierung verwendet und markiert den Ausgangspunkt der Aufnahme der Elemente. Der Standardwert ist 0. |
Gibt zurück
Alle Länder abrufen
Abrufen aller Länder für die mandanten des aktuell angemeldeten Benutzers
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Stopp!
|
$top | string |
Dieser Parameter wird für die Paginierung verwendet und bestimmt die maximale Anzahl von Elementen, die aus dem Back-End zurückgegeben werden müssen. Der Standardwert ist 20. |
|
|
Überspringen
|
$skip | string |
Dieser Parameter wird für die Paginierung verwendet und markiert den Ausgangspunkt der Aufnahme der Elemente. Der Standardwert ist 0. |
Gibt zurück
Holen Sie sich alle Dächer
Abrufen aller Dächer für die aktuell angemeldeten Mandanten des Benutzers
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Stopp!
|
$top | string |
Dieser Parameter wird für die Paginierung verwendet und bestimmt die maximale Anzahl von Elementen, die aus dem Back-End zurückgegeben werden müssen. Der Standardwert ist 20. |
|
|
Überspringen
|
$skip | string |
Dieser Parameter wird für die Paginierung verwendet und markiert den Ausgangspunkt der Aufnahme der Elemente. Der Standardwert ist 0. |
Gibt zurück
Holen Sie sich alle Fassaden
Abrufen aller Fassaden für die aktuell angemeldeten Mandanten des Benutzers
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Stopp!
|
$top | string |
Dieser Parameter wird für die Paginierung verwendet und bestimmt die maximale Anzahl von Elementen, die aus dem Back-End zurückgegeben werden müssen. Der Standardwert ist 20. |
|
|
Überspringen
|
$skip | string |
Dieser Parameter wird für die Paginierung verwendet und markiert den Ausgangspunkt der Aufnahme der Elemente. Der Standardwert ist 0. |
Gibt zurück
Ruft die Informationen über das Vorhandensein von Kindern auf einem Außenbereich ab.
Ruft die Informationen über das Vorhandensein von Kindern auf einem Außenbereich ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Leerzeichen-ID
|
id | True | string |
Format - uuid. Eindeutiger Leerraumbezeichner |
Ruft die Informationen über das Vorhandensein von Kindern auf einem Boden ab.
Ruft die Informationen über das Vorhandensein von Kindern auf einem Boden ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Leerzeichen-ID
|
id | True | string |
Format - uuid. Eindeutiger Leerraumbezeichner |
Ruft die Informationen über das Vorhandensein von Kindern auf einem Dach ab
Ruft die Informationen über das Vorhandensein von Kindern auf einem Dach ab
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Leerzeichen-ID
|
id | True | string |
Format - uuid. Eindeutiger Leerraumbezeichner |
Ruft die Informationen über das Vorhandensein von Kindern auf einem Gebäude ab.
Ruft die Informationen über das Vorhandensein von Kindern auf einem Gebäude ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Leerzeichen-ID
|
id | True | string |
Format - uuid. Eindeutiger Leerraumbezeichner |
Ruft die Informationen über das Vorhandensein von Kindern auf einem Land ab
Ruft die Informationen über das Vorhandensein von Kindern auf einem Land ab
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Leerzeichen-ID
|
id | True | string |
Format - uuid. Eindeutiger Leerraumbezeichner |
Ruft die Informationen über das Vorhandensein von Kindern auf einer Fassade ab.
Ruft die Informationen über das Vorhandensein von Kindern auf einer Fassade ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Leerzeichen-ID
|
id | True | string |
Format - uuid. Eindeutiger Leerraumbezeichner |
Ruft die Informationen über das Vorhandensein von Kindern in einem Portfolios ab.
Ruft die Informationen über das Vorhandensein von Kindern in einem Portfolios ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Leerzeichen-ID
|
id | True | string |
Format - uuid. Eindeutiger Leerraumbezeichner |
Ruft die Informationen über das Vorhandensein von untergeordneten Elementen auf einer Website ab.
Ruft die Informationen über das Vorhandensein von untergeordneten Elementen auf einer Website ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Leerzeichen-ID
|
id | True | string |
Format - uuid. Eindeutiger Leerraumbezeichner |
Ruft die Informationen über das Vorhandensein von untergeordneten Elementen in einem Raum ab.
Ruft die Informationen über das Vorhandensein von untergeordneten Elementen in einem Raum ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Leerzeichen-ID
|
id | True | string |
Format - uuid. Eindeutiger Leerraumbezeichner |
Ruft die Informationen über das Vorhandensein von untergeordneten Elementen in einem Unterbereich ab.
Ruft die Informationen über das Vorhandensein von untergeordneten Elementen in einem Unterbereich ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Leerzeichen-ID
|
id | True | string |
Format - uuid. Eindeutiger Leerraumbezeichner |
Ruft ein Buidling mit der angegebenen ID ab.
Ruft ein Gebäude mit der angegebenen ID ab
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Leerzeichen-ID
|
id | True | string |
Format - uuid. Eindeutiger Leerraumbezeichner |
Gibt zurück
- Body
- Building
Ruft ein Dach mit der angegebenen ID ab
Ruft ein Dach mit der angegebenen ID ab
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Leerzeichen-ID
|
id | True | string |
Format - uuid. Eindeutiger Leerraumbezeichner |
Gibt zurück
- Body
- Roof
Ruft ein Land mit der angegebenen ID ab
Ruft ein Land mit der angegebenen ID ab
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Leerzeichen-ID
|
id | True | string |
Format - uuid. Eindeutiger Leerraumbezeichner |
Gibt zurück
- Body
- Land
Ruft ein Leerzeichen mit der angegebenen ID ab.
Ruft ein Leerzeichen mit der angegebenen ID ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Leerzeichen-ID
|
id | True | string |
Format - uuid. Eindeutiger Leerraumbezeichner |
Gibt zurück
- Body
- Space
Ruft ein Portfolio mit der angegebenen ID ab.
Ruft ein Portfolio mit der angegebenen ID ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Leerzeichen-ID
|
id | True | string |
Format - uuid. Eindeutiger Leerraumbezeichner |
Gibt zurück
- Body
- Portfolio
Ruft eine Fassade mit der angegebenen ID ab.
Ruft eine Fassade mit der angegebenen ID ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Leerzeichen-ID
|
id | True | string |
Format - uuid. Eindeutiger Leerraumbezeichner |
Gibt zurück
- Body
- Facade
Ruft eine Website mit der angegebenen ID ab.
Ruft eine Website mit der angegebenen ID ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Leerzeichen-ID
|
id | True | string |
Format - uuid. Eindeutiger Leerraumbezeichner |
Gibt zurück
- Body
- Site
Ruft einen Boden mit der angegebenen ID ab.
Ruft einen Boden mit der angegebenen ID ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Leerzeichen-ID
|
id | True | string |
Format - uuid. Eindeutiger Leerraumbezeichner |
Gibt zurück
- Body
- Floor
Ruft einen outsidearea mit der angegebenen ID ab.
Ruft einen outsidearea mit der angegebenen ID ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Leerzeichen-ID
|
id | True | string |
Format - uuid. Eindeutiger Leerraumbezeichner |
Gibt zurück
- Body
- Outsidearea
Ruft einen Unterbereich mit der angegebenen ID ab.
Ruft einen Unterbereich mit der angegebenen ID ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Leerzeichen-ID
|
id | True | string |
Format - uuid. Eindeutiger Leerraumbezeichner |
Gibt zurück
- Body
- Subarea
Definitionen
CurrencyValueType
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
value
|
value | number | |
|
Einheit
|
unit | string |
AreaValueType
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
value
|
value | number | |
|
Einheit
|
unit | string | |
|
metricWert
|
metricValue | number |
LocationPathType
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string | |
|
title
|
title | string | |
|
type
|
type | string |
LocationPathArrayType
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gegenstände
|
LocationPathType |
SpaceTypeOfUseEnum
OutsideAreaType
EntityType
SpaceTypeOfOwnership
Adresstyp
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | uuid |
sollte in POST/PUT-Anforderungen für vorhandene Adressen nur in den Fällen definiert werden, in dem vorhandene Adresse hier anstelle des IDs-Arrays hinzugefügt wurde. |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Nur Lesen |
|
changedBy
|
changedBy | string |
Nur Lesen |
|
Straße
|
street | string | |
|
houseNumber
|
houseNumber | string | |
|
postalCode
|
postalCode | string | |
|
city
|
city | string | |
|
country
|
country | string |
ISO 3166-1 Alpha-3 Ländercodes, z. B. CAN, USA, DEU |
|
region
|
region | string | |
|
timeZone
|
timeZone | string | |
|
Briefkasten
|
postBox | string | |
|
postBoxPostCode
|
postBoxPostCode | string | |
|
phone
|
phone | string | |
|
externalId
|
externalId | uuid |
Externe Adress-ID sollte beim Erstellen einer neuen Adresse auf clientseitiger Seite generiert werden. |
|
latitude
|
latitude | float |
Laditiude-Koordinate für Adresse |
|
longitude
|
longitude | float |
Längengradkoordinate für Adresse |
Portefeuille
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Nur Lesen |
|
changedBy
|
changedBy | string |
Nur Lesen |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
tid
|
tid | uuid |
Mandantenbezeichner |
|
title
|
title | string | |
|
Beschreibung
|
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 | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Nur Lesen |
|
changedBy
|
changedBy | string |
Nur Lesen |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
tid
|
tid | uuid |
Mandantenbezeichner |
|
title
|
title | string | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
buildingGrossArea
|
buildingGrossArea | AreaValueType | |
|
outsideareaGrossArea
|
outsideareaGrossArea | AreaValueType | |
|
mainAddressExternalId
|
mainAddressExternalId | uuid |
"externalId" einer der Adressen aus der linkedAddresses-Auflistung sollte hier platziert werden, um den Adresshaupttyp zu erstellen. |
|
Adressen
|
addresses | array of AddressType | |
|
typeOfSite
|
typeOfSite | SpaceTypeOfUseEnum | |
|
imageIds
|
imageIds | array of uuid | |
|
internalId
|
internalId | uuid | |
|
furtherInformation
|
furtherInformation | string |
Gebäude
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Nur Lesen |
|
changedBy
|
changedBy | string |
Nur Lesen |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
tid
|
tid | uuid |
Mandantenbezeichner |
|
associatedPortfolioId
|
associatedPortfolioId | uuid | |
|
parentId
|
parentId | uuid | |
|
associatedLandIds
|
associatedLandIds | array of uuid | |
|
title
|
title | string | |
|
internalId
|
internalId | uuid | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
Adressen
|
addresses | array of AddressType | |
|
responsiblePeopleFullName
|
responsiblePeopleFullName | string | |
|
typeOfOwnership
|
typeOfOwnership | SpaceTypeOfOwnership | |
|
typeOfBuilding
|
typeOfBuilding | string | |
|
imageIds
|
imageIds | array of uuid | |
|
furtherInformation
|
furtherInformation | string | |
|
Baujahr
|
constructionYear | date | |
|
yearOfLastRefurbishment
|
yearOfLastRefurbishment | date | |
|
grossArea
|
grossArea | AreaValueType | |
|
buildingPurchaseCost
|
buildingPurchaseCost | CurrencyValueType | |
|
hasMonumentProtection
|
hasMonumentProtection | boolean | |
|
numberOfFloors
|
numberOfFloors | integer | |
|
numberOf BasementFloors
|
numberOf BasementFloors | integer |
Untergrenze
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Nur Lesen |
|
changedBy
|
changedBy | string |
Nur Lesen |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
tid
|
tid | uuid |
Mandantenbezeichner |
|
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 | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Nur Lesen |
|
changedBy
|
changedBy | string |
Nur Lesen |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
tid
|
tid | uuid |
Mandantenbezeichner |
|
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 |
Dach
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Nur Lesen |
|
changedBy
|
changedBy | string |
Nur Lesen |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
tid
|
tid | uuid |
Mandantenbezeichner |
|
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 |
Fassade
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Nur Lesen |
|
changedBy
|
changedBy | string |
Nur Lesen |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
tid
|
tid | uuid |
Mandantenbezeichner |
|
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 | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Nur Lesen |
|
changedBy
|
changedBy | string |
Nur Lesen |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
tid
|
tid | uuid |
Mandantenbezeichner |
|
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 | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Nur Lesen |
|
changedBy
|
changedBy | string |
Nur Lesen |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
tid
|
tid | uuid |
Mandantenbezeichner |
|
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 |
Teilbereich
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Nur Lesen |
|
changedBy
|
changedBy | string |
Nur Lesen |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
tid
|
tid | uuid |
Mandantenbezeichner |
|
title
|
title | string | |
|
parentId
|
parentId | uuid | |
|
internalId
|
internalId | uuid | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
furtherInformation
|
furtherInformation | string |
PortfolioTypeWithPagination
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Portfolio |
SiteTypeWithPagination
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Site |
BuildingTypeWithPagination
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Building |
FloorTypeWithPagination
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Floor |
RoofsTypeWithPagination
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Roof |
FassadenTypeWithPagination
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Facade |
OutsideareasTypeWithPagination
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Outsidearea |
SubareasTypeWithPagination
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Subarea |
LandsTypeWithPagination
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Land |
SpacesTypeWithPagination
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Space |
AssociatedSpacesTypeWithPagination
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Space |