Olá, este tema contém os padrões MDM para documentos, tipos de relacionamentos de documentos, categoria de documentos e órgãos emissores de documentos.
Documentos (document)
-
Descrição
Esta entidade padroniza os seguintes atributos de documentos:- Id
- Nome
- Sigla
- País
- Tipo de relacionamento (pessoal, empresarial, fiscal ou veicular)
- Documento principal de identificação (pessoal ou empresarial)
- Característica de algum modal logístico
- Campo complemento (por exemplo, número do espelho para CNH)
-
Estrutura dos Campos
Campo Descrição Tipo Link dataId identificador do documento int name nome do documento string abbrev sigla do documento string countryMainDocument a) texto "identificação pessoal" no documento de identificação pessoal principal do país
b) texto" identificação empresarial" no documento de identificação empresarial principal do país
c) se em branco, significa que o documento não é o principal para identificação pessoal nem empresarial do paísstring countryId data.id (identificador) do país do documento int countryId countryName nome do país do documento string countryName docRelationId idata.id (identificador) do tipo de relacionamento do documento int docRelationId docRelationName nome do tipo de relacionamento do documento string docRelationName transportationTypeId [array] array de data.id (identificador) dos modais logísticos associados ao documento int transportationTypeId transportationTypeName [array] array de nome dos modais logísticos associados ao documento string transportationTypeName complement Objeto que informa dados adicionais para o documento (para cada documento podem existir dados adicionais) objeto complementName 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": "6408e4852fdf838348471ed5", "entityType": "document", "revision": 5, "dataIdentifierSetup": [ "name" ], "jsonSchema": { "title": "Document Schema", "required": [ "entityType", "revision", "data" ], "properties": { "entityType": { "title": "document", "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", "country", "docRelation" ], "properties": { "name": { "title": "Name of Document type.", "$id": "#/properties/data/properties/name", "type": "string", "minLength": 3, "maxLength": 200 }, "abbrev": { "title": "Abbreviation of document type.", "$id": "#/properties/data/properties/abbrev", "type": "string", "minLength": 2, "maxLength": 200 }, "countryMainDocument": { "title": "Shows if the document is the main for person or company for the country.", "$id": "#/properties/data/properties/countryMainDocument", "type": "string", "minLength": 2, "maxLength": 200 }, "country": { "$id": "#/properties/data/properties/country", "type": "object", "required": [ "dataId", "name" ], "properties": { "dataId": { "title": "Country id.", "$id": "#/properties/data/properties/country/dataId", "type": "integer" }, "name": { "title": "Country name", "$id": "#/properties/data/properties/country/name", "type": "string", "minLength": 2, "maxLength": 200 } } }, "docRelation": { "$id": "#/properties/data/properties/docRelation", "type": "object", "required": [ "dataId", "name" ], "properties": { "dataId": { "title": "Document relation id.", "$id": "#/properties/data/properties/docRelation/dataId", "type": "integer" }, "name": { "title": "Document relation name.", "$id": "#/properties/data/properties/docRelation/name", "type": "string", "minLength": 2, "maxLength": 200 } } }, "transportationType": { "$id": "#/properties/data/properties/transportationType", "type": "object", "properties": { "dataId": { "title": "Transportation type id (array).", "$id": "#/properties/data/properties/transportationType/dataId", "type": "array", "items": { "type": "integer" } }, "name ": { "title": "Transportation type name (array).", "$id": "#/properties/data/properties/transportationType/name", "type": "array", "items": { "type": "string", "minLength": 2, "maxLength": 200 } } } }, "complementName": { "title": "Additional data for this document", "$id": "#/properties/data/properties/complementName", "type": "string", "minLength": 3, "maxLength": 1024 }, "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": { "document": { "create": true, "update": true, "delete": true, "view": true } } }, "sensiblePropertiesPath": [], "effectiveDate": "2023-01-24T19:09:45.978Z", "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": "636fea3bdd04eb0288a17dfb", "entityType": "document", "revision": 1, "data": { "name": "Conhecimento de transporte eletrônico", "abbrev": "CT-e", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 4, "name": "documento fiscal" }, "transportationType": { "dataId": [ 1 ], "name": [ "Transporte rodoviário" ] }, "dataId": 1, "dataIdentifier": { "name": "Conhecimento de transporte eletrônico" } }, "createdAt": "2022-11-12T18:47:23.045Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:47:23.045Z" }, { "_id": "636fea46dd04eb0288a17dfd", "entityType": "document", "revision": 1, "data": { "name": "Manifesto eletrônico de documentos fiscais", "abbrev": "MDF-e", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 4, "name": "documento fiscal" }, "transportationType": { "dataId": [ 1 ], "name": [ "Transporte rodoviário" ] }, "dataId": 2, "dataIdentifier": { "name": "Manifesto eletrônico de documentos fiscais" } }, "createdAt": "2022-11-12T18:47:34.005Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:47:34.005Z" }, { "_id": "636fea50062b1fff9d9d02cb", "entityType": "document", "revision": 1, "data": { "name": "Nota fiscal eletrônica", "abbrev": "NF-e", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 4, "name": "documento fiscal" }, "dataId": 3, "dataIdentifier": { "name": "Nota fiscal eletrônica" } }, "createdAt": "2022-11-12T18:47:44.740Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:47:44.740Z" }, { "_id": "636fea65dd04eb0288a17dff", "entityType": "document", "revision": 1, "data": { "name": "Código identificador da operação de transporte", "abbrev": "CIOT", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 4, "name": "documento fiscal" }, "transportationType": { "dataId": [ 1 ], "name": [ "Transporte rodoviário" ] }, "dataId": 4, "dataIdentifier": { "name": "Código identificador da operação de transporte" } }, "createdAt": "2022-11-12T18:48:05.441Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:48:05.441Z" }, { "_id": "636fea6edd04eb0288a17e01", "entityType": "document", "revision": 1, "data": { "name": "Conhecimento de transporte rodoviário de cargas", "abbrev": "CTRC", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 4, "name": "documento fiscal" }, "transportationType": { "dataId": [ 1 ], "name": [ "Transporte rodoviário" ] }, "dataId": 5, "dataIdentifier": { "name": "Conhecimento de transporte rodoviário de cargas" } }, "createdAt": "2022-11-12T18:48:14.271Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:48:14.271Z" }, { "_id": "636fea7a062b1fff9d9d02cd", "entityType": "document", "revision": 1, "data": { "name": "Documento auxiliar de conhecimento de transporte eletrônico", "abbrev": "DACTE", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 4, "name": "documento fiscal" }, "transportationType": { "dataId": [ 1 ], "name": [ "Transporte rodoviário" ] }, "dataId": 6, "dataIdentifier": { "name": "Documento auxiliar de conhecimento de transporte eletrônico" } }, "createdAt": "2022-11-12T18:48:26.640Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:48:26.640Z" }, { "_id": "636fea84062b1fff9d9d02cf", "entityType": "document", "revision": 1, "data": { "name": "Documento auxiliar do manifesto eletrônico de documentos fiscais", "abbrev": "DAMDFE", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 4, "name": "documento fiscal" }, "transportationType": { "dataId": [ 1 ], "name": [ "Transporte rodoviário" ] }, "dataId": 7, "dataIdentifier": { "name": "Documento auxiliar do manifesto eletrônico de documentos fiscais" } }, "createdAt": "2022-11-12T18:48:36.202Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:48:36.202Z" }, { "_id": "636fea8f062b1fff9d9d02d1", "entityType": "document", "revision": 1, "data": { "name": "Documento auxiliar da nota fiscal eletrônica", "abbrev": "DANFE", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 4, "name": "documento fiscal" }, "dataId": 8, "dataIdentifier": { "name": "Documento auxiliar da nota fiscal eletrônica" } }, "createdAt": "2022-11-12T18:48:47.382Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:48:47.382Z" }, { "_id": "636fea98062b1fff9d9d02d3", "entityType": "document", "revision": 1, "data": { "name": "Dispensa do direito de regresso", "abbrev": "DRR", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 4, "name": "documento fiscal" }, "dataId": 9, "dataIdentifier": { "name": "Dispensa do direito de regresso" } }, "createdAt": "2022-11-12T18:48:56.941Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:48:56.941Z" }, { "_id": "636feaa5062b1fff9d9d02d5", "entityType": "document", "revision": 1, "data": { "name": "Pagamento eletrônico de frete", "abbrev": "PEF", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 4, "name": "documento fiscal" }, "transportationType": { "dataId": [ 1 ], "name": [ "Transporte rodoviário" ] }, "dataId": 10, "dataIdentifier": { "name": "Pagamento eletrônico de frete" } }, "createdAt": "2022-11-12T18:49:09.438Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:49:09.438Z" }, { "_id": "636feab1062b1fff9d9d02d7", "entityType": "document", "revision": 1, "data": { "name": "Plano de gerenciamento de risco", "abbrev": "PGR", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 4, "name": "documento fiscal" }, "transportationType": { "dataId": [ 1 ], "name": [ "Transporte rodoviário" ] }, "dataId": 11, "dataIdentifier": { "name": "Plano de gerenciamento de risco" } }, "createdAt": "2022-11-12T18:49:21.296Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:49:21.296Z" }, { "_id": "636feab9062b1fff9d9d02d9", "entityType": "document", "revision": 1, "data": { "name": "Seguro de Responsabilidade Civil Facultativa do Transportador Rodoviário", "abbrev": "RCF-DC", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 4, "name": "documento fiscal" }, "transportationType": { "dataId": [ 1 ], "name": [ "Transporte rodoviário" ] }, "dataId": 12, "dataIdentifier": { "name": "Seguro de Responsabilidade Civil Facultativa do Transportador Rodoviário" } }, "createdAt": "2022-11-12T18:49:29.723Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:49:29.723Z" }, { "_id": "636feac3062b1fff9d9d02db", "entityType": "document", "revision": 1, "data": { "name": "Seguro de responsabilidade civil do transportador rodoviário de cargas", "abbrev": "RCTR-C", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 4, "name": "documento fiscal" }, "transportationType": { "dataId": [ 1 ], "name": [ "Transporte rodoviário" ] }, "dataId": 13, "dataIdentifier": { "name": "Seguro de responsabilidade civil do transportador rodoviário de cargas" } }, "createdAt": "2022-11-12T18:49:39.385Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:49:39.385Z" }, { "_id": "636feaccdd04eb0288a17e03", "entityType": "document", "revision": 1, "data": { "name": "Recibo de pagamento de autônomo", "abbrev": "RPA", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 4, "name": "documento fiscal" }, "transportationType": { "dataId": [ 1 ], "name": [ "Transporte rodoviário" ] }, "dataId": 14, "dataIdentifier": { "name": "Recibo de pagamento de autônomo" } }, "createdAt": "2022-11-12T18:49:48.891Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:49:48.891Z" }, { "_id": "636feae2dd04eb0288a17e05", "entityType": "document", "revision": 1, "data": { "name": "Cadastro de pessoas físicas", "abbrev": "CPF", "countryMainDocument": "identificação pessoal", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 1, "name": "documento pessoal" }, "dataId": 16, "dataIdentifier": { "name": "Cadastro de pessoas físicas" } }, "createdAt": "2022-11-12T18:50:10.827Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:50:10.827Z" }, { "_id": "636feaeedd04eb0288a17e07", "entityType": "document", "revision": 1, "data": { "name": "Carteira de trabalho", "abbrev": "CTPS", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 1, "name": "documento pessoal" }, "dataId": 17, "dataIdentifier": { "name": "Carteira de trabalho" } }, "createdAt": "2022-11-12T18:50:22.705Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:50:22.705Z" }, { "_id": "636feaf8062b1fff9d9d02df", "entityType": "document", "revision": 1, "data": { "name": "Carteira nacional de habilitação", "abbrev": "CNH", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 1, "name": "documento pessoal" }, "dataId": 18, "dataIdentifier": { "name": "Carteira nacional de habilitação" } }, "createdAt": "2022-11-12T18:50:32.431Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:50:32.431Z" }, { "_id": "636feb00dd04eb0288a17e09", "entityType": "document", "revision": 1, "data": { "name": "Passaporte", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 1, "name": "documento pessoal" }, "dataId": 19, "dataIdentifier": { "name": "Passaporte" } }, "createdAt": "2022-11-12T18:50:40.626Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:50:40.626Z" }, { "_id": "636feb09dd04eb0288a17e0b", "entityType": "document", "revision": 1, "data": { "name": "Cadastro nacional de pessoas jurídicas", "abbrev": "CNPJ", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 2, "name": "documento empresarial" }, "dataId": 20, "dataIdentifier": { "name": "Cadastro nacional de pessoas jurídicas" } }, "createdAt": "2022-11-12T18:50:49.331Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:50:49.331Z" }, { "_id": "636feb12062b1fff9d9d02e1", "entityType": "document", "revision": 1, "data": { "name": "Cadastro na previdência social", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 1, "name": "documento pessoal" }, "dataId": 21, "dataIdentifier": { "name": "Cadastro na previdência social" } }, "createdAt": "2022-11-12T18:50:58.849Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:50:58.849Z" }, { "_id": "636feb19062b1fff9d9d02e3", "entityType": "document", "revision": 1, "data": { "name": "Certidão de casamento", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 1, "name": "documento pessoal" }, "dataId": 22, "dataIdentifier": { "name": "Certidão de casamento" } }, "createdAt": "2022-11-12T18:51:05.684Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:51:05.684Z" }, { "_id": "636feb23062b1fff9d9d02e5", "entityType": "document", "revision": 1, "data": { "name": "Certidão de nascimento", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 1, "name": "documento pessoal" }, "dataId": 23, "dataIdentifier": { "name": "Certidão de nascimento" } }, "createdAt": "2022-11-12T18:51:15.794Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:51:15.794Z" }, { "_id": "636feb2d062b1fff9d9d02e7", "entityType": "document", "revision": 1, "data": { "name": "Certificado de alistamento militar", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 1, "name": "documento pessoal" }, "dataId": 24, "dataIdentifier": { "name": "Certificado de alistamento militar" } }, "createdAt": "2022-11-12T18:51:25.390Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:51:25.390Z" }, { "_id": "636feb34dd04eb0288a17e0d", "entityType": "document", "revision": 1, "data": { "name": "Certificado de registro e licenciamento do veículo", "abbrev": "CRLV", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 3, "name": "documento do veículo" }, "dataId": 25, "dataIdentifier": { "name": "Certificado de registro e licenciamento do veículo" } }, "createdAt": "2022-11-12T18:51:32.700Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:51:32.700Z" }, { "_id": "636feb3f062b1fff9d9d02e9", "entityType": "document", "revision": 1, "data": { "name": "Alvará da vigilância sanitária", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 2, "name": "documento empresarial" }, "dataId": 26, "dataIdentifier": { "name": "Alvará da vigilância sanitária" } }, "createdAt": "2022-11-12T18:51:43.513Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:51:43.513Z" }, { "_id": "636feb4add04eb0288a17e0f", "entityType": "document", "revision": 1, "data": { "name": "Alvará de funcionamento", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 2, "name": "documento empresarial" }, "dataId": 27, "dataIdentifier": { "name": "Alvará de funcionamento" } }, "createdAt": "2022-11-12T18:51:54.037Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:51:54.037Z" }, { "_id": "636feb53062b1fff9d9d02eb", "entityType": "document", "revision": 1, "data": { "name": "Alvará do corpo de bombeiros", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 2, "name": "documento empresarial" }, "dataId": 28, "dataIdentifier": { "name": "Alvará do corpo de bombeiros" } }, "createdAt": "2022-11-12T18:52:03.308Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:52:03.308Z" }, { "_id": "636feb5d062b1fff9d9d02ed", "entityType": "document", "revision": 1, "data": { "name": "Contrato social", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 2, "name": "documento empresarial" }, "dataId": 29, "dataIdentifier": { "name": "Contrato social" } }, "createdAt": "2022-11-12T18:52:13.695Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:52:13.695Z" }, { "_id": "636feb66062b1fff9d9d02ef", "entityType": "document", "revision": 1, "data": { "name": "Inscrição estadual", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 2, "name": "documento empresarial" }, "dataId": 30, "dataIdentifier": { "name": "Inscrição estadual" } }, "createdAt": "2022-11-12T18:52:22.616Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:52:22.616Z" }, { "_id": "636feb6f062b1fff9d9d02f1", "entityType": "document", "revision": 1, "data": { "name": "Inscrição municipal", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 2, "name": "documento empresarial" }, "dataId": 31, "dataIdentifier": { "name": "Inscrição municipal" } }, "createdAt": "2022-11-12T18:52:31.151Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:52:31.151Z" }, { "_id": "636feb77dd04eb0288a17e11", "entityType": "document", "revision": 1, "data": { "name": "Licença ambiental", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 2, "name": "documento empresarial" }, "dataId": 32, "dataIdentifier": { "name": "Licença ambiental" } }, "createdAt": "2022-11-12T18:52:39.887Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:52:39.887Z" }, { "_id": "636feb81dd04eb0288a17e13", "entityType": "document", "revision": 1, "data": { "name": "Registro na junta comercial", "country": { "dataId": 76, "name": "Brasil" }, "docRelation": { "dataId": 2, "name": "documento empresarial" }, "dataId": 33, "dataIdentifier": { "name": "Registro na junta comercial" } }, "createdAt": "2022-11-12T18:52:49.435Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T18:52:49.435Z" } ], "page": 1, "limit": 100, "nextPageURL": "Last Page" }
Tipos de relacionamentos de documentos (docRelation)
-
Descrição
Esta entidade padroniza os seguintes atributos de tipos de relacionamentos de documentos:- Id
- Nome (pessoal, empresarial, fiscal ou veicular)
-
Estrutura dos Campos
Campo Descrição Tipo Link dataId Identificador do tipo de relacionamento de documento int name nome do tipo de relacionamento de documento 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": "6408e4852fdf838348471ed4", "entityType": "docRelation", "revision": 3, "dataIdentifierSetup": [ "name" ], "jsonSchema": { "title": "DocRelation Entity", "required": [ "entityType", "revision", "data" ], "properties": { "entityType": { "title": "This entity provides the default most commom model used at nstech Platform", "pattern": "^(.*)$", "$id": "#/properties/entityType", "type": "string" }, "revision": { "title": "An integer value", "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 docRelation type.", "$id": "#/properties/data/properties/name", "type": "string", "minLength": 1, "maxLenght": 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": { "docRelation": { "create": true, "update": true, "delete": true, "view": true } } }, "sensiblePropertiesPath": [], "effectiveDate": "2023-01-24T19:09:01.541Z", "status": true, "deleted": false } }
- Exemplo de retorno
-
Exemplo de chamada ao endpoint (GET) pela API get records by queryTemplate
- Retorno do exemplo
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": [ { "_id": "636fbe34dd04eb0288a17dc2", "entityType": "docRelation", "revision": 1, "data": { "name": "Documento pessoal", "dataId": 1, "dataIdentifier": { "name": "Documento pessoal" } }, "createdAt": "2022-11-12T15:39:32.924Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T15:39:32.924Z" }, { "_id": "636fbe3edd04eb0288a17dc4", "entityType": "docRelation", "revision": 1, "data": { "name": "Documento empresarial", "dataId": 2, "dataIdentifier": { "name": "Documento empresarial" } }, "createdAt": "2022-11-12T15:39:42.481Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T15:39:42.481Z" }, { "_id": "636fbe46dd04eb0288a17dc6", "entityType": "docRelation", "revision": 1, "data": { "name": "Documento do veículo", "dataId": 3, "dataIdentifier": { "name": "Documento do veículo" } }, "createdAt": "2022-11-12T15:39:50.745Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T15:39:50.745Z" }, { "_id": "636fbe4edd04eb0288a17dc8", "entityType": "docRelation", "revision": 1, "data": { "name": "Documento fiscal", "dataId": 4, "dataIdentifier": { "name": "Documento fiscal" } }, "createdAt": "2022-11-12T15:39:58.523Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T15:39:58.523Z" } ], "page": 1, "limit": 5, "nextPageURL": "Last Page" }
- Retorno do exemplo
-
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": "636fbe34dd04eb0288a17dc2", "entityType": "docRelation", "revision": 1, "data": { "name": "Documento pessoal", "dataId": 1, "dataIdentifier": { "name": "Documento pessoal" } }, "createdAt": "2022-11-12T15:39:32.924Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T15:39:32.924Z" }, { "_id": "636fbe3edd04eb0288a17dc4", "entityType": "docRelation", "revision": 1, "data": { "name": "Documento empresarial", "dataId": 2, "dataIdentifier": { "name": "Documento empresarial" } }, "createdAt": "2022-11-12T15:39:42.481Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T15:39:42.481Z" }, { "_id": "636fbe46dd04eb0288a17dc6", "entityType": "docRelation", "revision": 1, "data": { "name": "Documento do veículo", "dataId": 3, "dataIdentifier": { "name": "Documento do veículo" } }, "createdAt": "2022-11-12T15:39:50.745Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T15:39:50.745Z" }, { "_id": "636fbe4edd04eb0288a17dc8", "entityType": "docRelation", "revision": 1, "data": { "name": "Documento fiscal", "dataId": 4, "dataIdentifier": { "name": "Documento fiscal" } }, "createdAt": "2022-11-12T15:39:58.523Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T15:39:58.523Z" } ], "page": 1, "limit": 100, "nextPageURL": "Last Page" }
Categorias de documentos (docCategory)
-
Descrição
Esta entidade padroniza os seguintes atributos de categorias de documentos:- Id
- nome
- documento
-
Estrutura dos Campos
Campo Descrição Tipo Link dataId Identificador da categoria de documento int name nome da categoria de documento string documentId identificador do documento associado à categoria de documento int documentId documentAbbrev sigla do documento associado à categoria de documento string documentAbbrev documentName nome do documento associado à categoria de documento string documentName 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": "636ff23cce9d5627804ceb23", "entityType": "docCategory", "revision": 1, "data": { "name": "A", "document": { "dataId": 18, "abbrev": "CNH", "name": "Carteira nacional de habilitação" }, "dataId": 1, "dataIdentifier": { "name": "A" } }, "createdAt": "2022-11-12T19:21:32.966Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:21:32.966Z" }, { "_id": "636ff247ce9d5627804ceb25", "entityType": "docCategory", "revision": 1, "data": { "name": "B", "document": { "dataId": 18, "abbrev": "CNH", "name": "Carteira nacional de habilitação" }, "dataId": 2, "dataIdentifier": { "name": "B" } }, "createdAt": "2022-11-12T19:21:43.093Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:21:43.093Z" }, { "_id": "636ff24fce9d5627804ceb27", "entityType": "docCategory", "revision": 1, "data": { "name": "C", "document": { "dataId": 18, "abbrev": "CNH", "name": "Carteira nacional de habilitação" }, "dataId": 3, "dataIdentifier": { "name": "C" } }, "createdAt": "2022-11-12T19:21:51.013Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:21:51.013Z" }, { "_id": "636ff258ce9d5627804ceb29", "entityType": "docCategory", "revision": 1, "data": { "name": "D", "document": { "dataId": 18, "abbrev": "CNH", "name": "Carteira nacional de habilitação" }, "dataId": 4, "dataIdentifier": { "name": "D" } }, "createdAt": "2022-11-12T19:22:00.378Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:22:00.378Z" }, { "_id": "636ff28bcff33738b4078bf8", "entityType": "docCategory", "revision": 1, "data": { "name": "E", "document": { "dataId": 18, "abbrev": "CNH", "name": "Carteira nacional de habilitação" }, "dataId": 5, "dataIdentifier": { "name": "E" } }, "createdAt": "2022-11-12T19:22:51.410Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:22:51.410Z" }, { "_id": "636ff296cff33738b4078bfa", "entityType": "docCategory", "revision": 1, "data": { "name": "AB", "document": { "dataId": 18, "abbrev": "CNH", "name": "Carteira nacional de habilitação" }, "dataId": 6, "dataIdentifier": { "name": "AB" } }, "createdAt": "2022-11-12T19:23:02.015Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:23:02.015Z" }, { "_id": "636ff2afce9d5627804ceb2b", "entityType": "docCategory", "revision": 1, "data": { "name": "AC", "document": { "dataId": 18, "abbrev": "CNH", "name": "Carteira nacional de habilitação" }, "dataId": 7, "dataIdentifier": { "name": "AC" } }, "createdAt": "2022-11-12T19:23:27.263Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:23:27.263Z" }, { "_id": "636ff2b5ce9d5627804ceb2d", "entityType": "docCategory", "revision": 1, "data": { "name": "AD", "document": { "dataId": 18, "abbrev": "CNH", "name": "Carteira nacional de habilitação" }, "dataId": 8, "dataIdentifier": { "name": "AD" } }, "createdAt": "2022-11-12T19:23:33.938Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:23:33.938Z" }, { "_id": "636ff2c3ce9d5627804ceb2f", "entityType": "docCategory", "revision": 1, "data": { "name": "AE", "document": { "dataId": 18, "abbrev": "CNH", "name": "Carteira nacional de habilitação" }, "dataId": 9, "dataIdentifier": { "name": "AE" } }, "createdAt": "2022-11-12T19:23:47.995Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:23:47.995Z" } ], "page": 1, "limit": 100, "nextPageURL": "Last Page" }
- Exemplo de retorno
-
Exemplo de chamada ao endpoint (GET) pela API get records by queryTemplate
- Retorno do exemplo
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": [ { "_id": "636ff23cce9d5627804ceb23", "entityType": "docCategory", "revision": 1, "data": { "name": "A", "document": { "dataId": 18, "abbrev": "CNH", "name": "Carteira nacional de habilitação" }, "dataId": 1, "dataIdentifier": { "name": "A" } }, "createdAt": "2022-11-12T19:21:32.966Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:21:32.966Z" }, { "_id": "636ff247ce9d5627804ceb25", "entityType": "docCategory", "revision": 1, "data": { "name": "B", "document": { "dataId": 18, "abbrev": "CNH", "name": "Carteira nacional de habilitação" }, "dataId": 2, "dataIdentifier": { "name": "B" } }, "createdAt": "2022-11-12T19:21:43.093Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:21:43.093Z" }, { "_id": "636ff24fce9d5627804ceb27", "entityType": "docCategory", "revision": 1, "data": { "name": "C", "document": { "dataId": 18, "abbrev": "CNH", "name": "Carteira nacional de habilitação" }, "dataId": 3, "dataIdentifier": { "name": "C" } }, "createdAt": "2022-11-12T19:21:51.013Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:21:51.013Z" }, { "_id": "636ff258ce9d5627804ceb29", "entityType": "docCategory", "revision": 1, "data": { "name": "D", "document": { "dataId": 18, "abbrev": "CNH", "name": "Carteira nacional de habilitação" }, "dataId": 4, "dataIdentifier": { "name": "D" } }, "createdAt": "2022-11-12T19:22:00.378Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:22:00.378Z" }, { "_id": "636ff28bcff33738b4078bf8", "entityType": "docCategory", "revision": 1, "data": { "name": "E", "document": { "dataId": 18, "abbrev": "CNH", "name": "Carteira nacional de habilitação" }, "dataId": 5, "dataIdentifier": { "name": "E" } }, "createdAt": "2022-11-12T19:22:51.410Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:22:51.410Z" } ], "page": 1, "limit": 5, "nextPageURL": "https://dev.nstech.com.br:8080/platform/mdm-stg/platform/api/mdm-stg/entities/docCategory/queryByTemplate/all?page=2&limit=5" }
- Retorno do exemplo
-
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": "636ff23cce9d5627804ceb23", "entityType": "docCategory", "revision": 1, "data": { "name": "A", "document": { "dataId": 18, "abbrev": "CNH", "name": "Carteira nacional de habilitação" }, "dataId": 1, "dataIdentifier": { "name": "A" } }, "createdAt": "2022-11-12T19:21:32.966Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:21:32.966Z" }, { "_id": "636ff247ce9d5627804ceb25", "entityType": "docCategory", "revision": 1, "data": { "name": "B", "document": { "dataId": 18, "abbrev": "CNH", "name": "Carteira nacional de habilitação" }, "dataId": 2, "dataIdentifier": { "name": "B" } }, "createdAt": "2022-11-12T19:21:43.093Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:21:43.093Z" }, { "_id": "636ff24fce9d5627804ceb27", "entityType": "docCategory", "revision": 1, "data": { "name": "C", "document": { "dataId": 18, "abbrev": "CNH", "name": "Carteira nacional de habilitação" }, "dataId": 3, "dataIdentifier": { "name": "C" } }, "createdAt": "2022-11-12T19:21:51.013Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:21:51.013Z" }, { "_id": "636ff258ce9d5627804ceb29", "entityType": "docCategory", "revision": 1, "data": { "name": "D", "document": { "dataId": 18, "abbrev": "CNH", "name": "Carteira nacional de habilitação" }, "dataId": 4, "dataIdentifier": { "name": "D" } }, "createdAt": "2022-11-12T19:22:00.378Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:22:00.378Z" }, { "_id": "636ff28bcff33738b4078bf8", "entityType": "docCategory", "revision": 1, "data": { "name": "E", "document": { "dataId": 18, "abbrev": "CNH", "name": "Carteira nacional de habilitação" }, "dataId": 5, "dataIdentifier": { "name": "E" } }, "createdAt": "2022-11-12T19:22:51.410Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:22:51.410Z" }, { "_id": "636ff296cff33738b4078bfa", "entityType": "docCategory", "revision": 1, "data": { "name": "AB", "document": { "dataId": 18, "abbrev": "CNH", "name": "Carteira nacional de habilitação" }, "dataId": 6, "dataIdentifier": { "name": "AB" } }, "createdAt": "2022-11-12T19:23:02.015Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:23:02.015Z" }, { "_id": "636ff2afce9d5627804ceb2b", "entityType": "docCategory", "revision": 1, "data": { "name": "AC", "document": { "dataId": 18, "abbrev": "CNH", "name": "Carteira nacional de habilitação" }, "dataId": 7, "dataIdentifier": { "name": "AC" } }, "createdAt": "2022-11-12T19:23:27.263Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:23:27.263Z" }, { "_id": "636ff2b5ce9d5627804ceb2d", "entityType": "docCategory", "revision": 1, "data": { "name": "AD", "document": { "dataId": 18, "abbrev": "CNH", "name": "Carteira nacional de habilitação" }, "dataId": 8, "dataIdentifier": { "name": "AD" } }, "createdAt": "2022-11-12T19:23:33.938Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:23:33.938Z" }, { "_id": "636ff2c3ce9d5627804ceb2f", "entityType": "docCategory", "revision": 1, "data": { "name": "AE", "document": { "dataId": 18, "abbrev": "CNH", "name": "Carteira nacional de habilitação" }, "dataId": 9, "dataIdentifier": { "name": "AE" } }, "createdAt": "2022-11-12T19:23:47.995Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:23:47.995Z" } ], "page": 1, "limit": 100, "nextPageURL": "Last Page" }
Órgãos emissores de documentos (docIssuer)
-
Descrição
Esta entidade padroniza os seguintes atributos de órgãos emissores de documentos:- Id
- Nome
- Sigla
- País
-
Estrutura dos Campos
Campo Descrição Tipo Link dataId Identificador do órgão emissor de documento int name nome do órgão emissor de documento string abbrev sigla do órgão emissor de documento string countryId identificador do país do órgão emissor de documento int countryId countryName nome do país do órgão emissor de documento string countryName 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": "6408e4852fdf838348471ed4", "entityType": "docRelation", "revision": 3, "dataIdentifierSetup": [ "name" ], "jsonSchema": { "title": "DocRelation Entity", "required": [ "entityType", "revision", "data" ], "properties": { "entityType": { "title": "This entity provides the default most commom model used at nstech Platform", "pattern": "^(.*)$", "$id": "#/properties/entityType", "type": "string" }, "revision": { "title": "An integer value", "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 docRelation type.", "$id": "#/properties/data/properties/name", "type": "string", "minLength": 1, "maxLenght": 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": { "docRelation": { "create": true, "update": true, "delete": true, "view": true } } }, "sensiblePropertiesPath": [], "effectiveDate": "2023-01-24T19:09:01.541Z", "status": true, "deleted": false } }
- Exemplo de retorno
-
Exemplo de chamada ao endpoint (GET) pela API get records by queryTemplate
- Retorno do exemplo
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": [ { "_id": "636ff23cce9d5627804ceb23", "entityType": "docCategory", "revision": 1, "data": { "name": "A", "document": { "dataId": 18, "abbrev": "CNH", "name": "Carteira nacional de habilitação" }, "dataId": 1, "dataIdentifier": { "name": "A" } }, "createdAt": "2022-11-12T19:21:32.966Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:21:32.966Z" }, { "_id": "636ff247ce9d5627804ceb25", "entityType": "docCategory", "revision": 1, "data": { "name": "B", "document": { "dataId": 18, "abbrev": "CNH", "name": "Carteira nacional de habilitação" }, "dataId": 2, "dataIdentifier": { "name": "B" } }, "createdAt": "2022-11-12T19:21:43.093Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:21:43.093Z" }, { "_id": "636ff24fce9d5627804ceb27", "entityType": "docCategory", "revision": 1, "data": { "name": "C", "document": { "dataId": 18, "abbrev": "CNH", "name": "Carteira nacional de habilitação" }, "dataId": 3, "dataIdentifier": { "name": "C" } }, "createdAt": "2022-11-12T19:21:51.013Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:21:51.013Z" }, { "_id": "636ff258ce9d5627804ceb29", "entityType": "docCategory", "revision": 1, "data": { "name": "D", "document": { "dataId": 18, "abbrev": "CNH", "name": "Carteira nacional de habilitação" }, "dataId": 4, "dataIdentifier": { "name": "D" } }, "createdAt": "2022-11-12T19:22:00.378Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:22:00.378Z" }, { "_id": "636ff28bcff33738b4078bf8", "entityType": "docCategory", "revision": 1, "data": { "name": "E", "document": { "dataId": 18, "abbrev": "CNH", "name": "Carteira nacional de habilitação" }, "dataId": 5, "dataIdentifier": { "name": "E" } }, "createdAt": "2022-11-12T19:22:51.410Z", "deleted": false, "userCreator": "service-account-mdm", "updatedAt": "2022-11-12T19:22:51.410Z" } ], "page": 1, "limit": 5, "nextPageURL": "https://dev.nstech.com.br:8080/platform/mdm-stg/platform/api/mdm-stg/entities/docCategory/queryByTemplate/all?page=2&limit=5" }
- Retorno do exemplo
-
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": "63700ccdcff33738b407a779", "entityType": "docIssuer", "revision": 1, "dataId": 1, "dataIdentifier": { "name": "Secretaria de Segurança Pública-PR" }, "data": { "name": "Secretaria de Segurança Pública-PR", "abbrev": "SSP - PR", "country": { "dataId": 76, "name": "Brasil" } }, "createdAt": "2022-11-12T21:14:53.298Z", "deleted": false, "userCreator": "service-account-mdm" }, { "_id": "63700ccfce9d5627804d0460", "entityType": "docIssuer", "revision": 1, "dataId": 2, "dataIdentifier": { "name": "Secretaria de Segurança Pública-SC" }, "data": { "name": "Secretaria de Segurança Pública-SC", "abbrev": "SSP - SC", "country": { "dataId": 76, "name": "Brasil" } }, "createdAt": "2022-11-12T21:14:55.314Z", "deleted": false, "userCreator": "service-account-mdm" }, { "_id": "63700cd0ce9d5627804d0462", "entityType": "docIssuer", "revision": 1, "dataId": 3, "dataIdentifier": { "name": "Secretaria de Segurança Pública-RS" }, "data": { "name": "Secretaria de Segurança Pública-RS", "abbrev": "SSP - RS", "country": { "dataId": 76, "name": "Brasil" } }, "createdAt": "2022-11-12T21:14:56.810Z", "deleted": false, "userCreator": "service-account-mdm" }, { "_id": "63700cd2ce9d5627804d0464", "entityType": "docIssuer", "revision": 1, "dataId": 4, "dataIdentifier": { "name": "Secretaria de Segurança Pública-AC" }, "data": { "name": "Secretaria de Segurança Pública-AC", "abbrev": "SSP - AC", "country": { "dataId": 76, "name": "Brasil" } }, "createdAt": "2022-11-12T21:14:58.065Z", "deleted": false, "userCreator": "service-account-mdm" }, { "_id": "63700cd2ce9d5627804d0466", "entityType": "docIssuer", "revision": 1, "dataId": 5, "dataIdentifier": { "name": "Secretaria de Segurança Pública-AL" }, "data": { "name": "Secretaria de Segurança Pública-AL", "abbrev": "SSP - AL", "country": { "dataId": 76, "name": "Brasil" } }, "createdAt": "2022-11-12T21:14:58.942Z", "deleted": false, "userCreator": "service-account-mdm" } ], "page": 1, "limit": 5, "nextPageURL": "https://platform.nstech.com.br/api/mdm/entities/docIssuer/queryByTemplate/all?page=2&limit=5" }
Complemento (complement)
-
Descrição
Esta entidade padroniza os seguintes atributos de complemento de documentos:
Id e nome -
Estrutura dos Campos
Campo Descrição Tipo Link dataId identificador do complemento int name nome do complemento 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": "6408e4832fdf838348471ece", "entityType": "complement", "revision": 2, "dataIdentifierSetup": [ "name" ], "jsonSchema": { "title": "complement Entity", "required": [ "entityType", "revision", "data" ], "properties": { "entityType": { "title": "This entity provides the default most commom model used at nstech Platform", "pattern": "^(.*)$", "$id": "#/properties/entityType", "type": "string" }, "revision": { "title": "The review of this entity. An integer value.", "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/description of Complement.", "$id": "#/properties/data/properties/name", "type": "string", "minLength": 3, "maxLenght": 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": { "complement": { "create": true, "update": true, "delete": true, "view": true } } }, "sensiblePropertiesPath": [ "dataId", "name", "dataIdentifier" ], "effectiveDate": "2023-01-23T19:52:09.478Z", "status": true, "deleted": false } }
- Exemplo de retorno
-
Exemplo de chamada ao endpoint (GET) pela API get records by queryTemplate
- Retorno do exemplo
Clique em "JSON"{ "statusCode": 200, "success": true, "message": "Success", "document": [ { "_id": "63ceec27f055e538ed177138", "entityType": "complement", "revision": 1, "data": { "name": "Número espelho", "dataId": 1, "dataIdentifier": { "name": "Número espelho" } }, "createdAt": "2023-01-23T20:20:55.132Z", "updatedAt": "2023-01-23T20:20:55.132Z", "deleted": false, "userCreator": "service-account-mdm" }, { "_id": "63ceec27f055e538ed17713a", "entityType": "complement", "revision": 1, "data": { "name": "Número renach", "dataId": 2, "dataIdentifier": { "name": "Número renach" } }, "createdAt": "2023-01-23T20:20:55.152Z", "updatedAt": "2023-01-23T20:20:55.152Z", "deleted": false, "userCreator": "service-account-mdm" }, { "_id": "63ceec27f055e538ed17713c", "entityType": "complement", "revision": 1, "data": { "name": "Código de segurança", "dataId": 3, "dataIdentifier": { "name": "Código de segurança" } }, "createdAt": "2023-01-23T20:20:55.171Z", "updatedAt": "2023-01-23T20:20:55.171Z", "deleted": false, "userCreator": "service-account-mdm" } ], "page": 1, "limit": 5, "nextPageURL": "Last Page" }
- Retorno do exemplo
-
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": "63ceec27f055e538ed177138", "entityType": "complement", "revision": 1, "data": { "name": "Número espelho", "dataId": 1, "dataIdentifier": { "name": "Número espelho" } }, "createdAt": "2023-01-23T20:20:55.132Z", "updatedAt": "2023-01-23T20:20:55.132Z", "deleted": false, "userCreator": "service-account-mdm" } }