BuildingMinds DigitalTwin Core (Pré-visualização)
A plataforma principal do BuildingMinds fornece APIs REST. Com a API BuildingMinds DigitalTwin Core, você pode ler e listar os dados mestres do Digital Building Twin, como edifícios, andares e espaços e suas propriedades.
Este conector está disponível nos seguintes produtos e regiões:
| Serviço | Class | Regiões |
|---|---|---|
| Estúdio Copiloto | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicações Lógicas | Standard | Todas as regiões do Logic Apps , exceto as seguintes: - Regiões do Azure Government - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Aplicações Power | Premium | Todas as regiões do Power Apps , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Automatize o poder | Premium | Todas as regiões do Power Automatic , exceto as seguintes: - Governo dos EUA (CCG) - Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Suporte BuildingMinds |
| URL | https://buildingminds.com/services/customer-support |
| support@buildingminds.com |
| Metadados do conector | |
|---|---|
| Editora | BuildingMinds |
| Sítio Web | https://buildingminds.com/ |
| Política de privacidade | https://buildingminds.com/privacy-policy |
| Categorias | Data |
O BuildingMinds Digital Twin Core Connector conecta todas as fontes de dados através 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 é a configuração de um fluxo de trabalho automatizado entre o BuildingMinds Digital Twin Core Connector e um sistema ERP para obter dados up-toatualizados de seus edifícios.
Obter dados de endereço para vários edifícios
- Para obter os dados mestre 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 do objeto que deseja transferir para o sistema ERP. Para obter mais informações, consulte Propriedades de resposta em Endereços.
Obter dados de endereço para um edifício específico
- Obtenha o ID do edifício para o 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 deseja transferir. Para obter mais informações, consulte Propriedades de resposta em Endereços.
Obtenha todos os edifícios que pertencem a um portfólio
- Obtenha o ID do portfólio para o qual você deseja obter os edifícios associados usando a ação
GetPortfolios. - Use a ação
GetPortfolioById. - Selecione a propriedade
associatedBuildingIdsresponse .
Resposta
Edifício
Propriedades
| Nome | Description |
|---|---|
id |
Identificador único para o edifício dentro da plataforma BuildingMinds. |
type |
Tipo de objeto. Neste caso, o tipo de objeto é um edifício. |
tid |
Identificador do locatário |
title |
Nome do edifício |
validFrom |
Data a partir da qual o edifício é válido. |
validTo |
Data até à qual o edifício é válido. |
changedBy |
Identificador de utilizador do utilizador que alterou o edifício. |
changedOn |
Data em que o edifício foi alterado pela última vez. |
createdOn |
Data de criação do edifício. |
internalId |
Identificador definido pelo utilizador. |
externalId |
Identificador único de um sistema externo usado como um aplicativo de terceiros na plataforma BuildingMinds. |
locationPath |
Contém o id, type, e title do local ao qual pertence o edifício. |
imageIds |
Quando as imagens são carregadas para o edifício, os identificadores de imagem são exibidos. |
parentId |
Identificador do local a que pertence o edifício. |
typeOfBuilding |
Tipo de edifício como Escritório ou Residencial. |
typeOfOwnership |
Tipo de propriedade como Freehold ou Part-ownership. |
associatedLandIds |
Terrenos que estão associados a este edifício. |
constructionYear |
Ano em que o edifício 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 existam vários endereços guardados 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 único para o edifício dentro da plataforma BuildingMinds. |
type |
Tipo de objeto. Nesse caso, o tipo de objeto é um endereço. |
tid |
Identificador do 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 |
Código postal ou código postal |
city |
City |
country |
Country |
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 foi bem-sucedida. |
latitude |
Coordenadas geográficas do endereço. |
longitude |
Coordenadas geográficas do endereço. |
region |
Região |
continent |
Continent |
Portefólio
Propriedades
| Nome | Description |
|---|---|
id |
Identificador único para o portfólio dentro da plataforma BuildingMinds. |
type |
Tipo de objeto. Nesse caso, o tipo de objeto é um portfólio. |
createdOn |
Data de criação da carteira. |
changedOn |
Data em que a carteira foi alterada pela última vez. |
changedBy |
Identificador de usuário do usuário que alterou o portfólio. |
title |
Nome do portfólio |
validFrom |
Data a partir da qual a carteira é válida. |
validTo |
Data até à qual a carteira é válida. |
owner |
Proprietário da carteira |
buildingGrossArea |
Objeto de área contendo as propriedades value, unite metricValue para todos os edifícios do portfólio. |
landGrossArea |
Objeto de área contendo as propriedades value, unite metricValue para todos os terrenos da carteira. |
internalId |
Identificador definido pelo utilizador. |
externalId |
Identificador único de um sistema externo usado como um aplicativo de terceiros na plataforma BuildingMinds. |
associatedBuildingIds |
Edifícios que estão associados a este portefólio. |
associatedLandIds |
Terrenos que estão associados a este portefólio. |
Limites de Limitação
| Name | Chamadas | Período de Renovação |
|---|---|---|
| Chamadas de API por conexão | 100 | 60 segundos |
Ações
| Obtenha todos os portfólios |
Obter todos os portfólios para os locatários do usuário conectado no momento |
| 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 com o espaço de outro tipo fornecido |
| Obter todas as fachadas |
Obter todas as fachadas para os locatários do usuário conectado no momento |
| Obter todas as subáreas |
Obter todas as subáreas para os locatários do usuário conectado no momento |
| Obter todas as terras |
Obter todos os terrenos 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 conectado 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 inquilinos do utilizador atualmente com sessão iniciada |
| Obter todos os espaços |
Obter todos os espaços para os locatários do usuário conectado no momento |
| Obter todos os sites |
Obter todos os sites para os locatários do usuário conectado no momento |
| Obter todos os telhados |
Obtenha todos os telhados para os locatários do usuário conectado no momento |
| Obtém a informação sobre a existência de crianças num andar |
Obtém a informação sobre a existência de crianças num andar |
| Obtém a informação sobre a existência de crianças num edifício |
Obtém a informação sobre a existência de crianças num edifício |
| Obtém a informação sobre a existência de crianças num espaço |
Obtém a informação sobre a existência de crianças num espaço |
| Obtém a informação sobre a existência de crianças num portefólio |
Obtém a informação sobre a existência de crianças num portefólio |
| Obtém a informação sobre a existência de crianças num site |
Obtém a informação sobre a existência de crianças num site |
| Obtém a informação sobre a existência de crianças num telhado |
Obtém a informação sobre a existência de crianças num telhado |
| Obtém a informação sobre a existência de crianças numa fachada |
Obtém a informação sobre a existência de crianças numa fachada |
| Obtém a informação sobre a existência de crianças numa terra |
Obtém a informação sobre a existência de crianças numa terra |
| Obtém a informação sobre a existência de crianças numa área exterior |
Obtém a informação sobre a existência de crianças numa área exterior |
| 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 um buidling com o ID fornecido |
Obtém um edifício com o ID fornecido |
| Obtém um espaço com o ID fornecido |
Obtém um espaço com o ID fornecido |
| Obtém um piso com o ID fornecido |
Obtém um piso com o ID fornecido |
| Obtém um portfólio com o ID fornecido |
Obtém um portfólio com o ID fornecido |
| Obtém um site com a ID fornecida |
Obtém um site com a ID fornecida |
| Obtém um telhado com o ID fornecido |
Obtém um telhado com o ID fornecido |
| Obtém um terreno com o ID fornecido |
Obtém um terreno com o ID fornecido |
| Obtém uma fachada com o ID fornecido |
Obtém uma fachada com o ID fornecido |
| Obtém uma subárea com o ID fornecido |
Obtém uma subárea com o ID fornecido |
| Obtém uma área externa com o ID fornecido |
Obtém uma área externa com o ID fornecido |
Obtenha todos os portfólios
Obter todos os portfólios para os locatários do usuário conectado no momento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Parar
|
$top | string |
Este parâmetro é usado para paginação e determina o número máximo de itens que devem ser retornados do back-end. A predefinição é 20. |
|
|
Pular
|
$skip | string |
Este parâmetro é usado para paginação e marca o ponto de partida para pegar os itens. O padrão é 0 |
Devoluções
Obter a lista de entidades associadas
Obter a lista de espaços de determinado tipo associados à entidade de espaço fornecida
Parâmetros
| Name | Chave | Necessá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 único do espaço |
|
Tipo Associado
|
associatedType | True | string |
Descreve o tipo de espaço associado |
|
Pular
|
$skip | string |
Este parâmetro é usado para paginação e marca o ponto de partida para pegar os itens. O padrão é 0 |
|
|
Parar
|
$top | string |
Este parâmetro é usado para paginação e determina o número máximo de itens que devem ser retornados do back-end. A predefinição é 20. |
Devoluções
Obter a lista de entidades não associadas
Obter a lista de espaços de determinado tipo que não estão associados com o espaço de outro tipo fornecido
Parâmetros
| Name | Chave | Necessá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 do espaço associado a incluir nos resultados |
Obter todas as fachadas
Obter todas as fachadas para os locatários do usuário conectado no momento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Parar
|
$top | string |
Este parâmetro é usado para paginação e determina o número máximo de itens que devem ser retornados do back-end. A predefinição é 20. |
|
|
Pular
|
$skip | string |
Este parâmetro é usado para paginação e marca o ponto de partida para pegar os itens. O padrão é 0 |
Devoluções
Obter todas as subáreas
Obter todas as subáreas para os locatários do usuário conectado no momento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Parar
|
$top | string |
Este parâmetro é usado para paginação e determina o número máximo de itens que devem ser retornados do back-end. A predefinição é 20. |
|
|
Pular
|
$skip | string |
Este parâmetro é usado para paginação e marca o ponto de partida para pegar os itens. O padrão é 0 |
Devoluções
Obter todas as terras
Obter todos os terrenos para os locatários do usuário conectado no momento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Parar
|
$top | string |
Este parâmetro é usado para paginação e determina o número máximo de itens que devem ser retornados do back-end. A predefinição é 20. |
|
|
Pular
|
$skip | string |
Este parâmetro é usado para paginação e marca o ponto de partida para pegar os itens. O padrão é 0 |
Devoluções
Obter todas as áreas externas
Obter todas as áreas externas para os locatários do usuário conectado no momento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Parar
|
$top | string |
Este parâmetro é usado para paginação e determina o número máximo de itens que devem ser retornados do back-end. A predefinição é 20. |
|
|
Pular
|
$skip | string |
Este parâmetro é usado para paginação e marca o ponto de partida para pegar os itens. O padrão é 0 |
Devoluções
Obter todos os andares
Obter todos os andares para os locatários do usuário conectado no momento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Parar
|
$top | string |
Este parâmetro é usado para paginação e determina o número máximo de itens que devem ser retornados do back-end. A predefinição é 20. |
|
|
Pular
|
$skip | string |
Este parâmetro é usado para paginação e marca o ponto de partida para pegar os itens. O padrão é 0 |
Devoluções
Obter todos os edifícios
Obter todos os edifícios para os inquilinos do utilizador atualmente com sessão iniciada
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Parar
|
$top | string |
Este parâmetro é usado para paginação e determina o número máximo de itens que devem ser retornados do back-end. A predefinição é 20. |
|
|
Pular
|
$skip | string |
Este parâmetro é usado para paginação e marca o ponto de partida para pegar os itens. O padrão é 0 |
Devoluções
Obter todos os espaços
Obter todos os espaços para os locatários do usuário conectado no momento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Parar
|
$top | string |
Este parâmetro é usado para paginação e determina o número máximo de itens que devem ser retornados do back-end. A predefinição é 20. |
|
|
Pular
|
$skip | string |
Este parâmetro é usado para paginação e marca o ponto de partida para pegar os itens. O padrão é 0 |
Devoluções
Obter todos os sites
Obter todos os sites para os locatários do usuário conectado no momento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Parar
|
$top | string |
Este parâmetro é usado para paginação e determina o número máximo de itens que devem ser retornados do back-end. A predefinição é 20. |
|
|
Pular
|
$skip | string |
Este parâmetro é usado para paginação e marca o ponto de partida para pegar os itens. O padrão é 0 |
Devoluções
Obter todos os telhados
Obtenha todos os telhados para os locatários do usuário conectado no momento
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
Parar
|
$top | string |
Este parâmetro é usado para paginação e determina o número máximo de itens que devem ser retornados do back-end. A predefinição é 20. |
|
|
Pular
|
$skip | string |
Este parâmetro é usado para paginação e marca o ponto de partida para pegar os itens. O padrão é 0 |
Devoluções
Obtém a informação sobre a existência de crianças num andar
Obtém a informação sobre a existência de crianças num andar
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato - uuid. Identificador único do espaço |
Obtém a informação sobre a existência de crianças num edifício
Obtém a informação sobre a existência de crianças num edifício
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato - uuid. Identificador único do espaço |
Obtém a informação sobre a existência de crianças num espaço
Obtém a informação sobre a existência de crianças num espaço
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato - uuid. Identificador único do espaço |
Obtém a informação sobre a existência de crianças num portefólio
Obtém a informação sobre a existência de crianças num portefólio
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato - uuid. Identificador único do espaço |
Obtém a informação sobre a existência de crianças num site
Obtém a informação sobre a existência de crianças num site
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato - uuid. Identificador único do espaço |
Obtém a informação sobre a existência de crianças num telhado
Obtém a informação sobre a existência de crianças num telhado
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato - uuid. Identificador único do espaço |
Obtém a informação sobre a existência de crianças numa fachada
Obtém a informação sobre a existência de crianças numa fachada
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato - uuid. Identificador único do espaço |
Obtém a informação sobre a existência de crianças numa terra
Obtém a informação sobre a existência de crianças numa terra
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato - uuid. Identificador único do espaço |
Obtém a informação sobre a existência de crianças numa área exterior
Obtém a informação sobre a existência de crianças numa área exterior
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato - uuid. Identificador único do 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
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato - uuid. Identificador único do espaço |
Obtém um buidling com o ID fornecido
Obtém um edifício com o ID fornecido
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato - uuid. Identificador único do espaço |
Devoluções
- Body
- Building
Obtém um espaço com o ID fornecido
Obtém um espaço com o ID fornecido
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato - uuid. Identificador único do espaço |
Devoluções
- Body
- Space
Obtém um piso com o ID fornecido
Obtém um piso com o ID fornecido
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato - uuid. Identificador único do espaço |
Devoluções
- Body
- Floor
Obtém um portfólio com o ID fornecido
Obtém um portfólio com o ID fornecido
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato - uuid. Identificador único do espaço |
Devoluções
- Body
- Portfolio
Obtém um site com a ID fornecida
Obtém um site com a ID fornecida
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato - uuid. Identificador único do espaço |
Devoluções
- Body
- Site
Obtém um telhado com o ID fornecido
Obtém um telhado com o ID fornecido
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato - uuid. Identificador único do espaço |
Devoluções
- Body
- Roof
Obtém um terreno com o ID fornecido
Obtém um terreno com o ID fornecido
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato - uuid. Identificador único do espaço |
Devoluções
- Body
- Land
Obtém uma fachada com o ID fornecido
Obtém uma fachada com o ID fornecido
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato - uuid. Identificador único do espaço |
Devoluções
- Body
- Facade
Obtém uma subárea com o ID fornecido
Obtém uma subárea com o ID fornecido
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato - uuid. Identificador único do espaço |
Devoluções
- Body
- Subarea
Obtém uma área externa com o ID fornecido
Obtém uma área externa com o ID fornecido
Parâmetros
| Name | Chave | Necessário | Tipo | Description |
|---|---|---|---|---|
|
ID do espaço
|
id | True | string |
Formato - uuid. Identificador único do espaço |
Devoluções
- Body
- Outsidearea
Definições
CurrencyValueType
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
valor
|
value | number | |
|
unidade
|
unit | string |
AreaValueType
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
valor
|
value | number | |
|
unidade
|
unit | string | |
|
metricValue
|
metricValue | number |
LocationPathType
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | string | |
|
title
|
title | string | |
|
tipo
|
type | string |
LocationPathArrayType
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
Itens
|
LocationPathType |
SpaceTypeOfUseEnum
OutsideAreaType
Tipo de entidade
EspaçoTipoDePropriedade
EndereçoType
| Name | 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 da matriz ids |
|
tipo
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Somente leitura |
|
AlteradoPor
|
changedBy | string |
Somente leitura |
|
rua
|
street | string | |
|
número da casa
|
houseNumber | string | |
|
postalCode
|
postalCode | string | |
|
city
|
city | string | |
|
country
|
country | string |
ISO 3166-1 alpha-3 Códigos de país, por exemplo, CAN, EUA, DEU |
|
região
|
region | string | |
|
Fuso horário
|
timeZone | string | |
|
Caixa postal
|
postBox | string | |
|
postBoxCódigo Postal
|
postBoxPostCode | string | |
|
phone
|
phone | string | |
|
Id externo
|
externalId | uuid |
ID externo de endereço, deve ser gerado em um lado do cliente ao criar novo endereço |
|
latitude
|
latitude | float |
Coordenada Laditiude para endereço |
|
longitude
|
longitude | float |
coordenadas de longitude para o endereço |
Portefólio
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
tipo
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Somente leitura |
|
AlteradoPor
|
changedBy | string |
Somente leitura |
|
localizaçãoCaminho
|
locationPath | LocationPathArrayType | |
|
TID
|
tid | uuid |
identificador do locatário |
|
title
|
title | string | |
|
descrição
|
description | string | |
|
validDe
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
proprietário
|
owner | string | |
|
edifícioÁrea Bruta
|
buildingGrossArea | AreaValueType | |
|
terrenoÁrea Bruta
|
landGrossArea | AreaValueType | |
|
associatedLandIds
|
associatedLandIds | array of uuid | |
|
associatedBuildingIds
|
associatedBuildingIds | array of uuid |
Site
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
tipo
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Somente leitura |
|
AlteradoPor
|
changedBy | string |
Somente leitura |
|
localizaçãoCaminho
|
locationPath | LocationPathArrayType | |
|
TID
|
tid | uuid |
identificador do locatário |
|
title
|
title | string | |
|
validDe
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
edifícioÁrea Bruta
|
buildingGrossArea | AreaValueType | |
|
área externaÁrea bruta
|
outsideareaGrossArea | AreaValueType | |
|
mainAddressExternalId
|
mainAddressExternalId | uuid |
externalId de um dos endereços da coleção linkedAddresses deve ser colocado aqui para tornar o endereço principal |
|
addresses
|
addresses | array of AddressType | |
|
tipoOfSite
|
typeOfSite | SpaceTypeOfUseEnum | |
|
imageIds
|
imageIds | array of uuid | |
|
Id interno
|
internalId | uuid | |
|
Mais informações:
|
furtherInformation | string |
Edifício
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
tipo
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Somente leitura |
|
AlteradoPor
|
changedBy | string |
Somente leitura |
|
localizaçãoCaminho
|
locationPath | LocationPathArrayType | |
|
TID
|
tid | uuid |
identificador do locatário |
|
associatedPortfolioId
|
associatedPortfolioId | uuid | |
|
parentId
|
parentId | uuid | |
|
associatedLandIds
|
associatedLandIds | array of uuid | |
|
title
|
title | string | |
|
Id interno
|
internalId | uuid | |
|
validDe
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
addresses
|
addresses | array of AddressType | |
|
responsiblePeopleFullName
|
responsiblePeopleFullName | string | |
|
tipoDePropriedade
|
typeOfOwnership | SpaceTypeOfOwnership | |
|
tipodeEdifício
|
typeOfBuilding | string | |
|
imageIds
|
imageIds | array of uuid | |
|
Mais informações:
|
furtherInformation | string | |
|
construçãoAno
|
constructionYear | date | |
|
anoDeÚltimaRemodelação
|
yearOfLastRefurbishment | date | |
|
Área bruta
|
grossArea | AreaValueType | |
|
construçãoCompraCusto
|
buildingPurchaseCost | CurrencyValueType | |
|
hasMonumentProtection
|
hasMonumentProtection | boolean | |
|
númerodeandares
|
numberOfFloors | integer | |
|
númeroDe CavesPisos
|
numberOf BasementFloors | integer |
Andar
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
tipo
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Somente leitura |
|
AlteradoPor
|
changedBy | string |
Somente leitura |
|
localizaçãoCaminho
|
locationPath | LocationPathArrayType | |
|
TID
|
tid | uuid |
identificador do locatário |
|
title
|
title | string | |
|
parentId
|
parentId | uuid | |
|
Id interno
|
internalId | uuid | |
|
validDe
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
Mais informações:
|
furtherInformation | string | |
|
Área bruta
|
grossArea | AreaValueType | |
|
tipoOfFloor
|
typeOfFloor | string | |
|
imageIds
|
imageIds | array of uuid |
Espaço
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
tipo
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Somente leitura |
|
AlteradoPor
|
changedBy | string |
Somente leitura |
|
localizaçãoCaminho
|
locationPath | LocationPathArrayType | |
|
TID
|
tid | uuid |
identificador do locatário |
|
title
|
title | string | |
|
parentId
|
parentId | uuid | |
|
Id interno
|
internalId | uuid | |
|
validDe
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
Mais informações:
|
furtherInformation | string | |
|
imageIds
|
imageIds | array of uuid | |
|
Área bruta
|
grossArea | AreaValueType | |
|
tipoOfSpace
|
typeOfSpace | string |
Telhado
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
tipo
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Somente leitura |
|
AlteradoPor
|
changedBy | string |
Somente leitura |
|
localizaçãoCaminho
|
locationPath | LocationPathArrayType | |
|
TID
|
tid | uuid |
identificador do locatário |
|
title
|
title | string | |
|
parentId
|
parentId | uuid | |
|
Id interno
|
internalId | uuid | |
|
validDe
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
Mais informações:
|
furtherInformation | string | |
|
material
|
material | string | |
|
Área bruta
|
grossArea | AreaValueType | |
|
imageIds
|
imageIds | array of uuid |
Fachada
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
tipo
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Somente leitura |
|
AlteradoPor
|
changedBy | string |
Somente leitura |
|
localizaçãoCaminho
|
locationPath | LocationPathArrayType | |
|
TID
|
tid | uuid |
identificador do locatário |
|
title
|
title | string | |
|
parentId
|
parentId | uuid | |
|
Id interno
|
internalId | uuid | |
|
validDe
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
Mais informações:
|
furtherInformation | string | |
|
material
|
material | string | |
|
Área bruta
|
grossArea | AreaValueType | |
|
imageIds
|
imageIds | array of uuid |
Área exterior
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
tipo
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Somente leitura |
|
AlteradoPor
|
changedBy | string |
Somente leitura |
|
localizaçãoCaminho
|
locationPath | LocationPathArrayType | |
|
TID
|
tid | uuid |
identificador do locatário |
|
title
|
title | string | |
|
parentId
|
parentId | uuid | |
|
Id interno
|
internalId | uuid | |
|
validDe
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
Mais informações:
|
furtherInformation | string | |
|
tipoDeForaÁrea
|
typeOfOutsideArea | OutsideAreaType | |
|
Área bruta
|
grossArea | AreaValueType |
Terrenos
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
tipo
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Somente leitura |
|
AlteradoPor
|
changedBy | string |
Somente leitura |
|
localizaçãoCaminho
|
locationPath | LocationPathArrayType | |
|
TID
|
tid | uuid |
identificador do locatário |
|
title
|
title | string | |
|
parentId
|
parentId | uuid | |
|
Id interno
|
internalId | uuid | |
|
validDe
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
Mais informações:
|
furtherInformation | string | |
|
Área bruta
|
grossArea | AreaValueType | |
|
registoNúmerodeEscritura
|
registrationNumberOfDeed | array of string | |
|
Número do lote
|
plotNumber | array of string | |
|
subPlotNumber
|
subPlotNumber | array of string | |
|
servidãoPertença à Ação
|
easementBelongingToDeed | array of string | |
|
admissableSiteOccupancyIndex
|
admissableSiteOccupancyIndex | number | |
|
admissableCubicIndex
|
admissableCubicIndex | number | |
|
atualFloorSpaceIndex
|
actualFloorSpaceIndex | number | |
|
actualSiteOccupancyIndex
|
actualSiteOccupancyIndex | number | |
|
actualCubicIndex
|
actualCubicIndex | number | |
|
associatedPortfolioId
|
associatedPortfolioId | uuid | |
|
associatedBuildingIds
|
associatedBuildingIds | array of uuid |
Sub-área
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
id
|
id | uuid | |
|
tipo
|
type | EntityType | |
|
changedOn
|
changedOn | date |
Somente leitura |
|
AlteradoPor
|
changedBy | string |
Somente leitura |
|
localizaçãoCaminho
|
locationPath | LocationPathArrayType | |
|
TID
|
tid | uuid |
identificador do locatário |
|
title
|
title | string | |
|
parentId
|
parentId | uuid | |
|
Id interno
|
internalId | uuid | |
|
validDe
|
validFrom | date | |
|
validTo
|
validTo | date | |
|
Mais informações:
|
furtherInformation | string |
PortfolioTypeWithPagination
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
totalContagem
|
totalCount | integer | |
|
items
|
items | array of Portfolio |
SiteTypeWithPagination
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
totalContagem
|
totalCount | integer | |
|
items
|
items | array of Site |
BuildingTypeWithPagination
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
totalContagem
|
totalCount | integer | |
|
items
|
items | array of Building |
FloorTypeCompaginação
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
totalContagem
|
totalCount | integer | |
|
items
|
items | array of Floor |
TelhadosTipoCompaginação
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
totalContagem
|
totalCount | integer | |
|
items
|
items | array of Roof |
FachadasTipoCompaginação
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
totalContagem
|
totalCount | integer | |
|
items
|
items | array of Facade |
Áreas externasTipocomPaginação
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
totalContagem
|
totalCount | integer | |
|
items
|
items | array of Outsidearea |
SubáreasTipoCompaginação
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
totalContagem
|
totalCount | integer | |
|
items
|
items | array of Subarea |
LandsTypeWithPagination
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
totalContagem
|
totalCount | integer | |
|
items
|
items | array of Land |
SpacesTypeWithPagination
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
totalContagem
|
totalCount | integer | |
|
items
|
items | array of Space |
AssociatedSpacesTypeWithPagination
| Name | Caminho | Tipo | Description |
|---|---|---|---|
|
totalContagem
|
totalCount | integer | |
|
items
|
items | array of Space |