BuildingMinds DigitalTwin Core (предварительная версия)
Платформа BuildingMinds Core предоставляет REST API. С помощью API BuildingMinds DigitalTwin Core вы можете читать и перечислять главные данные Цифрового здания двойника, такие как здания, полы и пространства и их свойства.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Поддержка BuildingMinds |
| URL | https://buildingminds.com/services/customer-support |
| Адрес электронной почты | support@buildingminds.com |
| Метаданные соединителя | |
|---|---|
| Publisher | BuildingMinds |
| Website | https://buildingminds.com/ |
| Политика конфиденциальности | https://buildingminds.com/privacy-policy |
| Категории | Данные |
Соединитель BuildingMinds Digital Twin Core подключает все источники данных через единую централизованную платформу. Используйте Платформу BuildingMinds в качестве одного источника истины и обновите другие приложения с точной информацией о сайтах и зданиях с помощью этого соединителя.
Предпосылки
Для использования соединителя требуется учетная запись на платформе BuildindMinds и пользователь с соответствующей авторизацией. Обратитесь к нам по адресу https://buildingminds.com/services/customer-support или support@buildingminds.com.
Начало работы с соединителем
Распространенный вариант использования — настройка автоматизированного рабочего процесса между соединителем BuildingMinds Digital Twin Core и системой ERP, чтобы получить up-to-date data of your buildings.
Получение данных адреса для нескольких зданий
- Чтобы получить основные данные всех зданий, используйте действие
GetBuildings. По умолчанию первые 20 элементов отображаются в ответе. Чтобы изменить значение по умолчанию, используйте параметры$skipзапроса и$top. - Выберите различные свойства данных объекта, которые требуется перенести в систему ERP. Дополнительные сведения см. в разделе "Свойства ответа" в разделе "Адреса".
Получение данных адреса для определенного здания
- Получите идентификатор здания, для которого необходимо получить данные адреса с помощью действия
GetBuildings. - Используйте действие
GetBuildingById. - Выберите свойства в ответе, который требуется перенести. Дополнительные сведения см. в разделе "Свойства ответа" в разделе "Адреса".
Получение всех зданий, принадлежащих портфелю
- Получите идентификатор портфеля, для которого требуется получить связанные здания с помощью действия
GetPortfolios. - Используйте действие
GetPortfolioById. - Выберите свойство
associatedBuildingIdsответа.
Ответ
Здание
Свойства
| Имя | Description |
|---|---|
id |
Уникальный идентификатор здания внутри платформы BuildingMinds. |
type |
Тип объекта. В этом случае тип объекта является зданием. |
tid |
Идентификатор клиента |
title |
Имя сборки |
validFrom |
Дата, из которой является допустимое здание. |
validTo |
Дата, до которой является допустимое здание. |
changedBy |
Идентификатор пользователя, изменившего здание. |
changedOn |
Дата последнего изменения здания. |
createdOn |
Дата создания здания. |
internalId |
Идентификатор, определенный пользователем. |
externalId |
Уникальный идентификатор из внешней системы, используемой в качестве стороннего приложения на платформе BuildingMinds. |
locationPath |
Содержит idtype, а также title сайт, к которому принадлежит здание. |
imageIds |
При отправке изображений для здания отображаются идентификаторы изображений. |
parentId |
Идентификатор сайта, которому принадлежит здание. |
typeOfBuilding |
Тип здания, например Office или Жилой. |
typeOfOwnership |
Тип владения, например Freehold или Part-ownership. |
associatedLandIds |
Земли, связанные с этим зданием. |
constructionYear |
Год, когда здание было построено. |
grossArea |
Объект области, содержащий свойства value, unitи metricValue. |
mainAddressExternalId |
Идентификатор основного адреса здания в случае, если для этого здания сохранено несколько адресов. |
addresses |
Объект, содержащий один или несколько адресов. Дополнительные сведения о свойствах адресов см. в разделе "Адреса". |
parentHierarchies |
Элемент пользовательской иерархии, которому назначается сборка. |
Адреса
Свойства
| Имя | Description |
|---|---|
id |
Уникальный идентификатор здания внутри платформы BuildingMinds. |
type |
Тип объекта. В этом случае тип объекта является адресом. |
tid |
Идентификатор клиента |
externalId |
Уникальный идентификатор из внешней системы или автоматически созданный идентификатор для определенного пользователя изменения через пользовательский интерфейс, например перемещенный пин-код карты. |
street |
Имя улицы |
houseNumber |
Номер дома |
postalCode |
Почтовый индекс или почтовый индекс |
city |
Город |
country |
Страна |
changedBy |
Идентификатор пользователя, изменившего адрес. |
changedOn |
Дата последнего изменения адреса. |
createdOn |
Дата создания адреса. |
resolutionStatus |
Состояние, если разрешение адреса выполнено успешно. |
latitude |
Географические координаты адреса. |
longitude |
Географические координаты адреса. |
region |
Регион |
continent |
Continent |
Портфель
Свойства
| Имя | Description |
|---|---|
id |
Уникальный идентификатор портфеля внутри платформы BuildingMinds. |
type |
Тип объекта. В этом случае тип объекта является портфелем. |
createdOn |
Дата создания портфеля. |
changedOn |
Дата последнего изменения портфеля. |
changedBy |
Идентификатор пользователя, который изменил портфель. |
title |
Имя портфеля |
validFrom |
Дата, из которой является допустимым портфелем. |
validTo |
Дата, до которой действует портфель. |
owner |
Владелец портфеля |
buildingGrossArea |
Объект области, содержащий свойства value, unitи metricValue для всех зданий портфеля. |
landGrossArea |
Объект области, содержащий свойства value, unitи metricValue для всех земель портфеля. |
internalId |
Идентификатор, определенный пользователем. |
externalId |
Уникальный идентификатор из внешней системы, используемой в качестве стороннего приложения на платформе BuildingMinds. |
associatedBuildingIds |
Здания, связанные с этим портфелем. |
associatedLandIds |
Земли, связанные с этим портфелем. |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Возвращает аутсайдер с заданным идентификатором |
Возвращает аутсайдер с заданным идентификатором |
| Возвращает плавучее с заданным идентификатором |
Возвращает здание с заданным идентификатором |
| Возвращает подаресу с заданным идентификатором |
Возвращает подаресу с заданным идентификатором |
| Возвращает портфель с заданным идентификатором |
Возвращает портфель с заданным идентификатором |
| Возвращает пробел с заданным идентификатором |
Возвращает пробел с заданным идентификатором |
| Возвращает сведения о существовании детей на сайте |
Возвращает сведения о существовании детей на сайте |
| Возвращает сведения о существовании дочерних объектов в пространстве |
Возвращает сведения о существовании дочерних объектов в пространстве |
| Возвращает сведения о существовании дочерних элементов в подаре |
Возвращает сведения о существовании дочерних элементов в подаре |
| Возвращает сведения о существовании дочерних элементов на фасаде |
Возвращает сведения о существовании дочерних элементов на фасаде |
| Возвращает фасад с заданным идентификатором |
Возвращает фасад с заданным идентификатором |
| Получает землю с заданным идентификатором |
Получает землю с заданным идентификатором |
| Получает крышу с заданным идентификатором |
Получает крышу с заданным идентификатором |
| Получает пол с заданным идентификатором |
Получает пол с заданным идентификатором |
| Получает сайт с заданным идентификатором |
Получает сайт с заданным идентификатором |
| Получает сведения о существовании детей в здании |
Получает сведения о существовании детей в здании |
| Получает сведения о существовании детей в портфелях |
Получает сведения о существовании детей в портфелях |
| Получает сведения о существовании детей на земле |
Получает сведения о существовании детей на земле |
| Получает сведения о существовании детей на крыше |
Получает сведения о существовании детей на крыше |
| Получает сведения о существовании детей на полу |
Получает сведения о существовании детей на полу |
| Получает сведения о существовании дочерних объектов на аутсайдере |
Получает сведения о существовании дочерних объектов на аутсайдере |
| Получение всех аутсайдеров |
Получение всех внешних приложений для клиентов, вошедшего в систему пользователей |
| Получение всех вложенных центров |
Получение всех вложенных приложений для клиентов пользователя, вошедшего в систему |
| Получение всех зданий |
Получение всех зданий для клиентов пользователя, вошедшего в систему |
| Получение всех портфелей |
Получение всех портфелей для клиентов пользователя, зарегистрированных в данный момент |
| Получение всех пробелов |
Получение всех пространств для клиентов пользователя, вошедшего в систему |
| Получение всех сайтов |
Получение всех сайтов для клиентов пользователя, вошедшего в систему |
| Получение списка не связанных сущностей |
Получение списка пробелов определенного типа, которые не связаны с пространством другого предоставленного типа. |
| Получение списка связанных сущностей |
Получение списка пробелов определенного типа, связанного с предоставленной сущностью пространства |
| Получить все земли |
Получение всех земель для вошедшего в систему клиента пользователя |
| Получить все крыши |
Получение всех крыш для клиентов пользователя, вошедшего в систему |
| Получить все фасады |
Получение всех фасадов для клиентов пользователя, вошедшего в систему |
| Получить все этажи |
Получение всех этажей для клиентов пользователя, вошедшего в систему |
Возвращает аутсайдер с заданным идентификатором
Возвращает аутсайдер с заданным идентификатором
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
id | True | string |
Формат — uuid. Уникальный идентификатор пробела |
Возвращаемое значение
- Тело
- Outsidearea
Возвращает плавучее с заданным идентификатором
Возвращает здание с заданным идентификатором
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
id | True | string |
Формат — uuid. Уникальный идентификатор пробела |
Возвращаемое значение
- Тело
- Building
Возвращает подаресу с заданным идентификатором
Возвращает подаресу с заданным идентификатором
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
id | True | string |
Формат — uuid. Уникальный идентификатор пробела |
Возвращаемое значение
- Тело
- Subarea
Возвращает портфель с заданным идентификатором
Возвращает портфель с заданным идентификатором
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
id | True | string |
Формат — uuid. Уникальный идентификатор пробела |
Возвращаемое значение
- Тело
- Portfolio
Возвращает пробел с заданным идентификатором
Возвращает пробел с заданным идентификатором
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
id | True | string |
Формат — uuid. Уникальный идентификатор пробела |
Возвращаемое значение
- Тело
- Space
Возвращает сведения о существовании детей на сайте
Возвращает сведения о существовании детей на сайте
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
id | True | string |
Формат — uuid. Уникальный идентификатор пробела |
Возвращает сведения о существовании дочерних объектов в пространстве
Возвращает сведения о существовании дочерних объектов в пространстве
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
id | True | string |
Формат — uuid. Уникальный идентификатор пробела |
Возвращает сведения о существовании дочерних элементов в подаре
Возвращает сведения о существовании дочерних элементов в подаре
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
id | True | string |
Формат — uuid. Уникальный идентификатор пробела |
Возвращает сведения о существовании дочерних элементов на фасаде
Возвращает сведения о существовании дочерних элементов на фасаде
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
id | True | string |
Формат — uuid. Уникальный идентификатор пробела |
Возвращает фасад с заданным идентификатором
Возвращает фасад с заданным идентификатором
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
id | True | string |
Формат — uuid. Уникальный идентификатор пробела |
Возвращаемое значение
- Тело
- Facade
Получает землю с заданным идентификатором
Получает землю с заданным идентификатором
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
id | True | string |
Формат — uuid. Уникальный идентификатор пробела |
Возвращаемое значение
- Тело
- Land
Получает крышу с заданным идентификатором
Получает крышу с заданным идентификатором
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
id | True | string |
Формат — uuid. Уникальный идентификатор пробела |
Возвращаемое значение
- Тело
- Roof
Получает пол с заданным идентификатором
Получает пол с заданным идентификатором
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
id | True | string |
Формат — uuid. Уникальный идентификатор пробела |
Возвращаемое значение
- Тело
- Floor
Получает сайт с заданным идентификатором
Получает сайт с заданным идентификатором
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
id | True | string |
Формат — uuid. Уникальный идентификатор пробела |
Возвращаемое значение
- Тело
- Site
Получает сведения о существовании детей в здании
Получает сведения о существовании детей в здании
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
id | True | string |
Формат — uuid. Уникальный идентификатор пробела |
Получает сведения о существовании детей в портфелях
Получает сведения о существовании детей в портфелях
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
id | True | string |
Формат — uuid. Уникальный идентификатор пробела |
Получает сведения о существовании детей на земле
Получает сведения о существовании детей на земле
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
id | True | string |
Формат — uuid. Уникальный идентификатор пробела |
Получает сведения о существовании детей на крыше
Получает сведения о существовании детей на крыше
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
id | True | string |
Формат — uuid. Уникальный идентификатор пробела |
Получает сведения о существовании детей на полу
Получает сведения о существовании детей на полу
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
id | True | string |
Формат — uuid. Уникальный идентификатор пробела |
Получает сведения о существовании дочерних объектов на аутсайдере
Получает сведения о существовании дочерних объектов на аутсайдере
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пространства
|
id | True | string |
Формат — uuid. Уникальный идентификатор пробела |
Получение всех аутсайдеров
Получение всех внешних приложений для клиентов, вошедшего в систему пользователей
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Остановка
|
$top | string |
Этот параметр используется для разбиения на страницы и определяет максимальное количество элементов, которые должны быть возвращены из серверной части. Значение по умолчанию — 20. |
|
|
Пропустить
|
$skip | string |
Этот параметр используется для разбиения на страницы и помечает начальную точку принятия элементов. Значение по умолчанию — 0 |
Возвращаемое значение
Получение всех вложенных центров
Получение всех вложенных приложений для клиентов пользователя, вошедшего в систему
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Остановка
|
$top | string |
Этот параметр используется для разбиения на страницы и определяет максимальное количество элементов, которые должны быть возвращены из серверной части. Значение по умолчанию — 20. |
|
|
Пропустить
|
$skip | string |
Этот параметр используется для разбиения на страницы и помечает начальную точку принятия элементов. Значение по умолчанию — 0 |
Возвращаемое значение
Получение всех зданий
Получение всех зданий для клиентов пользователя, вошедшего в систему
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Остановка
|
$top | string |
Этот параметр используется для разбиения на страницы и определяет максимальное количество элементов, которые должны быть возвращены из серверной части. Значение по умолчанию — 20. |
|
|
Пропустить
|
$skip | string |
Этот параметр используется для разбиения на страницы и помечает начальную точку принятия элементов. Значение по умолчанию — 0 |
Возвращаемое значение
Получение всех портфелей
Получение всех портфелей для клиентов пользователя, зарегистрированных в данный момент
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Остановка
|
$top | string |
Этот параметр используется для разбиения на страницы и определяет максимальное количество элементов, которые должны быть возвращены из серверной части. Значение по умолчанию — 20. |
|
|
Пропустить
|
$skip | string |
Этот параметр используется для разбиения на страницы и помечает начальную точку принятия элементов. Значение по умолчанию — 0 |
Возвращаемое значение
Получение всех пробелов
Получение всех пространств для клиентов пользователя, вошедшего в систему
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Остановка
|
$top | string |
Этот параметр используется для разбиения на страницы и определяет максимальное количество элементов, которые должны быть возвращены из серверной части. Значение по умолчанию — 20. |
|
|
Пропустить
|
$skip | string |
Этот параметр используется для разбиения на страницы и помечает начальную точку принятия элементов. Значение по умолчанию — 0 |
Возвращаемое значение
Получение всех сайтов
Получение всех сайтов для клиентов пользователя, вошедшего в систему
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Остановка
|
$top | string |
Этот параметр используется для разбиения на страницы и определяет максимальное количество элементов, которые должны быть возвращены из серверной части. Значение по умолчанию — 20. |
|
|
Пропустить
|
$skip | string |
Этот параметр используется для разбиения на страницы и помечает начальную точку принятия элементов. Значение по умолчанию — 0 |
Возвращаемое значение
Получение списка не связанных сущностей
Получение списка пробелов определенного типа, которые не связаны с пространством другого предоставленного типа.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип пространства
|
spaceType | True | string |
Описание типа пространства |
|
Связанный тип
|
associatedType | True | string |
Описание типа связанного пространства |
|
Запрос идентификатора пространства
|
spaceid | string |
Формат — uuid. Необязательный идентификатор связанного пространства для включения в результаты |
Получение списка связанных сущностей
Получение списка пробелов определенного типа, связанного с предоставленной сущностью пространства
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип пространства
|
spaceType | True | string |
Описание типа пространства |
|
Идентификатор пространства
|
id | True | string |
Формат — uuid. Уникальный идентификатор пробела |
|
Связанный тип
|
associatedType | True | string |
Описание типа связанного пространства |
|
Пропустить
|
$skip | string |
Этот параметр используется для разбиения на страницы и помечает начальную точку принятия элементов. Значение по умолчанию — 0 |
|
|
Остановка
|
$top | string |
Этот параметр используется для разбиения на страницы и определяет максимальное количество элементов, которые должны быть возвращены из серверной части. Значение по умолчанию — 20. |
Возвращаемое значение
Получить все земли
Получение всех земель для вошедшего в систему клиента пользователя
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Остановка
|
$top | string |
Этот параметр используется для разбиения на страницы и определяет максимальное количество элементов, которые должны быть возвращены из серверной части. Значение по умолчанию — 20. |
|
|
Пропустить
|
$skip | string |
Этот параметр используется для разбиения на страницы и помечает начальную точку принятия элементов. Значение по умолчанию — 0 |
Возвращаемое значение
Получить все крыши
Получение всех крыш для клиентов пользователя, вошедшего в систему
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Остановка
|
$top | string |
Этот параметр используется для разбиения на страницы и определяет максимальное количество элементов, которые должны быть возвращены из серверной части. Значение по умолчанию — 20. |
|
|
Пропустить
|
$skip | string |
Этот параметр используется для разбиения на страницы и помечает начальную точку принятия элементов. Значение по умолчанию — 0 |
Возвращаемое значение
Получить все фасады
Получение всех фасадов для клиентов пользователя, вошедшего в систему
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Остановка
|
$top | string |
Этот параметр используется для разбиения на страницы и определяет максимальное количество элементов, которые должны быть возвращены из серверной части. Значение по умолчанию — 20. |
|
|
Пропустить
|
$skip | string |
Этот параметр используется для разбиения на страницы и помечает начальную точку принятия элементов. Значение по умолчанию — 0 |
Возвращаемое значение
Получить все этажи
Получение всех этажей для клиентов пользователя, вошедшего в систему
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Остановка
|
$top | string |
Этот параметр используется для разбиения на страницы и определяет максимальное количество элементов, которые должны быть возвращены из серверной части. Значение по умолчанию — 20. |
|
|
Пропустить
|
$skip | string |
Этот параметр используется для разбиения на страницы и помечает начальную точку принятия элементов. Значение по умолчанию — 0 |
Возвращаемое значение
Определения
CurrencyValueType
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
value
|
value | number | |
|
единица
|
unit | string |
AreaValueType
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
value
|
value | number | |
|
единица
|
unit | string | |
|
metricValue
|
metricValue | number |
LocationPathType
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | string | |
|
title
|
title | string | |
|
type
|
type | string |
LocationPathArrayType
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Товары
|
LocationPathType |
SpaceTypeOfUseEnum
OutsideAreaType
EntityType
SpaceTypeOfOwnership
AddressType
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | uuid |
следует определить в запросах POST/PUT для существующих адресов только в тех случаях, когда существующий адрес был добавлен здесь вместо массива идентификаторов |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Только для чтения |
|
changedBy
|
changedBy | string |
Только для чтения |
|
улица
|
street | string | |
|
houseNumber
|
houseNumber | string | |
|
postalCode
|
postalCode | string | |
|
city
|
city | string | |
|
country
|
country | string |
Коды стран ISO 3166-1 альфа-3, например CAN, США, DEU |
|
region
|
region | string | |
|
часовой пояс
|
timeZone | string | |
|
почтовый ящик
|
postBox | string | |
|
postBoxPostCode
|
postBoxPostCode | string | |
|
phone
|
phone | string | |
|
externalId (внешний идентификатор)
|
externalId | uuid |
Внешний идентификатор адреса должен быть создан на стороне клиента при создании нового адреса |
|
широта
|
latitude | float |
Координата Laditiude для адреса |
|
долгота
|
longitude | float |
Координата долготы для адреса |
Портфель
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Только для чтения |
|
changedBy
|
changedBy | string |
Только для чтения |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
время
|
tid | uuid |
идентификатор клиента |
|
title
|
title | string | |
|
описание
|
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
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Только для чтения |
|
changedBy
|
changedBy | string |
Только для чтения |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
время
|
tid | uuid |
идентификатор клиента |
|
title
|
title | string | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
buildingGrossArea
|
buildingGrossArea | AreaValueType | |
|
outsideareaGrossArea
|
outsideareaGrossArea | AreaValueType | |
|
mainAddressExternalId
|
mainAddressExternalId | uuid |
externalId одного из адресов из коллекции linkedAddresses следует поместить здесь, чтобы сделать адрес основным. |
|
addresses
|
addresses | array of AddressType | |
|
typeOfSite
|
typeOfSite | SpaceTypeOfUseEnum | |
|
imageIds
|
imageIds | array of uuid | |
|
internalId
|
internalId | uuid | |
|
дополнительная информация
|
furtherInformation | string |
Здание
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Только для чтения |
|
changedBy
|
changedBy | string |
Только для чтения |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
время
|
tid | uuid |
идентификатор клиента |
|
associatedPortfolioId
|
associatedPortfolioId | uuid | |
|
parentId
|
parentId | uuid | |
|
associatedLandIds
|
associatedLandIds | array of uuid | |
|
title
|
title | string | |
|
internalId
|
internalId | uuid | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
addresses
|
addresses | array of AddressType | |
|
responsiblePeopleFullName
|
responsiblePeopleFullName | string | |
|
typeOfOwnership
|
typeOfOwnership | SpaceTypeOfOwnership | |
|
typeOfBuilding
|
typeOfBuilding | string | |
|
imageIds
|
imageIds | array of uuid | |
|
дополнительная информация
|
furtherInformation | string | |
|
строительствоYear
|
constructionYear | date | |
|
yearOfLastRefurbishment
|
yearOfLastRefurbishment | date | |
|
grossArea
|
grossArea | AreaValueType | |
|
buildingPurchaseCost
|
buildingPurchaseCost | CurrencyValueType | |
|
hasMonumentProtection
|
hasMonumentProtection | boolean | |
|
numberOfFloors
|
numberOfFloors | integer | |
|
numberOf BasementFloors
|
numberOf BasementFloors | integer |
Floor
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Только для чтения |
|
changedBy
|
changedBy | string |
Только для чтения |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
время
|
tid | uuid |
идентификатор клиента |
|
title
|
title | string | |
|
parentId
|
parentId | uuid | |
|
internalId
|
internalId | uuid | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
дополнительная информация
|
furtherInformation | string | |
|
grossArea
|
grossArea | AreaValueType | |
|
typeOfFloor
|
typeOfFloor | string | |
|
imageIds
|
imageIds | array of uuid |
Космос
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Только для чтения |
|
changedBy
|
changedBy | string |
Только для чтения |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
время
|
tid | uuid |
идентификатор клиента |
|
title
|
title | string | |
|
parentId
|
parentId | uuid | |
|
internalId
|
internalId | uuid | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
дополнительная информация
|
furtherInformation | string | |
|
imageIds
|
imageIds | array of uuid | |
|
grossArea
|
grossArea | AreaValueType | |
|
typeOfSpace
|
typeOfSpace | string |
Крыша
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Только для чтения |
|
changedBy
|
changedBy | string |
Только для чтения |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
время
|
tid | uuid |
идентификатор клиента |
|
title
|
title | string | |
|
parentId
|
parentId | uuid | |
|
internalId
|
internalId | uuid | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
дополнительная информация
|
furtherInformation | string | |
|
материал
|
material | string | |
|
grossArea
|
grossArea | AreaValueType | |
|
imageIds
|
imageIds | array of uuid |
Фасад
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Только для чтения |
|
changedBy
|
changedBy | string |
Только для чтения |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
время
|
tid | uuid |
идентификатор клиента |
|
title
|
title | string | |
|
parentId
|
parentId | uuid | |
|
internalId
|
internalId | uuid | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
дополнительная информация
|
furtherInformation | string | |
|
материал
|
material | string | |
|
grossArea
|
grossArea | AreaValueType | |
|
imageIds
|
imageIds | array of uuid |
Аутсайдера
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Только для чтения |
|
changedBy
|
changedBy | string |
Только для чтения |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
время
|
tid | uuid |
идентификатор клиента |
|
title
|
title | string | |
|
parentId
|
parentId | uuid | |
|
internalId
|
internalId | uuid | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
дополнительная информация
|
furtherInformation | string | |
|
typeOfOutsideArea
|
typeOfOutsideArea | OutsideAreaType | |
|
grossArea
|
grossArea | AreaValueType |
Земля
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Только для чтения |
|
changedBy
|
changedBy | string |
Только для чтения |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
время
|
tid | uuid |
идентификатор клиента |
|
title
|
title | string | |
|
parentId
|
parentId | uuid | |
|
internalId
|
internalId | uuid | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
дополнительная информация
|
furtherInformation | string | |
|
grossArea
|
grossArea | AreaValueType | |
|
registrationNumberOfDeed
|
registrationNumberOfDeed | array of string | |
|
ГрафикNumber
|
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 |
Раздел
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | uuid | |
|
type
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Только для чтения |
|
changedBy
|
changedBy | string |
Только для чтения |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
время
|
tid | uuid |
идентификатор клиента |
|
title
|
title | string | |
|
parentId
|
parentId | uuid | |
|
internalId
|
internalId | uuid | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
дополнительная информация
|
furtherInformation | string |
PortfolioTypeWithPagination
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Portfolio |
SiteTypeWithPagination
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Site |
BuildingTypeWithPagination
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Building |
FloorTypeWithPagination
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Floor |
RoofsTypeWithPagination
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Roof |
ФасадыTypeWithPagination
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Facade |
OutsideareasTypeWithPagination
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Outsidearea |
SubareasTypeWithPagination
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Subarea |
LandsTypeWithPagination
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Land |
SpacesTypeWithPagination
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Space |
AssociatedSpacesTypeWithPagination
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Space |