BuildingMinds DigitalTwin Core (versão prévia)
A Plataforma BuildingMinds Core fornece APIs REST. Com a API do BuildingMinds DigitalTwin Core, você pode ler e listar o masterdata do Digital Building Twin, como edifícios, pisos e espaços e suas propriedades.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte ao BuildingMinds |
| URL | https://buildingminds.com/services/customer-support |
| support@buildingminds.com |
| Metadados do conector | |
|---|---|
| Publicador | BuildingMinds |
| Site | https://buildingminds.com/ |
| Política de privacidade | https://buildingminds.com/privacy-policy |
| Categorias | Dados |
O Conector do BuildingMinds Digital Twin Core conecta todas as fontes de dados por meio de uma única plataforma centralizada. Use a Plataforma BuildingMinds como uma única fonte de verdade e atualize seus outros aplicativos com informações precisas sobre sites e edifícios usando esse conector.
Pré-requisitos
Você precisa de uma conta na Plataforma BuildindMinds e um usuário com autorização apropriada para usar o conector. Entre em contato conosco em https://buildingminds.com/services/customer-support ou support@buildingminds.com.
Introdução ao conector
Um caso de uso comum é configurar um fluxo de trabalho automatizado entre o Conector do BuildingMinds Digital Twin Core e um sistema ERP para obter dados de data up-tode seus edifícios.
Obter dados de endereço para vários edifícios
- Para obter os dados mestres de todos os edifícios, use a ação
GetBuildings. Por padrão, os primeiros 20 itens são exibidos na resposta. Para alterar o padrão, use os parâmetros$skipde consulta e$top. - Selecione as diferentes propriedades dos dados de objeto que você deseja transferir para o sistema ERP. Para obter mais informações, consulte as propriedades de resposta em Endereços.
Obter dados de endereço para um edifício específico
- Obtenha a ID de construção para a qual você deseja obter os dados de endereço usando a ação
GetBuildings. - Use a ação
GetBuildingById. - Selecione as propriedades na resposta que você deseja transferir. Para obter mais informações, consulte as propriedades de resposta em Endereços.
Obter todos os edifícios que pertencem a um portfólio
- Obtenha a ID do portfólio para a qual você deseja obter os edifícios associados usando a ação
GetPortfolios. - Use a ação
GetPortfolioById. - Selecione a propriedade
associatedBuildingIdsde resposta.
Resposta
Compilando
Propriedades
| Nome | Description |
|---|---|
id |
Identificador exclusivo para o edifício dentro da plataforma BuildingMinds. |
type |
Tipo de objeto. Nesse caso, o tipo de objeto é um edifício. |
tid |
Identificador de locatário |
title |
Nome do edifício |
validFrom |
Data da qual o edifício é válido. |
validTo |
Data até a qual o edifício é válido. |
changedBy |
Identificador de usuário do usuário que alterou o edifício. |
changedOn |
Data em que o prédio foi alterado pela última vez. |
createdOn |
Data em que o prédio foi criado. |
internalId |
Identificador definido pelo usuário. |
externalId |
Identificador exclusivo de um sistema externo usado como um aplicativo de terceiros na plataforma BuildingMinds. |
locationPath |
Contém o id, typee title do local ao qual o edifício pertence. |
imageIds |
Quando as imagens são carregadas para o edifício, os identificadores de imagem são exibidos. |
parentId |
Identificador do local ao qual o edifício pertence. |
typeOfBuilding |
Tipo de construção como Office ou Residencial. |
typeOfOwnership |
Tipo de propriedade, como Freehold ou Part-ownership. |
associatedLandIds |
Terras associadas a este prédio. |
constructionYear |
Ano em que o prédio foi construído. |
grossArea |
Objeto de área que contém as propriedades value, unite metricValue. |
mainAddressExternalId |
Identificador do endereço principal do edifício caso haja vários endereços salvos para esse edifício. |
addresses |
Objeto que contém um ou vários endereços. Para obter mais informações sobre propriedades de endereço, consulte Endereços. |
parentHierarchies |
Um elemento de hierarquia personalizado ao qual o edifício é atribuído. |
Addresses
Propriedades
| Nome | Description |
|---|---|
id |
Identificador exclusivo para o edifício dentro da plataforma BuildingMinds. |
type |
Tipo de objeto. Nesse caso, o tipo de objeto é um endereço. |
tid |
Identificador de locatário |
externalId |
Identificador exclusivo de um sistema externo ou um identificador gerado automaticamente para uma alteração específica do usuário na interface do usuário, como um pino de mapa realocado. |
street |
Nome da rua |
houseNumber |
Número da casa |
postalCode |
Cep ou cep |
city |
City |
country |
País |
changedBy |
Identificador de usuário do usuário que alterou o endereço. |
changedOn |
Data em que o endereço foi alterado pela última vez. |
createdOn |
Data em que o endereço foi criado. |
resolutionStatus |
Status se a resolução do endereço tiver sido bem-sucedida. |
latitude |
Coordenadas geográficas do endereço. |
longitude |
Coordenadas geográficas do endereço. |
region |
Região |
continent |
Continent |
Pasta
Propriedades
| Nome | Description |
|---|---|
id |
Identificador exclusivo para o portfólio dentro da plataforma BuildingMinds. |
type |
Tipo de objeto. Nesse caso, o tipo de objeto é um portfólio. |
createdOn |
Data em que o portfólio foi criado. |
changedOn |
Data em que o portfólio foi alterado pela última vez. |
changedBy |
Identificador de usuário do usuário que alterou o portfólio. |
title |
Nome do portfólio |
validFrom |
Data da qual o portfólio é válido. |
validTo |
Data até a qual o portfólio é válido. |
owner |
Proprietário do portfólio |
buildingGrossArea |
Objeto de área que contém as propriedades valueunite metricValue para todos os edifícios do portfólio. |
landGrossArea |
Objeto de área que contém as propriedades valueunite metricValue para todas as terras do portfólio. |
internalId |
Identificador definido pelo usuário. |
externalId |
Identificador exclusivo de um sistema externo usado como um aplicativo de terceiros na plataforma BuildingMinds. |
associatedBuildingIds |
Edifícios associados a esse portfólio. |
associatedLandIds |
Terras associadas a esse portfólio. |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Obter a lista de entidades associadas |
Obter a lista de espaços de determinado tipo associados à entidade de espaço fornecida |
| Obter a lista de entidades não associadas |
Obter a lista de espaços de determinado tipo que não estão associados ao espaço de outro tipo fornecido |
| Obter todas as fachadas |
Obter todas as Fachadas para os locatários do usuário conectados no momento |
| Obter todas as terras |
Obter todas as terras para os locatários do usuário conectado no momento |
| Obter todas as áreas externas |
Obter todas as áreas externas para os locatários do usuário conectados no momento |
| Obter todos os andares |
Obter todos os andares para os locatários do usuário conectado no momento |
| Obter todos os edifícios |
Obter todos os edifícios para os locatários do usuário conectados no momento |
| Obter todos os espaços |
Obter todos os espaços para os locatários do usuário conectado no momento |
| Obter todos os portfólios |
Obter todos os portfólios para os locatários do usuário conectados no momento |
| Obter todos os sites |
Obter todos os sites para os locatários do usuário conectado no momento |
| Obter todos os subáreas |
Obter todas as subáreas para os locatários do usuário conectados no momento |
| Obter todos os telhados |
Obter todos os telhados para os locatários do usuário conectados no momento |
| Obtém as informações sobre a existência de crianças em um andar |
Obtém as informações sobre a existência de crianças em um andar |
| Obtém as informações sobre a existência de crianças em um espaço |
Obtém as informações sobre a existência de crianças em um espaço |
| Obtém as informações sobre a existência de crianças em um prédio |
Obtém as informações sobre a existência de crianças em um prédio |
| Obtém as informações sobre a existência de crianças em um site |
Obtém as informações sobre a existência de crianças em um site |
| Obtém as informações sobre a existência de crianças em um telhado |
Obtém as informações sobre a existência de crianças em um telhado |
| Obtém as informações sobre a existência de crianças em uma fachada |
Obtém as informações sobre a existência de crianças em uma fachada |
| Obtém as informações sobre a existência de crianças em uma subárea |
Obtém as informações sobre a existência de crianças em uma subárea |
| Obtém as informações sobre a existência de crianças em uma terra |
Obtém as informações sobre a existência de crianças em uma terra |
| Obtém as informações sobre a existência de crianças em uma área externa |
Obtém as informações sobre a existência de crianças em uma área externa |
| Obtém as informações sobre a existência de filhos em um portfólio |
Obtém as informações sobre a existência de filhos em um portfólio |
| Obtém um andar com a ID fornecida |
Obtém um andar com a ID fornecida |
| Obtém um buidling com a ID fornecida |
Obtém um prédio com a ID fornecida |
| Obtém um espaço com a ID fornecida |
Obtém um espaço com a ID fornecida |
| Obtém um portfólio com a ID fornecida |
Obtém um portfólio com a ID fornecida |
| Obtém um site com a ID fornecida |
Obtém um site com a ID fornecida |
| Obtém um teto com a ID fornecida |
Obtém um teto com a ID fornecida |
| Obtém uma fachada com a ID fornecida |
Obtém uma fachada com a ID fornecida |
| Obtém uma subárea com a ID fornecida |
Obtém uma subárea com a ID fornecida |
| Obtém uma terra com a ID fornecida |
Obtém uma terra com a ID fornecida |
| Obtém uma área externa com a ID fornecida |
Obtém uma área externa com a ID fornecida |
Obter a lista de entidades associadas
Obter a lista de espaços de determinado tipo associados à entidade de espaço fornecida
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de espaço
|
spaceType | True | string |
Descreve o tipo de espaço |
|
ID do espaço
|
id | True | string |
Formato – uuid. Identificador exclusivo de espaço |
|
Tipo associado
|
associatedType | True | string |
Descreve o tipo de espaço associado |
|
Ignorar
|
$skip | string |
Esse parâmetro é usado para paginação e marca o ponto de partida da tomada dos itens. O padrão é 0 |
|
|
Parar
|
$top | string |
Esse parâmetro é usado para paginação e determina o número máximo de itens que devem ser retornados do back-end. O padrão é 20. |
Retornos
Obter a lista de entidades não associadas
Obter a lista de espaços de determinado tipo que não estão associados ao espaço de outro tipo fornecido
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Tipo de espaço
|
spaceType | True | string |
Descreve o tipo de espaço |
|
Tipo associado
|
associatedType | True | string |
Descreve o tipo de espaço associado |
|
Consulta de ID de espaço
|
spaceid | string |
Formato – uuid. Identificador opcional de espaço associado a ser incluído nos resultados |
Obter todas as fachadas
Obter todas as Fachadas para os locatários do usuário conectados no momento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Parar
|
$top | string |
Esse parâmetro é usado para paginação e determina o número máximo de itens que devem ser retornados do back-end. O padrão é 20. |
|
|
Ignorar
|
$skip | string |
Esse parâmetro é usado para paginação e marca o ponto de partida da tomada dos itens. O padrão é 0 |
Retornos
Obter todas as terras
Obter todas as terras para os locatários do usuário conectado no momento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Parar
|
$top | string |
Esse parâmetro é usado para paginação e determina o número máximo de itens que devem ser retornados do back-end. O padrão é 20. |
|
|
Ignorar
|
$skip | string |
Esse parâmetro é usado para paginação e marca o ponto de partida da tomada dos itens. O padrão é 0 |
Retornos
- Corpo
- LandsTypeWithPagination
Obter todas as áreas externas
Obter todas as áreas externas para os locatários do usuário conectados no momento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Parar
|
$top | string |
Esse parâmetro é usado para paginação e determina o número máximo de itens que devem ser retornados do back-end. O padrão é 20. |
|
|
Ignorar
|
$skip | string |
Esse parâmetro é usado para paginação e marca o ponto de partida da tomada dos itens. O padrão é 0 |
Retornos
Obter todos os andares
Obter todos os andares para os locatários do usuário conectado no momento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Parar
|
$top | string |
Esse parâmetro é usado para paginação e determina o número máximo de itens que devem ser retornados do back-end. O padrão é 20. |
|
|
Ignorar
|
$skip | string |
Esse parâmetro é usado para paginação e marca o ponto de partida da tomada dos itens. O padrão é 0 |
Retornos
- Corpo
- FloorTypeWithPagination
Obter todos os edifícios
Obter todos os edifícios para os locatários do usuário conectados no momento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Parar
|
$top | string |
Esse parâmetro é usado para paginação e determina o número máximo de itens que devem ser retornados do back-end. O padrão é 20. |
|
|
Ignorar
|
$skip | string |
Esse parâmetro é usado para paginação e marca o ponto de partida da tomada dos itens. O padrão é 0 |
Retornos
Obter todos os espaços
Obter todos os espaços para os locatários do usuário conectado no momento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Parar
|
$top | string |
Esse parâmetro é usado para paginação e determina o número máximo de itens que devem ser retornados do back-end. O padrão é 20. |
|
|
Ignorar
|
$skip | string |
Esse parâmetro é usado para paginação e marca o ponto de partida da tomada dos itens. O padrão é 0 |
Retornos
- Corpo
- SpacesTypeWithPagination
Obter todos os portfólios
Obter todos os portfólios para os locatários do usuário conectados no momento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Parar
|
$top | string |
Esse parâmetro é usado para paginação e determina o número máximo de itens que devem ser retornados do back-end. O padrão é 20. |
|
|
Ignorar
|
$skip | string |
Esse parâmetro é usado para paginação e marca o ponto de partida da tomada dos itens. O padrão é 0 |
Retornos
Obter todos os sites
Obter todos os sites para os locatários do usuário conectado no momento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Parar
|
$top | string |
Esse parâmetro é usado para paginação e determina o número máximo de itens que devem ser retornados do back-end. O padrão é 20. |
|
|
Ignorar
|
$skip | string |
Esse parâmetro é usado para paginação e marca o ponto de partida da tomada dos itens. O padrão é 0 |
Retornos
- Corpo
- SiteTypeWithPagination
Obter todos os subáreas
Obter todas as subáreas para os locatários do usuário conectados no momento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Parar
|
$top | string |
Esse parâmetro é usado para paginação e determina o número máximo de itens que devem ser retornados do back-end. O padrão é 20. |
|
|
Ignorar
|
$skip | string |
Esse parâmetro é usado para paginação e marca o ponto de partida da tomada dos itens. O padrão é 0 |
Retornos
Obter todos os telhados
Obter todos os telhados para os locatários do usuário conectados no momento
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Parar
|
$top | string |
Esse parâmetro é usado para paginação e determina o número máximo de itens que devem ser retornados do back-end. O padrão é 20. |
|
|
Ignorar
|
$skip | string |
Esse parâmetro é usado para paginação e marca o ponto de partida da tomada dos itens. O padrão é 0 |
Retornos
- Corpo
- RoofsTypeWithPagination
Obtém as informações sobre a existência de crianças em um andar
Obtém as informações sobre a existência de crianças em um andar
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato – uuid. Identificador exclusivo de espaço |
Obtém as informações sobre a existência de crianças em um espaço
Obtém as informações sobre a existência de crianças em um espaço
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato – uuid. Identificador exclusivo de espaço |
Obtém as informações sobre a existência de crianças em um prédio
Obtém as informações sobre a existência de crianças em um prédio
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato – uuid. Identificador exclusivo de espaço |
Obtém as informações sobre a existência de crianças em um site
Obtém as informações sobre a existência de crianças em um site
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato – uuid. Identificador exclusivo de espaço |
Obtém as informações sobre a existência de crianças em um telhado
Obtém as informações sobre a existência de crianças em um telhado
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato – uuid. Identificador exclusivo de espaço |
Obtém as informações sobre a existência de crianças em uma fachada
Obtém as informações sobre a existência de crianças em uma fachada
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato – uuid. Identificador exclusivo de espaço |
Obtém as informações sobre a existência de crianças em uma subárea
Obtém as informações sobre a existência de crianças em uma subárea
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato – uuid. Identificador exclusivo de espaço |
Obtém as informações sobre a existência de crianças em uma terra
Obtém as informações sobre a existência de crianças em uma terra
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato – uuid. Identificador exclusivo de espaço |
Obtém as informações sobre a existência de crianças em uma área externa
Obtém as informações sobre a existência de crianças em uma área externa
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato – uuid. Identificador exclusivo de espaço |
Obtém as informações sobre a existência de filhos em um portfólio
Obtém as informações sobre a existência de filhos em um portfólio
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato – uuid. Identificador exclusivo de espaço |
Obtém um andar com a ID fornecida
Obtém um andar com a ID fornecida
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato – uuid. Identificador exclusivo de espaço |
Retornos
- Corpo
- Floor
Obtém um buidling com a ID fornecida
Obtém um prédio com a ID fornecida
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato – uuid. Identificador exclusivo de espaço |
Retornos
- Corpo
- Building
Obtém um espaço com a ID fornecida
Obtém um espaço com a ID fornecida
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato – uuid. Identificador exclusivo de espaço |
Retornos
- Corpo
- Space
Obtém um portfólio com a ID fornecida
Obtém um portfólio com a ID fornecida
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato – uuid. Identificador exclusivo de espaço |
Retornos
- Corpo
- Portfolio
Obtém um site com a ID fornecida
Obtém um site com a ID fornecida
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato – uuid. Identificador exclusivo de espaço |
Retornos
- Corpo
- Site
Obtém um teto com a ID fornecida
Obtém um teto com a ID fornecida
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato – uuid. Identificador exclusivo de espaço |
Retornos
- Corpo
- Roof
Obtém uma fachada com a ID fornecida
Obtém uma fachada com a ID fornecida
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato – uuid. Identificador exclusivo de espaço |
Retornos
- Corpo
- Facade
Obtém uma subárea com a ID fornecida
Obtém uma subárea com a ID fornecida
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato – uuid. Identificador exclusivo de espaço |
Retornos
- Corpo
- Subarea
Obtém uma terra com a ID fornecida
Obtém uma terra com a ID fornecida
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato – uuid. Identificador exclusivo de espaço |
Retornos
- Corpo
- Land
Obtém uma área externa com a ID fornecida
Obtém uma área externa com a ID fornecida
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato – uuid. Identificador exclusivo de espaço |
Retornos
- Corpo
- Outsidearea
Definições
CurrencyValueType
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
value
|
value | number | |
|
unidade
|
unit | string |
AreaValueType
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
value
|
value | number | |
|
unidade
|
unit | string | |
|
metricValue
|
metricValue | number |
LocationPathType
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
title
|
title | string | |
|
tipo
|
type | string |
LocationPathArrayType
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
LocationPathType |
SpaceTypeOfUseEnum
OutsideAreaType
Tipo de Entidade
SpaceTypeOfOwnership
AddressType
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid |
deve ser definido em solicitações POST/PUT para endereços existentes somente nos casos em que o endereço existente foi adicionado aqui em vez de matriz de IDs |
|
tipo
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Somente leitura |
|
changedBy
|
changedBy | string |
Somente leitura |
|
rua
|
street | string | |
|
houseNumber
|
houseNumber | string | |
|
postalCode
|
postalCode | string | |
|
city
|
city | string | |
|
country
|
country | string |
Códigos de país iso 3166-1 alfa-3, por exemplo, CAN, EUA, DEU |
|
região
|
region | string | |
|
Fuso horário
|
timeZone | string | |
|
Caixa postal
|
postBox | string | |
|
postBoxPostCode
|
postBoxPostCode | string | |
|
phone
|
phone | string | |
|
ID externo
|
externalId | uuid |
A ID externa do endereço deve ser gerada no lado do cliente ao criar um novo endereço |
|
latitude
|
latitude | float |
Coordenada laditiude para endereço |
|
longitude
|
longitude | float |
Coordenada de longitude para endereço |
Pasta
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
tipo
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Somente leitura |
|
changedBy
|
changedBy | string |
Somente leitura |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tid
|
tid | uuid |
identificador de locatário |
|
title
|
title | string | |
|
descrição
|
description | string | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
proprietário
|
owner | string | |
|
buildingGrossArea
|
buildingGrossArea | AreaValueType | |
|
landGrossArea
|
landGrossArea | AreaValueType | |
|
associatedLandIds
|
associatedLandIds | array of uuid | |
|
associatedBuildingIds
|
associatedBuildingIds | array of uuid |
Site
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
tipo
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Somente leitura |
|
changedBy
|
changedBy | string |
Somente leitura |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tid
|
tid | uuid |
identificador de locatário |
|
title
|
title | string | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
buildingGrossArea
|
buildingGrossArea | AreaValueType | |
|
outsideareaGrossArea
|
outsideareaGrossArea | AreaValueType | |
|
mainAddressExternalId
|
mainAddressExternalId | uuid |
externalId de um dos endereços da coleção linkedAddresses deve ser colocada aqui para tornar o endereço principal |
|
endereços
|
addresses | array of AddressType | |
|
typeOfSite
|
typeOfSite | SpaceTypeOfUseEnum | |
|
imageIds
|
imageIds | array of uuid | |
|
internalId
|
internalId | uuid | |
|
furtherInformation
|
furtherInformation | string |
Compilando
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
tipo
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Somente leitura |
|
changedBy
|
changedBy | string |
Somente leitura |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tid
|
tid | uuid |
identificador de locatário |
|
associatedPortfolioId
|
associatedPortfolioId | uuid | |
|
ID do pai
|
parentId | uuid | |
|
associatedLandIds
|
associatedLandIds | array of uuid | |
|
title
|
title | string | |
|
internalId
|
internalId | uuid | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
endereços
|
addresses | array of AddressType | |
|
responsiblePeopleFullName
|
responsiblePeopleFullName | string | |
|
typeOfOwnership
|
typeOfOwnership | SpaceTypeOfOwnership | |
|
typeOfBuilding
|
typeOfBuilding | string | |
|
imageIds
|
imageIds | array of uuid | |
|
furtherInformation
|
furtherInformation | string | |
|
constructionYear
|
constructionYear | date | |
|
yearOfLastRefurbishment
|
yearOfLastRefurbishment | date | |
|
grossArea
|
grossArea | AreaValueType | |
|
buildingPurchaseCost
|
buildingPurchaseCost | CurrencyValueType | |
|
hasMonumentProtection
|
hasMonumentProtection | boolean | |
|
numberOfFloors
|
numberOfFloors | integer | |
|
numberOf BasementFloors
|
numberOf BasementFloors | integer |
Andar
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
tipo
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Somente leitura |
|
changedBy
|
changedBy | string |
Somente leitura |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tid
|
tid | uuid |
identificador de locatário |
|
title
|
title | string | |
|
ID do pai
|
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
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
tipo
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Somente leitura |
|
changedBy
|
changedBy | string |
Somente leitura |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tid
|
tid | uuid |
identificador de locatário |
|
title
|
title | string | |
|
ID do pai
|
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 |
Telhado
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
tipo
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Somente leitura |
|
changedBy
|
changedBy | string |
Somente leitura |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tid
|
tid | uuid |
identificador de locatário |
|
title
|
title | string | |
|
ID do pai
|
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 |
Fachada
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
tipo
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Somente leitura |
|
changedBy
|
changedBy | string |
Somente leitura |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tid
|
tid | uuid |
identificador de locatário |
|
title
|
title | string | |
|
ID do pai
|
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
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
tipo
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Somente leitura |
|
changedBy
|
changedBy | string |
Somente leitura |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tid
|
tid | uuid |
identificador de locatário |
|
title
|
title | string | |
|
ID do pai
|
parentId | uuid | |
|
internalId
|
internalId | uuid | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
furtherInformation
|
furtherInformation | string | |
|
typeOfOutsideArea
|
typeOfOutsideArea | OutsideAreaType | |
|
grossArea
|
grossArea | AreaValueType |
Terra
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
tipo
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Somente leitura |
|
changedBy
|
changedBy | string |
Somente leitura |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tid
|
tid | uuid |
identificador de locatário |
|
title
|
title | string | |
|
ID do pai
|
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 |
Subzona
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
tipo
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Somente leitura |
|
changedBy
|
changedBy | string |
Somente leitura |
|
locationPath
|
locationPath | LocationPathArrayType | |
|
Tid
|
tid | uuid |
identificador de locatário |
|
title
|
title | string | |
|
ID do pai
|
parentId | uuid | |
|
internalId
|
internalId | uuid | |
|
validFrom
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
furtherInformation
|
furtherInformation | string |
PortfolioTypeWithPagination
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Portfolio |
SiteTypeWithPagination
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Site |
BuildingTypeWithPagination
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Building |
FloorTypeWithPagination
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Floor |
RoofsTypeWithPagination
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Roof |
FacadesTypeWithPagination
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Facade |
OutsideareasTypeWithPagination
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Outsidearea |
SubareasTypeWithPagination
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Subarea |
LandsTypeWithPagination
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Land |
SpacesTypeWithPagination
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Space |
AssociatedSpacesTypeWithPagination
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
totalCount
|
totalCount | integer | |
|
items
|
items | array of Space |