Esta categoria contém os padrões MDM para tipos de logradouro e tipos de imóvel
Tipos de logradouros (addressType)
-
Descrição
Esta entidade padroniza os seguintes atributos do tipo de logradouro:- Id
- nome
-
Estrutura dos Campos
Campo Descrição Tipo Link dataId Identificador do tipo de endereço int name nome do tipo de endereço string dataIdentifier identificador de unicidade da entidade string -
Como consultar ultima versão do schema da entidade
- Exemplo de retorno
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": { "_id": "6408e4812fdf838348471ec6", "entityType": "addressType", "revision": 3, "dataIdentifierSetup": [ "name" ], "jsonSchema": { "title": "", "required": [ "entityType", "revision", "data" ], "properties": { "entityType": { "title": "addressType entity", "pattern": "^(.*)$", "$id": "#/properties/entityType", "type": "string" }, "revision": { "title": "The review of this entity.", "default": 1, "$id": "#/properties/revision", "type": "integer" }, "data": { "title": "The composition of the document object", "$id": "#/properties/data", "type": "object", "required": [ "name" ], "properties": { "name": { "title": "Name of address type.", "$id": "#/properties/data/properties/name", "type": "string", "minLength": 3, "maxLength": 200 }, "dataId": { "title": "The Unique Key for a document of this entity. If you don't know, don't put this in the document and it will be generated automatically.", "$id": "#/properties/data/properties/dataId", "type": "integer" } } } }, "$id": "http://example.org/root.json#", "type": "object", "definitions": {}, "$schema": "http://json-schema.org/draft-07/schema#" }, "authDefinition": { "resources": { "addressType": { "create": true, "update": true, "delete": true, "view": true } } }, "sensiblePropertiesPath": [], "effectiveDate": "2023-01-25T19:11:08.831Z", "status": true, "deleted": false } }
- Exemplo de retorno
-
Exemplo de chamada ao endpoint (GET) pela API get records by queryTemplate
-
Exemplo de chamada ao endpoint (GET) usando “data id”
-
Exemplo de chamada ao endpoint (GET) usando “updatedAt”
-
Exemplo de retorno
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": [ { "_id": "636ffc28cff33738b4078ec6", "entityType": "addressType", "revision": 1, "data": { "name": "Aeroporto", "dataId": 1, "dataIdentifier": { "name": "Aeroporto" } }, "createdAt": "2022-11-12T20:03:52.125Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T20:03:52.125Z" }, { "_id": "636ffc31ce9d5627804cedb2", "entityType": "addressType", "revision": 1, "data": { "name": "Alameda", "dataId": 2, "dataIdentifier": { "name": "Alameda" } }, "createdAt": "2022-11-12T20:04:01.784Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T20:04:01.784Z" } ], "page": 1, "limit": 2, "nextPageURL": "https://dev.nstech.com.br:8080/platform/mdm-stg/platform/api/mdm-stg/entities/addressType/queryByTemplate/all?page=2&limit=2" }
Tipos de imóveis (propertyType)
-
Descrição
Esta entidade padroniza os seguintes atributos do tipo de moradia:- Id
- nome
-
Estrutura dos Campos
Campo Descrição Tipo Link dataId Identificador do tipo de imóvel int name nome do tipo de imóvel string dataIdentifier identificador de unicidade da entidade string -
Como consultar ultima versão do schema da entidade
- Exemplo de retorno
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": { "_id": "6408e4892fdf838348471ee1", "entityType": "propertyType", "revision": 3, "dataIdentifierSetup": [ "name" ], "jsonSchema": { "title": "", "required": [ "entityType", "revision", "data" ], "properties": { "entityType": { "title": "propertyType Entity", "pattern": "^(.*)$", "$id": "#/properties/entityType", "type": "string" }, "revision": { "title": "The review of this entity.", "default": 1, "$id": "#/properties/revision", "type": "integer" }, "data": { "title": "The composition of the document object.", "$id": "#/properties/data", "type": "object", "required": [ "name" ], "properties": { "name": { "title": "Name of property type.", "$id": "#/properties/data/properties/name", "type": "string", "minLength": 3, "maxLength": 200 }, "dataId": { "title": "The Unique Key for a document of this entity. If you don't know, don't put this in the document and it will be generated automatically.", "$id": "#/properties/data/properties/dataId", "type": "integer" } } } }, "$id": "http://example.org/root.json#", "type": "object", "definitions": {}, "$schema": "http://json-schema.org/draft-07/schema#" }, "authDefinition": { "resources": { "propertyType": { "create": true, "update": true, "delete": true, "view": true } } }, "sensiblePropertiesPath": [], "effectiveDate": "2023-01-25T17:57:41.900Z", "status": true, "deleted": false } }
- Exemplo de retorno
-
Exemplo de chamada ao endpoint (GET) pela API get records by queryTemplate
-
Exemplo de chamada ao endpoint (GET) usando “data id”
-
Exemplo de chamada ao endpoint (GET) usando “updatedAt”
-
Exemplo de retorno
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": [ { "_id": "636ffa45ce9d5627804ced6a", "entityType": "propertyType", "revision": 1, "data": { "name": "Apartamento", "dataId": 1, "dataIdentifier": { "name": "Apartamento" } }, "createdAt": "2022-11-12T19:55:49.453Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:55:49.453Z" }, { "_id": "636ffa4ecff33738b4078eab", "entityType": "propertyType", "revision": 1, "data": { "name": "Casa", "dataId": 2, "dataIdentifier": { "name": "Casa" } }, "createdAt": "2022-11-12T19:55:58.526Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:55:58.526Z" } ], "page": 1, "limit": 2, "nextPageURL": "https://dev.nstech.com.br:8080/platform/mdm-stg/platform/api/mdm-stg/entities/propertyType/queryByTemplate/all?page=2&limit=2" }