BuildingMinds DigitalTwin Core (wersja zapoznawcza)
Platforma BuildingMinds Core udostępnia interfejsy API REST. Za pomocą interfejsu API BuildingMinds DigitalTwin Core można odczytywać i wyświetlać listę danych masterdata usługi Digital Building Twin, takich jak budynki, podłogi i przestrzenie oraz ich właściwości.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt | |
|---|---|
| Name | Obsługa narzędzia BuildingMinds |
| adres URL | https://buildingminds.com/services/customer-support |
| support@buildingminds.com |
| Metadane łącznika | |
|---|---|
| Publisher | BuildingMinds |
| Witryna internetowa | https://buildingminds.com/ |
| Zasady ochrony prywatności | https://buildingminds.com/privacy-policy |
| Kategorie | Dane |
Łącznik BuildingMinds Digital Twin Core łączy wszystkie źródła danych za pośrednictwem jednej, scentralizowanej platformy. Użyj platformy BuildingMinds jako pojedynczego źródła prawdy i zaktualizuj inne aplikacje z dokładnymi informacjami na temat lokacji i budynków przy użyciu tego łącznika.
Wymagania wstępne
Potrzebujesz konta na platformie BuildindMinds i użytkownik z odpowiednią autoryzacją do korzystania z łącznika. Skontaktuj się z nami pod adresem https://buildingminds.com/services/customer-support lub support@buildingminds.com.
Wprowadzenie do łącznika
Typowy przypadek użycia polega na skonfigurowaniu zautomatyzowanego przepływu pracy między łącznikiem BuildingMinds Digital Twin Core Connector i systemem ERP w celu uzyskania up-todanych dotyczących budynków.
Pobieranie danych adresowych dla kilku budynków
- Aby uzyskać dane główne wszystkich budynków, użyj akcji
GetBuildings. Domyślnie pierwsze 20 elementów jest wyświetlanych w odpowiedzi. Aby zmienić wartość domyślną, użyj parametrów$skipzapytania i$top. - Wybierz różne właściwości danych obiektu, które mają zostać przeniesione do systemu ERP. Aby uzyskać więcej informacji, zobacz Właściwości odpowiedzi w obszarze Adresy.
Pobieranie danych adresowych dla określonego budynku
- Pobierz identyfikator budynku, dla którego chcesz uzyskać dane adresu przy użyciu akcji
GetBuildings. - Użyj akcji
GetBuildingById. - Wybierz właściwości w odpowiedzi, którą chcesz przenieść. Aby uzyskać więcej informacji, zobacz Właściwości odpowiedzi w obszarze Adresy.
Pobieranie wszystkich budynków należących do portfela
- Pobierz identyfikator portfela, dla którego chcesz uzyskać skojarzone budynki przy użyciu akcji
GetPortfolios. - Użyj akcji
GetPortfolioById. - Wybierz właściwość
associatedBuildingIdsodpowiedzi .
Odpowiedź
Budowla
Właściwości
| Name | Description |
|---|---|
id |
Unikatowy identyfikator budynku na platformie BuildingMinds. |
type |
Typ obiektu. W tym przypadku typ obiektu to budynek. |
tid |
Identyfikator dzierżawy |
title |
Nazwa budynku |
validFrom |
Data, z której budynek jest prawidłowy. |
validTo |
Data, do której budynek jest prawidłowy. |
changedBy |
Identyfikator użytkownika, który zmienił budynek. |
changedOn |
Data ostatniej zmiany budynku. |
createdOn |
Data utworzenia budynku. |
internalId |
Identyfikator zdefiniowany przez użytkownika. |
externalId |
Unikatowy identyfikator systemu zewnętrznego używany jako aplikacja innej firmy na platformie BuildingMinds. |
locationPath |
Zawiera obiekt id, typei title lokację, do której należy budynek. |
imageIds |
Po przekazaniu obrazów do budynku są wyświetlane identyfikatory obrazów. |
parentId |
Identyfikator lokacji, do której należy budynek. |
typeOfBuilding |
Typ budynku, taki jak Office lub Residential. |
typeOfOwnership |
Typ własności, taki jak Freehold lub Part-ownership. |
associatedLandIds |
Grunty związane z tym budynkiem. |
constructionYear |
Rok, kiedy budynek został zbudowany. |
grossArea |
Obiekt warstwowy zawierający właściwości value, uniti metricValue. |
mainAddressExternalId |
Identyfikator głównego adresu budynku w przypadku zapisania kilku adresów dla tego budynku. |
addresses |
Obiekt zawierający jeden lub kilka adresów. Aby uzyskać więcej informacji na temat właściwości adresu, zobacz Adresy. |
parentHierarchies |
Niestandardowy element hierarchii, do którego przypisano budynek. |
Adresy
Właściwości
| Name | Description |
|---|---|
id |
Unikatowy identyfikator budynku na platformie BuildingMinds. |
type |
Typ obiektu. W takim przypadku typ obiektu jest adresem. |
tid |
Identyfikator dzierżawy |
externalId |
Unikatowy identyfikator z systemu zewnętrznego lub automatycznie wygenerowany identyfikator zmiany specyficznej dla użytkownika w interfejsie użytkownika, na przykład przeniesiony numer PIN mapy. |
street |
Nazwa ulicy |
houseNumber |
Numer domu |
postalCode |
Kod pocztowy lub kod pocztowy |
city |
Miejscowość |
country |
Country |
changedBy |
Identyfikator użytkownika, który zmienił adres. |
changedOn |
Data ostatniej zmiany adresu. |
createdOn |
Data utworzenia adresu. |
resolutionStatus |
Stan, jeśli rozpoznawanie adresu zakończyło się pomyślnie. |
latitude |
Współrzędne geograficzne adresu. |
longitude |
Współrzędne geograficzne adresu. |
region |
Region |
continent |
Continent |
Portfolio
Właściwości
| Name | Description |
|---|---|
id |
Unikatowy identyfikator portfela na platformie BuildingMinds. |
type |
Typ obiektu. W takim przypadku typ obiektu jest portfelem. |
createdOn |
Data utworzenia portfela. |
changedOn |
Data ostatniej zmiany portfela. |
changedBy |
Identyfikator użytkownika, który zmienił portfolio. |
title |
Nazwa portfela |
validFrom |
Data, z której portfolio jest prawidłowe. |
validTo |
Data, do której portfolio jest prawidłowe. |
owner |
Właściciel portfela |
buildingGrossArea |
Obiekt obszaru zawierający właściwości value, uniti metricValue dla wszystkich budynków portfela. |
landGrossArea |
Obiekt obszaru zawierający właściwości value, uniti metricValue dla wszystkich gruntów portfela. |
internalId |
Identyfikator zdefiniowany przez użytkownika. |
externalId |
Unikatowy identyfikator systemu zewnętrznego używany jako aplikacja innej firmy na platformie BuildingMinds. |
associatedBuildingIds |
Budynki, które są skojarzone z tym portfelem. |
associatedLandIds |
Ziemie powiązane z tym portfelem. |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Pobiera buidling z danym identyfikatorem |
Pobiera budynek z danym identyfikatorem |
| Pobiera dach z danym identyfikatorem |
Pobiera dach z danym identyfikatorem |
| Pobiera fasadę z danym identyfikatorem |
Pobiera fasadę z danym identyfikatorem |
| Pobiera informacje o istnieniu dzieci na dachu |
Pobiera informacje o istnieniu dzieci na dachu |
| Pobiera informacje o istnieniu dzieci na fasadzie |
Pobiera informacje o istnieniu dzieci na fasadzie |
| Pobiera informacje o istnieniu dzieci na obszarze zewnętrznym |
Pobiera informacje o istnieniu dzieci na obszarze zewnętrznym |
| Pobiera informacje o istnieniu dzieci na podłodze |
Pobiera informacje o istnieniu dzieci na podłodze |
| Pobiera informacje o istnieniu dzieci na ziemi |
Pobiera informacje o istnieniu dzieci na ziemi |
| Pobiera informacje o istnieniu dzieci w budynku |
Pobiera informacje o istnieniu dzieci w budynku |
| Pobiera informacje o istnieniu dzieci w portfolio |
Pobiera informacje o istnieniu dzieci w portfolio |
| Pobiera informacje o istnieniu dzieci w przestrzeni |
Pobiera informacje o istnieniu dzieci w przestrzeni |
| Pobiera informacje o istnieniu dzieci w witrynie |
Pobiera informacje o istnieniu dzieci w witrynie |
| Pobiera informacje o istnieniu elementów podrzędnych w obszarze podrzędnym |
Pobiera informacje o istnieniu elementów podrzędnych w obszarze podrzędnym |
| Pobiera miejsce z danym identyfikatorem |
Pobiera miejsce z danym identyfikatorem |
| Pobiera obszar podrzędny z danym identyfikatorem |
Pobiera obszar podrzędny z danym identyfikatorem |
| Pobiera obszar zewnętrzny z danym identyfikatorem |
Pobiera obszar zewnętrzny z danym identyfikatorem |
| Pobiera podłogę z danym identyfikatorem |
Pobiera podłogę z danym identyfikatorem |
| Pobiera portfel z danym identyfikatorem |
Pobiera portfel z danym identyfikatorem |
| Pobiera witrynę z danym identyfikatorem |
Pobiera witrynę z danym identyfikatorem |
| Pobiera ziemię z danym identyfikatorem |
Pobiera ziemię z danym identyfikatorem |
| Pobieranie listy niezwiązanych jednostek |
Pobierz listę spacji określonego typu, które nie są skojarzone z przestrzenią innego typu dostarczonego |
| Pobieranie listy skojarzonych jednostek |
Pobieranie listy spacji określonego typu skojarzonego z podaną jednostką spacji |
| Pobieranie wszystkich budynków |
Pobieranie wszystkich budynków dla aktualnie zalogowanych dzierżawców użytkownika |
| Pobieranie wszystkich obszarów podrzędnych |
Pobieranie wszystkich obszarów podrzędnych dla aktualnie zalogowanych dzierżaw użytkowników |
| Pobieranie wszystkich obszarów zewnętrznych |
Pobieranie wszystkich obszarów zewnętrznych dla aktualnie zalogowanych dzierżaw użytkowników |
| Pobieranie wszystkich portfeli |
Pobieranie wszystkich portfeli aktualnie zalogowanych dzierżaw użytkowników |
| Pobieranie wszystkich spacji |
Pobieranie wszystkich miejsc dla aktualnie zalogowanych dzierżaw użytkowników |
| Pobieranie wszystkich witryn |
Pobieranie wszystkich witryn dla aktualnie zalogowanych dzierżaw użytkowników |
| Pobierz wszystkie dachy |
Pobieranie wszystkich dachów dla aktualnie zalogowanych dzierżaw użytkowników |
| Pobierz wszystkie fasady |
Pobieranie wszystkich fasad dla aktualnie zalogowanych dzierżaw użytkownika |
| Pobierz wszystkie podłogi |
Pobieranie wszystkich podłóg dla aktualnie zalogowanych dzierżaw użytkowników |
| Pobierz wszystkie ziemie |
Pobierz wszystkie ziemie dla aktualnie zalogowanych dzierżaw użytkowników |
Pobiera buidling z danym identyfikatorem
Pobiera budynek z danym identyfikatorem
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator miejsca
|
id | True | string |
Format — uuid. Unikatowy identyfikator spacji |
Zwraca
- Body
- Building
Pobiera dach z danym identyfikatorem
Pobiera dach z danym identyfikatorem
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator miejsca
|
id | True | string |
Format — uuid. Unikatowy identyfikator spacji |
Zwraca
- Body
- Roof
Pobiera fasadę z danym identyfikatorem
Pobiera fasadę z danym identyfikatorem
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator miejsca
|
id | True | string |
Format — uuid. Unikatowy identyfikator spacji |
Zwraca
- Body
- Facade
Pobiera informacje o istnieniu dzieci na dachu
Pobiera informacje o istnieniu dzieci na dachu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator miejsca
|
id | True | string |
Format — uuid. Unikatowy identyfikator spacji |
Pobiera informacje o istnieniu dzieci na fasadzie
Pobiera informacje o istnieniu dzieci na fasadzie
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator miejsca
|
id | True | string |
Format — uuid. Unikatowy identyfikator spacji |
Pobiera informacje o istnieniu dzieci na obszarze zewnętrznym
Pobiera informacje o istnieniu dzieci na obszarze zewnętrznym
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator miejsca
|
id | True | string |
Format — uuid. Unikatowy identyfikator spacji |
Pobiera informacje o istnieniu dzieci na podłodze
Pobiera informacje o istnieniu dzieci na podłodze
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator miejsca
|
id | True | string |
Format — uuid. Unikatowy identyfikator spacji |
Pobiera informacje o istnieniu dzieci na ziemi
Pobiera informacje o istnieniu dzieci na ziemi
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator miejsca
|
id | True | string |
Format — uuid. Unikatowy identyfikator spacji |
Pobiera informacje o istnieniu dzieci w budynku
Pobiera informacje o istnieniu dzieci w budynku
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator miejsca
|
id | True | string |
Format — uuid. Unikatowy identyfikator spacji |
Pobiera informacje o istnieniu dzieci w portfolio
Pobiera informacje o istnieniu dzieci w portfolio
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator miejsca
|
id | True | string |
Format — uuid. Unikatowy identyfikator spacji |
Pobiera informacje o istnieniu dzieci w przestrzeni
Pobiera informacje o istnieniu dzieci w przestrzeni
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator miejsca
|
id | True | string |
Format — uuid. Unikatowy identyfikator spacji |
Pobiera informacje o istnieniu dzieci w witrynie
Pobiera informacje o istnieniu dzieci w witrynie
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator miejsca
|
id | True | string |
Format — uuid. Unikatowy identyfikator spacji |
Pobiera informacje o istnieniu elementów podrzędnych w obszarze podrzędnym
Pobiera informacje o istnieniu elementów podrzędnych w obszarze podrzędnym
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator miejsca
|
id | True | string |
Format — uuid. Unikatowy identyfikator spacji |
Pobiera miejsce z danym identyfikatorem
Pobiera miejsce z danym identyfikatorem
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator miejsca
|
id | True | string |
Format — uuid. Unikatowy identyfikator spacji |
Zwraca
- Body
- Space
Pobiera obszar podrzędny z danym identyfikatorem
Pobiera obszar podrzędny z danym identyfikatorem
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator miejsca
|
id | True | string |
Format — uuid. Unikatowy identyfikator spacji |
Zwraca
- Body
- Subarea
Pobiera obszar zewnętrzny z danym identyfikatorem
Pobiera obszar zewnętrzny z danym identyfikatorem
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator miejsca
|
id | True | string |
Format — uuid. Unikatowy identyfikator spacji |
Zwraca
- Body
- Outsidearea
Pobiera podłogę z danym identyfikatorem
Pobiera podłogę z danym identyfikatorem
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator miejsca
|
id | True | string |
Format — uuid. Unikatowy identyfikator spacji |
Zwraca
- Body
- Floor
Pobiera portfel z danym identyfikatorem
Pobiera portfel z danym identyfikatorem
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator miejsca
|
id | True | string |
Format — uuid. Unikatowy identyfikator spacji |
Zwraca
- Body
- Portfolio
Pobiera witrynę z danym identyfikatorem
Pobiera witrynę z danym identyfikatorem
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator miejsca
|
id | True | string |
Format — uuid. Unikatowy identyfikator spacji |
Zwraca
- Body
- Site
Pobiera ziemię z danym identyfikatorem
Pobiera ziemię z danym identyfikatorem
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator miejsca
|
id | True | string |
Format — uuid. Unikatowy identyfikator spacji |
Zwraca
- Body
- Land
Pobieranie listy niezwiązanych jednostek
Pobierz listę spacji określonego typu, które nie są skojarzone z przestrzenią innego typu dostarczonego
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Typ spacji
|
spaceType | True | string |
Opisuje rodzaj miejsca |
|
Skojarzony typ
|
associatedType | True | string |
Opisuje rodzaj skojarzonej przestrzeni |
|
Zapytanie o identyfikator obszaru
|
spaceid | string |
Format — uuid. Opcjonalny identyfikator skojarzonego miejsca do uwzględnienia w wynikach |
Pobieranie listy skojarzonych jednostek
Pobieranie listy spacji określonego typu skojarzonego z podaną jednostką spacji
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Typ spacji
|
spaceType | True | string |
Opisuje rodzaj miejsca |
|
Identyfikator miejsca
|
id | True | string |
Format — uuid. Unikatowy identyfikator spacji |
|
Skojarzony typ
|
associatedType | True | string |
Opisuje rodzaj skojarzonej przestrzeni |
|
Pomiń
|
$skip | string |
Ten parametr jest używany do stronicowania i oznacza punkt początkowy przyjmowania elementów. Wartość domyślna to 0 |
|
|
Zatrzymaj
|
$top | string |
Ten parametr jest używany do stronicowania i określa maksymalną liczbę elementów, które muszą być zwracane z zaplecza. Wartość domyślna to 20. |
Zwraca
Pobieranie wszystkich budynków
Pobieranie wszystkich budynków dla aktualnie zalogowanych dzierżawców użytkownika
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Zatrzymaj
|
$top | string |
Ten parametr jest używany do stronicowania i określa maksymalną liczbę elementów, które muszą być zwracane z zaplecza. Wartość domyślna to 20. |
|
|
Pomiń
|
$skip | string |
Ten parametr jest używany do stronicowania i oznacza punkt początkowy przyjmowania elementów. Wartość domyślna to 0 |
Zwraca
Pobieranie wszystkich obszarów podrzędnych
Pobieranie wszystkich obszarów podrzędnych dla aktualnie zalogowanych dzierżaw użytkowników
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Zatrzymaj
|
$top | string |
Ten parametr jest używany do stronicowania i określa maksymalną liczbę elementów, które muszą być zwracane z zaplecza. Wartość domyślna to 20. |
|
|
Pomiń
|
$skip | string |
Ten parametr jest używany do stronicowania i oznacza punkt początkowy przyjmowania elementów. Wartość domyślna to 0 |
Zwraca
Pobieranie wszystkich obszarów zewnętrznych
Pobieranie wszystkich obszarów zewnętrznych dla aktualnie zalogowanych dzierżaw użytkowników
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Zatrzymaj
|
$top | string |
Ten parametr jest używany do stronicowania i określa maksymalną liczbę elementów, które muszą być zwracane z zaplecza. Wartość domyślna to 20. |
|
|
Pomiń
|
$skip | string |
Ten parametr jest używany do stronicowania i oznacza punkt początkowy przyjmowania elementów. Wartość domyślna to 0 |
Zwraca
Pobieranie wszystkich portfeli
Pobieranie wszystkich portfeli aktualnie zalogowanych dzierżaw użytkowników
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Zatrzymaj
|
$top | string |
Ten parametr jest używany do stronicowania i określa maksymalną liczbę elementów, które muszą być zwracane z zaplecza. Wartość domyślna to 20. |
|
|
Pomiń
|
$skip | string |
Ten parametr jest używany do stronicowania i oznacza punkt początkowy przyjmowania elementów. Wartość domyślna to 0 |
Zwraca
Pobieranie wszystkich spacji
Pobieranie wszystkich miejsc dla aktualnie zalogowanych dzierżaw użytkowników
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Zatrzymaj
|
$top | string |
Ten parametr jest używany do stronicowania i określa maksymalną liczbę elementów, które muszą być zwracane z zaplecza. Wartość domyślna to 20. |
|
|
Pomiń
|
$skip | string |
Ten parametr jest używany do stronicowania i oznacza punkt początkowy przyjmowania elementów. Wartość domyślna to 0 |
Zwraca
Pobieranie wszystkich witryn
Pobieranie wszystkich witryn dla aktualnie zalogowanych dzierżaw użytkowników
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Zatrzymaj
|
$top | string |
Ten parametr jest używany do stronicowania i określa maksymalną liczbę elementów, które muszą być zwracane z zaplecza. Wartość domyślna to 20. |
|
|
Pomiń
|
$skip | string |
Ten parametr jest używany do stronicowania i oznacza punkt początkowy przyjmowania elementów. Wartość domyślna to 0 |
Zwraca
Pobierz wszystkie dachy
Pobieranie wszystkich dachów dla aktualnie zalogowanych dzierżaw użytkowników
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Zatrzymaj
|
$top | string |
Ten parametr jest używany do stronicowania i określa maksymalną liczbę elementów, które muszą być zwracane z zaplecza. Wartość domyślna to 20. |
|
|
Pomiń
|
$skip | string |
Ten parametr jest używany do stronicowania i oznacza punkt początkowy przyjmowania elementów. Wartość domyślna to 0 |
Zwraca
Pobierz wszystkie fasady
Pobieranie wszystkich fasad dla aktualnie zalogowanych dzierżaw użytkownika
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Zatrzymaj
|
$top | string |
Ten parametr jest używany do stronicowania i określa maksymalną liczbę elementów, które muszą być zwracane z zaplecza. Wartość domyślna to 20. |
|
|
Pomiń
|
$skip | string |
Ten parametr jest używany do stronicowania i oznacza punkt początkowy przyjmowania elementów. Wartość domyślna to 0 |
Zwraca
Pobierz wszystkie podłogi
Pobieranie wszystkich podłóg dla aktualnie zalogowanych dzierżaw użytkowników
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Zatrzymaj
|
$top | string |
Ten parametr jest używany do stronicowania i określa maksymalną liczbę elementów, które muszą być zwracane z zaplecza. Wartość domyślna to 20. |
|
|
Pomiń
|
$skip | string |
Ten parametr jest używany do stronicowania i oznacza punkt początkowy przyjmowania elementów. Wartość domyślna to 0 |
Zwraca
Pobierz wszystkie ziemie
Pobierz wszystkie ziemie dla aktualnie zalogowanych dzierżaw użytkowników
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Zatrzymaj
|
$top | string |
Ten parametr jest używany do stronicowania i określa maksymalną liczbę elementów, które muszą być zwracane z zaplecza. Wartość domyślna to 20. |
|
|
Pomiń
|
$skip | string |
Ten parametr jest używany do stronicowania i oznacza punkt początkowy przyjmowania elementów. Wartość domyślna to 0 |
Zwraca
Definicje
CurrencyValueType
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
value
|
value | number | |
|
jednostka
|
unit | string |
AreaValueType
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
value
|
value | number | |
|
jednostka
|
unit | string | |
|
metricValue (wartość metryki)
|
metricValue | number |
LocationPathType
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string | |
|
title
|
title | string | |
|
typ
|
type | string |
LocationPathArrayType
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
Przedmioty
|
LocationPathType |
SpaceTypeOfUseEnum
OutsideAreaType
Typ jednostki
SpaceTypeOfOwnership
Typ adresu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | uuid |
należy zdefiniować w żądaniach POST/PUT dla istniejących adresów tylko w przypadkach, gdy istniejący adres został dodany tutaj zamiast tablicy identyfikatorów |
|
typ
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Tylko do odczytu |
|
changedBy
|
changedBy | string |
Tylko do odczytu |
|
ulica
|
street | string | |
|
houseNumber
|
houseNumber | string | |
|
postalCode
|
postalCode | string | |
|
city
|
city | string | |
|
country
|
country | string |
ISO 3166-1 alfa-3 Country Codes, np. CAN, USA, DEU |
|
region
|
region | string | |
|
strefa czasowa
|
timeZone | string | |
|
Postbox
|
postBox | string | |
|
postBoxPostCode
|
postBoxPostCode | string | |
|
phone
|
phone | string | |
|
Identyfikator zewnętrzny
|
externalId | uuid |
Identyfikator zewnętrzny adresu powinien być generowany po stronie klienta podczas tworzenia nowego adresu |
|
latitude
|
latitude | float |
Współrzędna laditiude dla adresu |
|
długość geograficzna
|
longitude | float |
współrzędna długości geograficznej dla adresu |
Portfolio
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | uuid | |
|
typ
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Tylko do odczytu |
|
changedBy
|
changedBy | string |
Tylko do odczytu |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tid
|
tid | uuid |
identyfikator dzierżawy |
|
title
|
title | string | |
|
opis
|
description | string | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
właściciel
|
owner | string | |
|
buildingGrossArea
|
buildingGrossArea | AreaValueType | |
|
landGrossArea
|
landGrossArea | AreaValueType | |
|
associatedLandIds
|
associatedLandIds | array of uuid | |
|
associatedBuildingIds
|
associatedBuildingIds | array of uuid |
Site
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | uuid | |
|
typ
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Tylko do odczytu |
|
changedBy
|
changedBy | string |
Tylko do odczytu |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tid
|
tid | uuid |
identyfikator dzierżawy |
|
title
|
title | string | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
buildingGrossArea
|
buildingGrossArea | AreaValueType | |
|
outsideareaGrossArea
|
outsideareaGrossArea | AreaValueType | |
|
mainAddressExternalId
|
mainAddressExternalId | uuid |
externalId jednego z adresów z kolekcji linkedAddresses należy umieścić tutaj, aby adres główny |
|
addresses
|
addresses | array of AddressType | |
|
typeOfSite
|
typeOfSite | SpaceTypeOfUseEnum | |
|
imageIds
|
imageIds | array of uuid | |
|
internalId
|
internalId | uuid | |
|
furtherInformation
|
furtherInformation | string |
Budowla
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | uuid | |
|
typ
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Tylko do odczytu |
|
changedBy
|
changedBy | string |
Tylko do odczytu |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tid
|
tid | uuid |
identyfikator dzierżawy |
|
associatedPortfolioId
|
associatedPortfolioId | uuid | |
|
parentId (identyfikator rodzica)
|
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 | |
|
budowaRra
|
constructionYear | date | |
|
yearOfLastRefurbishment
|
yearOfLastRefurbishment | date | |
|
grossArea
|
grossArea | AreaValueType | |
|
budynekPurchaseCost
|
buildingPurchaseCost | CurrencyValueType | |
|
hasMonumentProtection
|
hasMonumentProtection | boolean | |
|
numberOfFloors
|
numberOfFloors | integer | |
|
numberOf BasementFloors
|
numberOf BasementFloors | integer |
Piętro
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | uuid | |
|
typ
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Tylko do odczytu |
|
changedBy
|
changedBy | string |
Tylko do odczytu |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tid
|
tid | uuid |
identyfikator dzierżawy |
|
title
|
title | string | |
|
parentId (identyfikator rodzica)
|
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 |
Przestrzeń
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | uuid | |
|
typ
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Tylko do odczytu |
|
changedBy
|
changedBy | string |
Tylko do odczytu |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tid
|
tid | uuid |
identyfikator dzierżawy |
|
title
|
title | string | |
|
parentId (identyfikator rodzica)
|
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
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | uuid | |
|
typ
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Tylko do odczytu |
|
changedBy
|
changedBy | string |
Tylko do odczytu |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tid
|
tid | uuid |
identyfikator dzierżawy |
|
title
|
title | string | |
|
parentId (identyfikator rodzica)
|
parentId | uuid | |
|
internalId
|
internalId | uuid | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
furtherInformation
|
furtherInformation | string | |
|
materiał
|
material | string | |
|
grossArea
|
grossArea | AreaValueType | |
|
imageIds
|
imageIds | array of uuid |
Fasada
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | uuid | |
|
typ
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Tylko do odczytu |
|
changedBy
|
changedBy | string |
Tylko do odczytu |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tid
|
tid | uuid |
identyfikator dzierżawy |
|
title
|
title | string | |
|
parentId (identyfikator rodzica)
|
parentId | uuid | |
|
internalId
|
internalId | uuid | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
furtherInformation
|
furtherInformation | string | |
|
materiał
|
material | string | |
|
grossArea
|
grossArea | AreaValueType | |
|
imageIds
|
imageIds | array of uuid |
Obszar zewnętrzny
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | uuid | |
|
typ
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Tylko do odczytu |
|
changedBy
|
changedBy | string |
Tylko do odczytu |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tid
|
tid | uuid |
identyfikator dzierżawy |
|
title
|
title | string | |
|
parentId (identyfikator rodzica)
|
parentId | uuid | |
|
internalId
|
internalId | uuid | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
furtherInformation
|
furtherInformation | string | |
|
typeOfOutsideArea
|
typeOfOutsideArea | OutsideAreaType | |
|
grossArea
|
grossArea | AreaValueType |
Ląd
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | uuid | |
|
typ
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Tylko do odczytu |
|
changedBy
|
changedBy | string |
Tylko do odczytu |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tid
|
tid | uuid |
identyfikator dzierżawy |
|
title
|
title | string | |
|
parentId (identyfikator rodzica)
|
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 |
Podobszarze
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | uuid | |
|
typ
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Tylko do odczytu |
|
changedBy
|
changedBy | string |
Tylko do odczytu |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tid
|
tid | uuid |
identyfikator dzierżawy |
|
title
|
title | string | |
|
parentId (identyfikator rodzica)
|
parentId | uuid | |
|
internalId
|
internalId | uuid | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
furtherInformation
|
furtherInformation | string |
PortfolioTypeWithPagination
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Portfolio |
SiteTypeWithPagination
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Site |
BuildingTypeWithPagination
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Building |
FloorTypeWithPagination
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Floor |
RoofsTypeWithPagination
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Roof |
FasadyTypeWithPagination
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Facade |
OutsideareasTypeWithPagination
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Outsidearea |
PodareasTypeWithPagination
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Subarea |
LandsTypeWithPagination
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Land |
SpacesTypeWithPagination
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Space |
AssociatedSpacesTypeWithPagination
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Space |