Autentica um usuário existente
Dados para autenticar o usuário
| login required | string Login do usuário |
| senha required | string <password> Senha do usuário |
| empresaId required | string <uuid> Empresa do usuário |
{- "login": "email@dominio.com",
- "senha": "Senha@123",
- "empresaId": "f879bd0e-3739-49c0-a511-6f805c44b567"
}{- "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
- "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
- "tokenType": "Bearer",
- "expiresIn": 86400
}Autentica um usuário externo
Dados para autenticar o usuário externo
| empresaId required | string <uuid> Empresa do usuário |
| parceiro required | string parceiro utilizado pelo usuário |
| token required | string token oferecido pelo parceiro |
{- "empresaId": "894b2725-ea06-4af5-b4bd-b94f67c4cf72",
- "parceiro": "OFFICE_365",
- "token": ""
}{- "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
- "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
- "tokenType": "Bearer",
- "expiresIn": 86400
}Renova o token de um usuário logado
Refresh token do usuário que deseja renovar o acesso
| tokenRenovado required | string Token para renovação |
{- "tokenRenovado": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}{- "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
- "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
- "tokenType": "Bearer",
- "expiresIn": 86400
}Solicita código para alterar a senha
Dados para recuperar senha
| usuario required | string login do usuário |
| empresaId required | string <uuid> Empresa do usuário |
{- "usuario": "login",
- "empresaId": "f879bd0e-3739-49c0-a511-6f805c44b567"
}{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Altera a senha usando código enviado por email
Dados para recuperar senha
| senha required | string <password> Senha do primeiro acesso |
| hash required | string Código de controle do banco |
| codigo required | string Código de controle da requisição |
| empresaId required | string <uuid> Empresa do usuário |
{- "senha": "admin123",
- "hash": "FCE86CDF7DBED14A8DB32F65F23BB5C9",
- "codigo": "123456",
- "empresaId": "f879bd0e-3739-49c0-a511-6f805c44b567"
}{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Cria uma senha de primeiro acesso para o usuário logar no sistema
Dados para criar a primeira senha
| senha required | string <password> Senha do primeiro acesso |
| hash required | string Código de controle do banco |
| codigo required | string Código de controle da requisição |
| empresaId required | string <uuid> Empresa do usuário |
{- "senha": "admin123",
- "hash": "FCE86CDF7DBED14A8DB32F65F23BB5C9",
- "codigo": "123456",
- "empresaId": "f879bd0e-3739-49c0-a511-6f805c44b567"
}{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Cria um usuário
Dados para criar o usuário
| nome required | string Nome do usuário |
| email required | string <email> Email do usuário |
| login required | string Login do usuário |
| perfil required | string <uuid> Tipo de perfil do usuário |
{- "nome": "Lucas Fonte",
- "email": "usuario@teeglobal.com.br",
- "login": "login",
- "perfil": "a223bb09-0a39-4c5d-a2ea-f4a4ae2fa53e"
}{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Lista todos os usuários
| pagina | integer Example: pagina=2 Página atual |
| tamanhoPagina | integer Example: tamanhoPagina=12 Tamanho da página |
| nome | string Example: nome=Felipe Naletto Nome do usuário a ser retornado |
| ativo | boolean Example: ativo=true Status do usuário |
| perfil | string Example: perfil=f6c99195-fee5-45a2-a7d1-03c40dc08872 Perfil do usuário a ser retornado |
{- "paginacao": {
- "pagina": 1,
- "tamanhoPagina": 10,
- "total": 200
}, - "itens": [
- {
- "id": "7a5a1e4c-317e-4abe-b302-b88639bb2ac0",
- "nome": "Felipe Naletto",
- "email": "email@teeglobal.com.br",
- "login": "login",
- "perfil": {
- "id": "7a5a1e4c-317e-4abe-b302-b88639bb2ac0",
- "nome": "Admin"
}, - "dataCriacao": "2022-03-21T17:32:28Z",
- "status": true
}
]
}Troca senha do usuário logado
Dados para trocar senha
| senhaAtual required | string senha atual do usuário logado |
| novaSenha required | string senha nova do usuário logado |
{- "senhaAtual": "admin123",
- "novaSenha": "@dmin321"
}{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Deleta usuário da base de dados
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id do usuário a ser deletado |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Bloqueia um usuário específico
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id do usuario a ser bloqueado |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Ativa um usuário específico
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id do usuário a ser ativado |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Altera o perfil de um usuário específico
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id do usuário a ser alterado |
Dados para atualizar o usuario
| perfil required | string <uuid> Perfil do usuário |
{- "perfil": "f6c99195-fee5-45a2-a7d1-03c40dc08872"
}{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Retorna os dados de customização da empresa
| url required | string Example: url=teeglobal.com.br URL do whitelabel a ser retornado |
{- "id": "b06e23e9-490e-419c-98b4-5ea3fbe39073",
- "corPrincipal": "#874A3D",
- "logo": "string",
- "canalNotificacao": [
- "EMAIL",
- "SMS"
], - "integracao": [
- {
- "id": "efc60910-b586-4411-91d2-bfbbd6232a7f",
- "integracao": "OFFICE_365",
- "dados": { }
}
]
}{- "autorizacoes": {
- "total": 55,
- "pendente": 5,
- "concedidas": 30,
- "revogado": 20
}, - "solicitacoes": {
- "total": 10,
- "abertas": 40,
- "emAndamento": 30,
- "concluidas": 10,
- "canceladas": 10
}, - "incidente": {
- "total": 40,
- "concluidos": 30,
- "rejeitados": 10
}
}Cria uma autorização
Dados para criar a autorização
| login required | string Login do criador da gestão de privacidade |
| email required | string Email da autorização |
| celular | string Celular da autorização |
| id_agente_tratamento | string <uuid> Id do agente de tratamento |
| numero_processo_id | string Id do numero do processo |
| canal_notificacao | Array of strings Items Enum: "EMAIL" "SMS" Canais de notificação que uma empresa pode usar |
| finalidade required | Array of strings |
| origem required | string Origem de envio da requisição |
| solicita_autorizacao required | boolean Informa se a deve solicitar ao usuário confirmar a autorização |
{- "login": "lucas.fonte@teeglobal.com.br",
- "email": "lucas.fonte@teeglobal.com.br",
- "celular": "19912345678",
- "id_agente_tratamento": "954b586e-c2d7-4ea3-8213-8c81b37ccdf1",
- "numero_processo_id": "7397089e-b8a8-4c78-bd30-9b52ab37a5a4",
- "canal_notificacao": [
- "EMAIL",
- "SMS"
], - "finalidade": [
- "36a3d8fc-fe94-410e-b4bb-ae922122c8fe"
], - "origem": "WEB",
- "solicita_autorizacao": false
}[- {
- "id_finalidade": "648e1385-5227-400a-a894-b5f650490768",
- "id_autorizacao": "648e1385-5227-400a-a894-b5f650490768"
}
]Lista todas as autorizações
| pagina | integer Example: pagina=2 Página atual |
| tamanhoPagina | integer Example: tamanhoPagina=12 Tamanho da página |
| login | string Example: login=123******00 login a ser retornado |
| classe | string Example: classe=e0f70f35-646e-4cd1-b695-1719419e79ea Classe a ser retornada |
| baseLegal | string Example: baseLegal=203442c8-2593-47c1-aff8-a48a09d23bf2 Base legal a ser retornada |
| finalidade | string Example: finalidade=203442c8-2593-47c1-aff8-a48a09d23bf2 Finalidade a ser retornada |
| origem | string Example: origem=APP Origem da gestão de privacidade |
| status | string Enum: "PENDENTE" "AUTORIZADO" "REVOGADO'" Status do autorização |
| excluido | boolean Example: excluido=true consta se a gestão de privacidade está excluido ou não |
string Example: email=emai*******.com email a ser retornado | |
| celular | string Example: celular=1991234578 celular a ser retornado |
{- "paginacao": {
- "pagina": 1,
- "tamanhoPagina": 10,
- "total": 200
}, - "itens": [
- {
- "id": "e2189d80-e30f-489e-bf5a-fe229cd3d4af",
- "login": "123******00",
- "email": "emai*******.com",
- "celular": "19912345678",
- "numero_processo_id": "3G353AF412",
- "agente_tratamento": {
- "id": "d7a12601-8a93-475a-91ee-48a7b104d5dd",
- "nome": "Colaborador"
}, - "canalNotificacao": [
- "EMAIL",
- "SMS"
], - "classe": {
- "id": "c1956c6e-4f9e-49c6-b27f-333400c07ca7",
- "nome": "Colaborador"
}, - "baseLegal": {
- "id": "dda05e4e-1f88-4850-bde6-ba1209f22328",
- "nome": "Consentimento do titular"
}, - "finalidade": {
- "id": "dda05e4e-1f88-4850-bde6-ba1209f22328",
- "nome": "Gestão de contrato",
- "prazo_retencao_determinado": {
- "quantidade": 2,
- "tipo": "DIAS"
}, - "prazo_retencao_notificacao": {
- "quantidade": 2,
- "quantidade_tipo": "DIAS",
- "intervalo": 2,
- "intervalo_tipo": "DIAS"
}
}, - "origem": "APP",
- "autorizado": true,
- "evidencia": "evidencia.pdf",
- "idUsuarioExclusao": "97e1884a-111c-458a-94d1-60b024d29561",
- "nomeUsuarioExclusao": "Paulo da Silva",
- "motivoExclusao": "Contrato encerrado",
- "criadoEm": "2022-07-22 06:21:39",
- "atualizadoEm": "2022-08-12 06:21:39",
- "excluidoEm": "2022-08-12 06:21:39",
- "autorizadoEm": "2022-08-12 06:21:39"
}
]
}Retorna uma autorização
| id required | string <uuid> Example: e2189d80-e30f-489e-bf5a-fe229cd3d4af id do objeto |
{- "id": "e2189d80-e30f-489e-bf5a-fe229cd3d4af",
- "login": "123******00",
- "email": "emai*******.com",
- "celular": "19912345678",
- "numero_processo_id": "3G353AF412",
- "agente_tratamento": {
- "id": "d7a12601-8a93-475a-91ee-48a7b104d5dd",
- "nome": "Colaborador"
}, - "canalNotificacao": [
- "EMAIL",
- "SMS"
], - "classe": {
- "id": "c1956c6e-4f9e-49c6-b27f-333400c07ca7",
- "nome": "Colaborador"
}, - "baseLegal": {
- "id": "dda05e4e-1f88-4850-bde6-ba1209f22328",
- "nome": "Consentimento do titular"
}, - "finalidade": {
- "id": "dda05e4e-1f88-4850-bde6-ba1209f22328",
- "nome": "Gestão de contrato",
- "prazo_retencao_determinado": {
- "quantidade": 2,
- "tipo": "DIAS"
}, - "prazo_retencao_notificacao": {
- "quantidade": 2,
- "quantidade_tipo": "DIAS",
- "intervalo": 2,
- "intervalo_tipo": "DIAS"
}
}, - "origem": "APP",
- "autorizado": true,
- "evidencia": "evidencia.pdf",
- "idUsuarioExclusao": "97e1884a-111c-458a-94d1-60b024d29561",
- "nomeUsuarioExclusao": "Paulo da Silva",
- "motivoExclusao": "Contrato encerrado",
- "criadoEm": "2022-07-22 06:21:39",
- "atualizadoEm": "2022-08-12 06:21:39",
- "excluidoEm": "2022-08-12 06:21:39",
- "autorizadoEm": "2022-08-12 06:21:39"
}Deleta gestão de privacidade da base de dados
| id required | string <uuid> Example: e2189d80-e30f-489e-bf5a-fe229cd3d4af Id da gestão de privacidade a ser deletada |
| motivo required | string Example: motivo=Lorem ipsum dolor sit amet motivo da exclusão |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Atualiza uma gestão de privacidade especifica
| id required | string <uuid> Example: e2189d80-e30f-489e-bf5a-fe229cd3d4af Id da gestão de privacidade a ser atualizada |
Dados para atualizar a gestão de privacidade
| status | boolean Consta o status da gestão de privacidade |
string | |
| celular | string |
{- "status": true,
- "email": "felipe@teeglobal.com.br",
- "celular": "19912345678"
}{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Deleta gestão de privacidade da base de dados
Dados da Autorização
| id required | Array of strings |
| motivo_exclusao required | string Motivo da exclusão da autorização. |
{- "id": [
- "string"
], - "motivo_exclusao": "Motivos internos da empresa"
}{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Criar várias autorizações atráves de uma planilha
Dados para criar as autorizacoes
| arquivo required | string Arquivo da planilha para criar autorizações |
required | Array of objects |
| id_agente_tratamento | string <uuid> Id do agente de tratamento |
| numero_processo_id | string Id do numero do processo |
| origem required | string Origem da autorização |
Array of objects | |
| solicita_autorizacao required | boolean se a autorização foi solicitada ou não |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Lista autorizações atráves de uma planilha
| id | string <uuid> Example: id=80cf33ee-f0a6-4294-87bb-634f5fc80a9c identificação da planilia |
| nomeArquivo | string Example: nomeArquivo=cliente.csv nome do arquivo |
| status | string Example: status=Sucesso status do arquivo |
| dataEnvioInicio | string <date> Example: dataEnvioInicio=2023-01-01 a primeira data cujo a mais antiga entre duas |
| dataEnvioFinal | string <date> Example: dataEnvioFinal=2023-01-10 a segunda data cujo a mais nova entre duas |
{- "paginacao": {
- "pagina": 1,
- "tamanhoPagina": 10,
- "total": 200
}, - "itens": [
- {
- "id": "0757bb8a-a534-47d4-89a0-399671e1b78b",
- "nomeArquivo": "cliente.csv",
- "quantidadeLinha": 16,
- "quantidadeLinhaProcessada": 18,
- "status": "SUCESSO",
- "criadoEm": "2022-05-10 15:45:00",
- "atualizadoEm": "2022-05-10 15:45:00"
}
]
}Obtem o erro da planilha selecionada
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id da planilha |
{- "itens": [
- {
- "id": "0cbad99c-0add-4ca8-88e0-58e065be7316",
- "numeroLinha": 2,
- "detalheErro": "ListaDaO3.csv",
- "criado_em": "2023-04-05T14:00:43.000Z"
}
]
}Lista autorizações do usuário final
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id do usuário |
{- "itens": [
- {
- "id": "f8ad6fb9-01de-11ed-b68b-02bfc6b4d41b",
- "nome": "Colaborador",
- "padrao": 1,
- "finalidade": [
- {
- "id": "1730d126-c1b1-4fa9-80e3-4c74f9e0226a",
- "nome": "Proteção de crédito",
- "descricao": "Motivo da coleta",
- "compartilhamento_externo": false,
- "anonimizacao": "SIM",
- "permite_revogar": false,
- "impacto_revogacao": "Impacto da revogação",
- "descricao_bloqueio": "Descrição do bloqueio",
- "prazo_retencao": "10 DIAS",
- "prazo_retencao_determinado": {
- "quantidade": 2,
- "tipo": "DIAS"
}, - "prazo_retencao_notificacao": {
- "quantidade": 2,
- "quantidade_tipo": "DIAS",
- "intervalo": 2,
- "intervalo_tipo": "DIAS"
}, - "armazenamento": [
- {
- "id": "401dadbb-ec77-40ba-98a0-fd77286bb807",
- "tipo": "PROPRIO",
- "nome": "AWS",
- "localizacao": "Brasil"
}
], - "operador": [
- {
- "id": "401dadbb-ec77-40ba-98a0-fd77286bb807",
- "nome": "Operador 01",
- "tipo": "OPERADOR",
- "pais": "Brasil"
}
], - "base_legal": {
- "id": "dda05e4e-1f88-4850-bde6-ba1209f22328",
- "nome": "Consentimento do titular"
}, - "tipos_dados": [
- {
- "id": "cdb27f67-b942-423a-b0d1-2f12185e983f",
- "nome": "Dados de endereço",
- "metadados": [
- {
- "id": "cdb27f67-b942-423a-b0d1-2f12185e983f",
- "nome": "CEP"
}
]
}
], - "autorizacao": {
- "id": "f8ad6fb9-01de-11ed-b68b-02bfc6b4d41b",
- "autorizado": true,
- "numero_processo_id": "3G353AF412",
- "agente_tratamento": {
- "id": "d7a12601-8a93-475a-91ee-48a7b104d5dd",
- "nome": "Colaborador"
}, - "criado_em": "2022-04-05 14:00:43",
- "atualizado_em": "2022-04-05 14:00:43"
}
}
]
}
]
}Atualiza um evidencia através de um arquivo
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id da autorização a ser atualizada |
Arquivo para atualizar a evidencia
| arquivo | string Arquivo da evidencia a ser adicionada |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Lista todas as bases legais
| ativo | boolean Example: ativo=true Status da base legal |
[- {
- "id": "3240b2b4-3a04-4410-9ce0-52333dc9ba93",
- "nome": "Consentimento do titular",
- "norma": "string",
- "indice": "string",
- "ativo": true,
- "statusMutavel": false,
- "criadoEm": "2022-07-28 14:41:40"
}
]Cria uma classe gestão de privacidade
Dados para criar a classe da gestão de privacidade
| nome required | string Nome da classe |
| descricao required | string Descrição da classe |
| solicita_autorizacao required | boolean Informa se a deve solicitar ao usuário confirmar a autorização |
| canal_notificacao required | Array of strings Items Enum: "EMAIL" "SMS" Canais de notificação das autorizações |
| notifica_pendencia required | boolean Se deve ser re-enviado o e-mail/sms, em caso de não resposta |
| notifica_intervalo required | number Intervalo em dias, que deve ser re-enviado o e-mail/sms, em caso de não resposta |
| exclusao_automatica required | boolean Se o registro de autorização deve ser excluido, em caso de não resposta |
| exclusao_automatica_limite required | number Por quantos dias o um registro pendente deve ficar armazenado |
{- "nome": "Colaborador",
- "descricao": "Lorem ipsum dolor sit amet",
- "solicita_autorizacao": false,
- "canal_notificacao": [
- "EMAIL",
- "SMS"
], - "notifica_pendencia": true,
- "notifica_intervalo": 5,
- "exclusao_automatica": true,
- "exclusao_automatica_limite": 30
}{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Lista todas as classes
| ativo | boolean Example: ativo=true Ativo |
[- {
- "id": "447e8c02-f451-4197-81f7-1d014f980105",
- "nome": "Colaborador",
- "descricao": "Descrição de Colaborador",
- "criadoEm": "2022-07-11 15:50:40",
- "padrao": true,
- "ativo": true,
- "solicita_autorizacao": false,
- "canal_notificacao": [
- "EMAIL",
- "SMS"
], - "notifica_pendencia": true,
- "notifica_intervalo": 5,
- "exclusao_automatica": true,
- "exclusao_automatica_limite": 30
}
]Detalhe de uma classe
| id required | string <uuid> Example: e2189d80-e30f-489e-bf5a-fe229cd3d4af Id da classe |
{- "id": "447e8c02-f451-4197-81f7-1d014f980105",
- "nome": "Colaborador",
- "descricao": "Descrição de Colaborador",
- "criadoEm": "2022-07-11 15:50:40",
- "padrao": true,
- "ativo": true,
- "solicita_autorizacao": false,
- "canal_notificacao": [
- "EMAIL",
- "SMS"
], - "notifica_pendencia": true,
- "notifica_intervalo": 5,
- "exclusao_automatica": true,
- "exclusao_automatica_limite": 30
}Atualiza uma classe específica
| id required | string <uuid> Example: e2189d80-e30f-489e-bf5a-fe229cd3d4af Id da classe a ser atualizada |
Dados para atualizar a classe
| nome required | string Nome da classe |
| descricao required | string Descrição da classe |
| solicita_autorizacao required | boolean Informa se a deve solicitar ao usuário confirmar a autorização |
| canal_notificacao required | Array of strings Items Enum: "EMAIL" "SMS" Canais de notificação das autorizações |
| notifica_pendencia required | boolean Se deve ser re-enviado o e-mail/sms, em caso de não resposta |
| notifica_intervalo required | number Intervalo em dias, que deve ser re-enviado o e-mail/sms, em caso de não resposta |
| exclusao_automatica required | boolean Se o registro de autorização deve ser excluido, em caso de não resposta |
| exclusao_automatica_limite required | number Por quantos dias o um registro pendente deve ficar armazenado |
{- "nome": "Colaborador",
- "descricao": "Lorem ipsum dolor sit amet",
- "solicita_autorizacao": false,
- "canal_notificacao": [
- "EMAIL",
- "SMS"
], - "notifica_pendencia": true,
- "notifica_intervalo": 5,
- "exclusao_automatica": true,
- "exclusao_automatica_limite": 30
}{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Bloqueia uma classe específica
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id da classe a ser bloqueada |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Ativa uma classe específica
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id da classe a ser ativa |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Exporta dados do usuário com base nas autorizações criadas a partir de uma classe
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id da classe |
Dados para exportar os dados do usuário
| email required | string Email para enviar os dados do usuário |
{- "email": "lucas.fonte@teeglobal.com.br"
}{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Cadastra finalidade para ser usada nos endpoints de gestão de privacidade
Dados para criar a finalidade da gestão de privacidade
| id_classe required | string ID da empresa, deve ser do tipo UUID. |
| id_base_legal required | string ID da empresa, deve ser do tipo UUID. |
| nome required | string Nome da finalidade. |
| descricao required | string Descrição da finalidade. |
| permite_revogar required | boolean Se permite revogar |
| impacto_revogacao | string Impacto da revogação |
| descricao_bloqueio | string Descrição do bloqueio |
| prazo_retencao | string Prazo de renteção |
object prazo de retencao determinado | |
object prazo de retencao notificacao | |
required | Array of objects Id do armazenamento. |
Array of objects Id do operador. | |
| compartilhamento_externo required | boolean Se o dado é compartilhado |
| anonimizacao required | string Enum: "SIM" "NAO" "PARCIAL" Se o dado é anonimizado |
required | Array of objects |
{- "id_classe": "f8ad6fb9-01de-11ed-b68b-02bfc6b4d41b",
- "id_base_legal": "f8ad6fb9-01de-11ed-b68b-02bfc6b4d41b",
- "nome": "Nome da finalidade",
- "descricao": "Descrição da finalidade",
- "permite_revogar": false,
- "impacto_revogacao": "Impacto da revogação",
- "descricao_bloqueio": "Descrição do bloqueio",
- "prazo_retencao": "10 anos",
- "prazo_retencao_determinado": {
- "quantidade": 2,
- "tipo": "DIAS"
}, - "prazo_retencao_notificacao": {
- "quantidade": 2,
- "quantidade_tipo": "DIAS",
- "intervalo": 2,
- "intervalo_tipo": "DIAS"
}, - "id_armazenamento": [
- {
- "id": "f8ad6fb9-01de-11ed-b68b-02bfc6b4d41b"
}
], - "id_operador": [
- {
- "id": "f8ad6fb9-01de-11ed-b68b-02bfc6b4d41b"
}
], - "compartilhamento_externo": false,
- "anonimizacao": "PARCIAL",
- "tipo_dados": [
- {
- "id": "f8ad6fb9-01de-11ed-b68b-02bfc6b4d41b",
- "nome": "Nome do metadado",
- "metadado": [
- {
- "id": "f8ad6fb9-01de-11ed-b68b-02bfc6b4d41b",
- "nome": "Nome do metadado"
}
]
}
]
}{- "id": "648e1385-5227-400a-a894-b5f650490768"
}Lista todas as finalidades
| ativo | boolean Example: ativo=true Status da finalidade |
| id_classe | string <uuid> Example: id_classe=cacf412e-de60-482c-b535-e27c6e56a5ed ID da classe |
| id_base_legal | string <uuid> Example: id_base_legal=cacf412e-de60-482c-b535-e27c6e56a5ed ID da base legal |
| permite_revogar | boolean Example: permite_revogar=true permissão da revogação do item |
{- "items": [
- {
- "id": "d95c5d7f-76fb-4bea-8315-181afb6aa3d2",
- "nome": "Lorem ipsum dollor sit amet",
- "ativo": true,
- "classe": {
- "id": "c1956c6e-4f9e-49c6-b27f-333400c07ca7",
- "nome": "Colaborador"
}, - "baseLegal": {
- "id": "dda05e4e-1f88-4850-bde6-ba1209f22328",
- "nome": "Consentimento do titular"
}, - "permiteRevogar": false,
- "impactoRevogacao": "Impacto da revogação",
- "descricaoBloqueio": "Descrição do bloqueio",
- "prazoRetencao": "10 DIAS",
- "prazo_retencao_determinado": {
- "quantidade": 2,
- "tipo": "DIAS"
}, - "prazo_retencao_notificacao": {
- "quantidade": 2,
- "quantidade_tipo": "DIAS",
- "intervalo": 2,
- "intervalo_tipo": "DIAS"
}, - "compartilhamentoExterno": false,
- "anonimizacao": "SIM",
- "armazenamento": [
- {
- "id": "401dadbb-ec77-40ba-98a0-fd77286bb807",
- "tipo": "PROPRIO",
- "nome": "AWS",
- "localizacao": "Brasil"
}
], - "operador": [
- {
- "id": "401dadbb-ec77-40ba-98a0-fd77286bb807",
- "nome": "Operador 01",
- "tipo": "OPERADOR",
- "pais": "Brasil"
}
], - "tipoDados": [
- {
- "id": "a50958f9-01df-11ed-b68b-02bfc6b4d41b",
- "nome": "Dados de endereço",
- "metadados": [
- {
- "id": "b7e0741b-5b81-4c6a-8d76-0c07d6a292ca",
- "nome": "Telefone",
- "sensivel": true
}
]
}
], - "criadoEm": "2022-04-05 14:00:43",
- "atualizadoEm": "2022-04-05 14:00:43"
}
]
}Retorna uma finalidade
| id required | string <uuid> Example: e2189d80-e30f-489e-bf5a-fe229cd3d4af Id da finalidade a ser retornada |
{- "id": "d95c5d7f-76fb-4bea-8315-181afb6aa3d2",
- "nome": "Lorem ipsum dollor sit amet",
- "ativo": true,
- "classe": {
- "id": "c1956c6e-4f9e-49c6-b27f-333400c07ca7",
- "nome": "Colaborador"
}, - "baseLegal": {
- "id": "dda05e4e-1f88-4850-bde6-ba1209f22328",
- "nome": "Consentimento do titular"
}, - "permiteRevogar": false,
- "impactoRevogacao": "Impacto da revogação",
- "descricaoBloqueio": "Descrição do bloqueio",
- "prazoRetencao": "10 DIAS",
- "prazo_retencao_determinado": {
- "quantidade": 2,
- "tipo": "DIAS"
}, - "prazo_retencao_notificacao": {
- "quantidade": 2,
- "quantidade_tipo": "DIAS",
- "intervalo": 2,
- "intervalo_tipo": "DIAS"
}, - "compartilhamentoExterno": false,
- "anonimizacao": "SIM",
- "armazenamento": [
- {
- "id": "401dadbb-ec77-40ba-98a0-fd77286bb807",
- "tipo": "PROPRIO",
- "nome": "AWS",
- "localizacao": "Brasil"
}
], - "operador": [
- {
- "id": "401dadbb-ec77-40ba-98a0-fd77286bb807",
- "nome": "Operador 01",
- "tipo": "OPERADOR",
- "pais": "Brasil"
}
], - "tipoDados": [
- {
- "id": "a50958f9-01df-11ed-b68b-02bfc6b4d41b",
- "nome": "Dados de endereço",
- "metadados": [
- {
- "id": "b7e0741b-5b81-4c6a-8d76-0c07d6a292ca",
- "nome": "Telefone",
- "sensivel": true
}
]
}
], - "criadoEm": "2022-04-05 14:00:43",
- "atualizadoEm": "2022-04-05 14:00:43"
}Atualiza uma finalidade específica
| id required | string <uuid> Example: e2189d80-e30f-489e-bf5a-fe229cd3d4af Id da gestão de privacidade a ser atualizada |
Dados para atualizar a gestão de privacidade
| id_classe required | string ID da empresa, deve ser do tipo UUID. |
| id_base_legal required | string ID da empresa, deve ser do tipo UUID. |
| nome required | string Nome da finalidade. |
| descricao required | string Descrição da finalidade. |
| permite_revogar required | boolean Se permite revogar |
| impacto_revogacao | string Impacto da revogação |
| descricao_bloqueio | string Descrição do bloqueio |
| prazo_retencao | string Prazo de renteção |
object prazo de retencao determinado | |
object prazo de retencao notificacao | |
required | Array of objects Id do armazenamento. |
Array of objects Id do operador. | |
| compartilhamento_externo required | boolean Se o dado é compartilhado |
| anonimizacao required | string Enum: "SIM" "NAO" "PARCIAL" Se o dado é anonimizado |
required | Array of objects |
{- "id_classe": "f8ad6fb9-01de-11ed-b68b-02bfc6b4d41b",
- "id_base_legal": "f8ad6fb9-01de-11ed-b68b-02bfc6b4d41b",
- "nome": "Nome da finalidade",
- "descricao": "Descrição da finalidade",
- "permite_revogar": false,
- "impacto_revogacao": "Impacto da revogação",
- "descricao_bloqueio": "Descrição do bloqueio",
- "prazo_retencao": "10 anos",
- "prazo_retencao_determinado": {
- "quantidade": 2,
- "tipo": "DIAS"
}, - "prazo_retencao_notificacao": {
- "quantidade": 2,
- "quantidade_tipo": "DIAS",
- "intervalo": 2,
- "intervalo_tipo": "DIAS"
}, - "id_armazenamento": [
- {
- "id": "f8ad6fb9-01de-11ed-b68b-02bfc6b4d41b"
}
], - "id_operador": [
- {
- "id": "f8ad6fb9-01de-11ed-b68b-02bfc6b4d41b"
}
], - "compartilhamento_externo": false,
- "anonimizacao": "PARCIAL",
- "tipo_dados": [
- {
- "id": "f8ad6fb9-01de-11ed-b68b-02bfc6b4d41b",
- "nome": "Nome do metadado",
- "metadado": [
- {
- "id": "f8ad6fb9-01de-11ed-b68b-02bfc6b4d41b",
- "nome": "Nome do metadado"
}
]
}
]
}{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Deleta finalidade da base de dados
| id required | string <uuid> Example: e2189d80-e30f-489e-bf5a-fe229cd3d4af Id da finalidade a ser deletada |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Bloqueia uma finalidade específica
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id da finalidade a ser bloqueada |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Ativa uma finalidade específica
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id da finalidade a ser ativa |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Lista todos os metadados
| ativo | boolean Example: ativo=true Status do metadados |
| nome | string Example: nome=RG do filho Nome do metadados |
[- {
- "id": "b7e0741b-5b81-4c6a-8d76-0c07d6a292ca",
- "nome": "Telefone",
- "descricao": "Descritivo do metadado telefone",
- "sensivel": true,
- "criadoEm": "2022-07-29 08:41:51",
- "ativo": true
}
]Lista todos os tipos de dados
| ativo | boolean Example: ativo=true Status do metadados |
| nome | string Example: nome=Dados bancários Nome do metadados |
[- {
- "id": "5739b393-eec8-46ad-addb-d4faa3fa2de7",
- "nome": "Dados de contato",
- "descricao": "Descritivo do Dados de contato",
- "metadados": [
- {
- "id": "b7e0741b-5b81-4c6a-8d76-0c07d6a292ca",
- "nome": "Telefone",
- "sensivel": true
}
], - "criadoEm": "2022-07-14 12:36:12",
- "ativo": true
}
]Lista todos os armazenamentos
| ativo | boolean Example: ativo=true Status do item |
| nome | string Example: nome=Documento Nome |
| tipo | string Example: tipo=Txt Tipo |
[- {
- "id": "cacf412e-de60-482c-b535-e27c6e56a5ed",
- "tipo": "Txt",
- "nome": "Documento",
- "localizacao": "Escritório",
- "ativo": true,
- "criadoEm": "2022-04-05 14:00:43",
- "atualizadoEm": "2022-04-05 14:00:43"
}
]Cria um armazenamento
Dados da armazenação
| tipo required | string tipo do armazenamento |
| nome required | string Nome do armazenamento |
| localizacao required | string Localização do armazenamento |
{- "tipo": "Documento",
- "nome": "Txt",
- "localizacao": "Escritório"
}{- "id": "648e1385-5227-400a-a894-b5f650490768"
}Atualiza um armazenamento específico
| id required | string <uuid> Example: e2189d80-e30f-489e-bf5a-fe229cd3d4af Id da gestão de privacidade a ser atualizada |
Dados para atualizar a gestão de privacidade
| tipo required | string Tipo do armazenamento. |
| nome required | string Nome do armazenamento. |
| localizacao required | string localização do armazenamento. |
{- "tipo": "Tipo do armazenamento",
- "nome": "Nome do armazenamento",
- "localizacao": "Local do armazenamento"
}{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Retorna um armazenamento
| id required | string <uuid> Example: e2189d80-e30f-489e-bf5a-fe229cd3d4af Id do armazenamento a ser retornada |
{- "id": "401dadbb-ec77-40ba-98a0-fd77286bb807",
- "tipo": "Tipo do armazenamento",
- "nome": "Nome do armazenamento",
- "localizacao": "Local do armazenamento",
- "ativo": true,
- "criadoEm": "2022-07-22 06:21:39",
- "atualizadoEm": "2022-08-12 06:21:39"
}Bloqueia um armazenamento específica
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id do Armazenamento a ser bloqueada |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Ativa um armazenamento específica
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id do Armazenamento a ser Ativa |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Cadastro um operador (Utilizar /v1/gestao-privacidade/agente-tratamento)
Dados do operador
| nome required | string Nome do operador |
| pais required | string Pais do operador |
{- "nome": "Nome do operador",
- "pais": "Pais do operador"
}{- "id": "648e1385-5227-400a-a894-b5f650490768"
}Lista todas os operadores (Utilizar /v1/gestao-privacidade/agente-tratamento)
| idEmpresa required | string <uuid> Example: idEmpresa=9ce0a2ca-1122-47e8-bfba-cf9c18cf2427 Id da empresa |
| ativo | boolean Example: ativo=true Status do item |
| nome | string Example: nome=Gustavo nome operador |
| pais | string Example: pais=Brasil pais do operador |
[- {
- "id": "3240b2b4-3a04-4410-9ce0-52333dc9ba93",
- "nome": "Consentimento do titular",
- "pais": "string",
- "ativo": true,
- "criadoEm": "2022-04-05 14:00:43",
- "atualizadoEm": "2022-04-05 14:00:43"
}
]Retorna um operador (Utilizar /v1/gestao-privacidade/agente-tratamento)
| id required | string <uuid> Example: e2189d80-e30f-489e-bf5a-fe229cd3d4af Id do operador a ser retornada |
{- "id": "3240b2b4-3a04-4410-9ce0-52333dc9ba93",
- "nome": "Consentimento do titular",
- "pais": "string",
- "ativo": true,
- "criadoEm": "2022-04-05 14:00:43",
- "atualizadoEm": "2022-04-05 14:00:43"
}Atualiza um operador específico (Utilizar /v1/gestao-privacidade/agente-tratamento)
| id required | string <uuid> Example: e2189d80-e30f-489e-bf5a-fe229cd3d4af Id do operador a ser atualizada |
Dados para atualizar o operador
| nome required | string Nome do Operador. |
| pais required | string Pais do operador. |
{- "nome": "Nome do operador",
- "pais": "Local do operador"
}{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Bloqueia um Operador específica (Utilizar /v1/gestao-privacidade/agente-tratamento)
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id do Operador a ser bloqueada |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Ativa um Operador específica (Utilizar /v1/gestao-privacidade/agente-tratamento)
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id do Operador a ser Ativa |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Exportar dados de autorização para e-mail
| login | string Example: login=123******00 login a ser retornado |
| classe | string Example: classe=e0f70f35-646e-4cd1-b695-1719419e79ea Classe a ser retornada |
| baseLegal | string Example: baseLegal=203442c8-2593-47c1-aff8-a48a09d23bf2 Base legal a ser retornada |
| finalidade | string Example: finalidade=203442c8-2593-47c1-aff8-a48a09d23bf2 Finalidade a ser retornada |
| origem | string Example: origem=APP Origem da gestão de privacidade |
| status | string Enum: "PENDENTE" "AUTORIZADO" "REVOGADO'" Status do autorização |
| excluido | boolean Example: excluido=true consta se a gestão de privacidade está excluido ou não |
string Example: email=emai*******.com email a ser retornado |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Retorna uma lista de usuarios com autorizacao
| pagina | integer Example: pagina=2 Página atual |
| tamanhoPagina | integer Example: tamanhoPagina=12 Tamanho da página |
| login | string Example: login=123******00 login do titular |
string Example: email=tiago@teeglobal.com.br e-mail do titular |
[- {
- "paginacao": {
- "pagina": 1,
- "tamanhoPagina": 10,
- "total": 200
}, - "itens": [
- {
- "id": "7a5a1e4c-317e-4abe-b302-b88639bb2ac0",
- "nome": "Felipe Naletto",
- "email": "email@teeglobal.com.br",
- "login": "login",
- "perfil": {
- "id": "7a5a1e4c-317e-4abe-b302-b88639bb2ac0",
- "nome": "Admin"
}, - "dataCriacao": "2022-03-21T17:32:28Z",
- "status": true
}
]
}
]Cria um agente tratamento
Dados da requisição
| tipo required | string Enum: "OPERADOR" "CONTROLADOR_CONJUNTO" "CONTROLADOR_INDIVIDUAL" tipo |
| nome required | string nome |
| logotipo | string nome |
| pais required | string pais |
| cnpj | string cnpj |
string | |
| telefone | string telefone |
| criticidade | string Enum: "MUITO_BAIXO" "BAIXO" "MODERADO" "ALTO" "MUITO_ALTO" criticidade |
| url | string url |
| publicoPrivado required | string Enum: "PUBLICO" "PRIVADO" publicoPrivado |
| observacao | string observacao |
{- "tipo": "OPERADOR",
- "nome": "AWS",
- "pais": "BRASIL",
- "cnpj": "12.123.123/0001-01",
- "email": "contato@teeglobal.com.br",
- "telefone": "(11) 1234-1234",
- "criticidade": "BAIXO",
- "publicoPrivado": "PRIVADO",
- "observacao": "Descrição......."
}
{- "id": "0e8352d9-467a-4cb8-aabf-cc6436df41ea"
}Lista os agente de tratamento
| ativo | boolean Example: ativo=true Filtro por ativo |
| nome | string Example: nome=Nome Filtro por nome |
| pais | string Example: pais=Pais Filtro por pais |
| criticidade | string Enum: "MUITO_BAIXO" "BAIXO" "MODERADO" "ALTO" "MUITO_ALTO" Example: criticidade=BAIXO Filtro por criticidade |
| tipo | string Enum: "OPERADOR" "CONTROLADOR_CONJUNTO" "CONTROLADOR_INDIVIDUAL" Example: tipo=OPERADOR Filtro por tipo |
{- "itens": [
- {
- "id": "0e8352d9-467a-4cb8-aabf-cc6436df41ea",
- "tipo": "OPERADOR",
- "nome": "AWS",
- "pais": "BRASIL",
- "cnpj": "12.123.123/0001-01",
- "email": "contato@teeglobal.com.br",
- "telefone": "(11) 1234-1234",
- "criticidade": "BAIXO",
- "publicoPrivado": "PRIVADO",
- "observacao": "Descrição.....",
- "ativo": true,
- "criadoEm": "2022-04-05 14:00:43",
- "atualizadoEm": "2022-04-05 14:00:43"
}
]
}Lista os agente tratamento padrão
| tipo required | string Enum: "OPERADOR" "CONTROLADOR_CONJUNTO" "CONTROLADOR_INDIVIDUAL" Example: tipo=OPERADOR Filtro por tipo |
{- "itens": [
- {
- "id": "0e8352d9-467a-4cb8-aabf-cc6436df41ea",
- "tipo": "OPERADOR",
- "nome": "AWS",
- "pais": "BRASIL"
}
]
}Retorna um agente de tratamento específico
| id required | string <uuid> Example: 0e8352d9-467a-4cb8-aabf-cc6436df41ea ID |
{- "id": "0e8352d9-467a-4cb8-aabf-cc6436df41ea",
- "tipo": "OPERADOR",
- "nome": "AWS",
- "pais": "BRASIL",
- "cnpj": "12.123.123/0001-01",
- "email": "contato@teeglobal.com.br",
- "telefone": "(11) 1234-1234",
- "criticidade": "BAIXO",
- "publicoPrivado": "PRIVADO",
- "observacao": "Descrição.....",
- "ativo": true,
- "criadoEm": "2022-04-05 14:00:43",
- "atualizadoEm": "2022-04-05 14:00:43"
}Atualiza um agente de tratamento
| id required | string <uuid> Example: 0e8352d9-467a-4cb8-aabf-cc6436df41ea ID |
Dados da requisição
| tipo required | string Enum: "OPERADOR" "CONTROLADOR_CONJUNTO" "CONTROLADOR_INDIVIDUAL" tipo |
| nome required | string nome |
| pais required | string pais |
| cnpj | string cnpj |
string | |
| telefone | string telefone |
| criticidade | string Enum: "MUITO_BAIXO" "BAIXO" "MODERADO" "ALTO" "MUITO_ALTO" criticidade |
| url | string url |
| publicoPrivado required | string Enum: "PUBLICO" "PRIVADO" publicoPrivado |
| observacao | string observacao |
{- "tipo": "OPERADOR",
- "nome": "AWS",
- "pais": "BRASIL",
- "cnpj": "12.123.123/0001-01",
- "email": "contato@teeglobal.com.br",
- "telefone": "(11) 1234-1234",
- "criticidade": "BAIXO",
- "publicoPrivado": "PRIVADO",
- "observacao": "Descrição......."
}{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Ativa um agente de tratamento
| id required | string <uuid> Example: 0e8352d9-467a-4cb8-aabf-cc6436df41ea ID |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Bloqueia um agente de tratamento
| id required | string <uuid> Example: 0e8352d9-467a-4cb8-aabf-cc6436df41ea ID |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Apaga um contrato do agente de tratamento
| id required | string <uuid> Example: 0e8352d9-467a-4cb8-aabf-cc6436df41ea ID |
| idContrato required | string <uuid> Example: 0e8352d9-467a-4cb8-aabf-cc6436df41ea ID |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Retorna um contrato do agente de tratamento
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id do agente de tratamento |
| idContrato required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id do contrato |
{- "id": "0e8352d9-467a-4cb8-aabf-cc6436df41ea",
- "nome": "Nome",
- "realizaAvaliacao": "SIM",
- "arquivo": "evidencia.pdf",
- "criadoEm": "2022-04-05 14:00:43",
- "atualizadoEm": "2022-04-05 14:00:43"
}Adiciona uma avaliação ao agente de tratamento
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id do agente de tratamento |
Arquivo a ser adicionado
| nome | string Nome do arquivo |
| dataAvaliacao | string Data da avaliação |
| arquivo | string Arquivo |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Lista avaliação de agente de tratamento
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id do agente de tratamento |
{- "itens": [
- {
- "id": "3240b2b4-3a04-4410-9ce0-52333dc9ba93",
- "nome": "Avaliacao",
- "arquivo": "string",
- "avaliadoEm": "2022-04-05 14:00:43",
- "criadoEm": "2022-04-05 14:00:43",
- "atualizadoEm": "2022-04-05 14:00:43"
}
]
}Apaga uma avaliação do agente de tratamento
| id required | string <uuid> Example: 0e8352d9-467a-4cb8-aabf-cc6436df41ea ID |
| idAvaliacao required | string <uuid> Example: 0e8352d9-467a-4cb8-aabf-cc6436df41ea ID |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Retorna um contrato do agente de tratamento
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id do agente de tratamento |
| idAvaliacao required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id da avaliação |
{- "id": "0e8352d9-467a-4cb8-aabf-cc6436df41ea",
- "nome": "Nome",
- "arquivo": "evidencia.pdf",
- "avaliadoEm": "2022-04-05 14:00:43",
- "criadoEm": "2022-04-05 14:00:43",
- "atualizadoEm": "2022-04-05 14:00:43"
}Adiciona um logotipo ao agente de tratamento
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id do agente de tratamento |
Arquivo a ser adicionado
| arquivo | string Arquivo |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Adiciona um contrato ao agente de tratamento
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id do agente de tratamento |
Arquivo a ser adicionado
| nome | string Nome do arquivo |
| realizaAvaliacao | string Enum: "SIM" "NAO" "EM_ANDAMENTO" realiza avaliacao lgpd |
| arquivo | string Arquivo |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Lista contrato de agente de tratamento
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id do agente de tratamento |
{- "itens": [
- {
- "id": "3240b2b4-3a04-4410-9ce0-52333dc9ba93",
- "nome": "Consentimento do titular",
- "realizaAvaliacao": "SIM",
- "arquivo": "string",
- "criadoEm": "2022-04-05 14:00:43",
- "atualizadoEm": "2022-04-05 14:00:43"
}
]
}Cria uma incidente
Dados para criar o Incidente
| idResponsavel | string id do responsavel |
| idCriterio required | string id do criterio |
| idEstimativaTitularesAfetados required | string id da estimativa de titulares afetados |
required | Array of objects |
required | Array of objects |
required | object (SolicitatorRequest) |
| tipoDeComunicacao required | string Enum: "COMPLETA" "PRELIMINAR" "COMPLEMENTAR" tipo de comunicação |
| urgente | boolean urgencia |
| transnacionalizacaoDadosTitulares required | boolean transnacionalizacao dos dados titulares |
| descricao required | string descricao do incidente |
required | object (OccurrenceRequest) |
required | object (AwareRequest) |
required | object (ImmediateRequest) |
object (SecurityMeasureRequest) | |
| relatorioDeImpacto | boolean relatorio do impacto |
object (RiskRequest) | |
required | object (TitularRequest) |
| origem required | string origem do incidente |
{- "idResponsavel": "acdc1761-0f87-420d-8b71-2081043a0071",
- "idCriterio": "27d45b6b-c772-4869-98b6-da43eee18538",
- "idEstimativaTitularesAfetados": "b9702867-8a3e-419f-b8a8-d1f0c4190b0c",
- "idNaturezaDosDadosAfetados": [
- {
- "id": "f8ad6fb9-01de-11ed-b68b-02bfc6b4d41b"
}
], - "IdCategoriaDadosAfetados": [
- {
- "id": "f8ad6fb9-01de-11ed-b68b-02bfc6b4d41b"
}
], - "solicitante": {
- "documento": "doc",
- "nome": "Tiago Mendes",
- "telefone": "19991516481",
- "email": "contato@bhut.com.br"
}, - "tipoDeComunicacao": "PARCIAL",
- "urgente": true,
- "transnacionalizacaoDadosTitulares": true,
- "descricao": "descricao",
- "ocorrencia": {
- "quando": "NAO TENHO CONHECIMENTO",
- "data": "2022-05-10 12:13:14"
}, - "ciencia": {
- "como": "celular",
- "data": "2022-05-10 12:13:14"
}, - "imediata": {
- "status": true,
- "justificativa": "importante"
}, - "medidaSeguranca": {
- "prevencao": "seguranca",
- "apos": "seguranca",
- "reverter": "seguranca"
}, - "relatorioDeImpacto": true,
- "risco": {
- "consequencia": "consequncia",
- "consequenciaStatus": "status",
- "analise": "analise"
}, - "titular": {
- "comunicadoStatus": "SIM",
- "comunicadoDetalhe": "medida",
- "comunicadoJustificativa": "justificativa"
}, - "origem": "REGISTRO MANUAL"
}{- "id": "d6127920-267b-4a52-9f8e-ce497c1dd7cb"
}Lista todas os incidentes
| id | string Example: id=c4ae14f5-5f3b-45f4-b405-f134a9aefa737 Id |
| pagina | integer Example: pagina=2 Página atual |
| tamanhoPagina | integer Example: tamanhoPagina=12 Tamanho da página |
| idUsuarioResponsavel | string Example: idUsuarioResponsavel=739f0bf1-600a-49c1-a89e-59fe44ee9747 Id do usuario responsavel |
| status | string (StatusEnum) Enum: "TRIAGEM" "ABERTO" "INVESTIGACAO" "NOTIFICACAO" "CONCLUIDO" "REJEITADO" Filtro por status do incidente |
| origem | string (OriginEnum) Enum: "PORTAL" "INTERNO" Origem do incidente |
| tipoComunicacao | string (CommunicationTypeEnum) Enum: "COMPLETA" "PRELIMINAR" "COMPLEMENTAR" tipo de comunicação |
| nomeSolicitante | string Example: nomeSolicitante=Tiago Nome do solicitante |
| urgente | boolean Example: urgente=false Urgente |
| periodoInicio | string Example: periodoInicio=2022-05-10 periodo inicio |
| periodoFim | string Example: periodoFim=2022-05-10 periodo fim |
{- "paginacao": {
- "pagina": 1,
- "tamanhoPagina": 10,
- "total": 200
}, - "itens": [
- {
- "id": "26f5145e-4962-47ce-b8f5-ccc798fd9a5d",
- "solicitante": {
- "documento": "Documento do solicitante",
- "nome": "Nome do solicitante",
- "email": "Email do solicitante",
- "telefone": "Telefone do solicitante"
}, - "origem": "PORTAL",
- "tipoComunicacao": "COMPLETA",
- "riscoAnalise": "alta",
- "motivoDaRejeicao": {
- "0": "s",
- "1": "t",
- "2": "r",
- "3": "i",
- "4": "n",
- "5": "g",
- "id": "2ad5e321-5a8d-4904-924f-f0538e85e22e",
- "nome": "MOTIVO"
}, - "responsavel": {
- "id": "85062a34-f3b5-436c-9d06-9324c70fa501",
- "nome": "Nome responsavel"
}, - "status": "ABERTO",
- "urgente": true,
- "criterio": {
- "id": "85062a34-f3b5-436c-9d06-9324c70fa501",
- "nome": "Nome do criterio",
- "ativo": true
}, - "ocorrencia": {
- "quando": "Quando ocorrencia",
- "data": "2022-12-01 16:51:43"
}, - "estimativaTitularesAfetados": {
- "nome": "Milhões"
}, - "criadoEm": "2022-05-10 12:13:14",
- "atualizadoEm": "2022-05-10 12:13:14",
- "finalizado_em": "2022-04-05 14:00:43"
}
]
}Atualiza um incidente
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id do incidente a ser atualizada |
Dados para atualizar o incidente
| idUsuarioResponsavel | string <uuid> id do usuario responsavel |
| urgente | boolean urgencia |
| status | string Enum: "TRIAGEM" "ABERTO" "INVESTIGACAO" "NOTIFICACAO" "CONCLUIDO" "REJEITADO" Status do incidente |
| idMotivoDaRejeicao | string <uuid> id do motivo da rejeicao |
| descricaoDaRejeicao | string descricao da rejeicao |
{- "idUsuarioResponsavel": "e2189d80-e30f-489e-bf5a-fe229cd3d4af",
- "urgente": true,
- "status": "ABERTO",
- "idMotivoDaRejeicao": "2ad5e321-5a8d-4904-924f-f0538e85e22e",
- "descricaoDaRejeicao": "descricao"
}{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Retorna um incidente específica
| id required | string <uuid> Example: 111cae93-66bd-43cc-84b9-5b59c0016787 ID da incidente |
{- "id": "d95c5d7f-76fb-4bea-8315-181afb6aa3d2",
- "idEstimativaTitularesAfetados": "d95c5d7f-76fb-4bea-8315-181afb6aa3d2",
- "idResponsavel": "acdc1761-0f87-420d-8b71-2081043a0071",
- "criterio": {
- "id": "1507e9e7-cc3a-415b-b6a0-cefa1d4b9b61",
- "nome": "joao"
}, - "naturezaDosDadosAfetados": [
- {
- "id": "1507e9e7-cc3a-415b-b6a0-cefa1d4b9b61",
- "nome": "joao"
}
], - "categoriaDadosAfetados": [
- {
- "id": "1507e9e7-cc3a-415b-b6a0-cefa1d4b9b61",
- "nome": "joao"
}
], - "solicitante": {
- "documento": "doc",
- "nome": "Tiago Mendes",
- "telefone": "19991516481",
- "email": "contato@bhut.com.br"
}, - "tipoDeComunicacao": "tipo",
- "idUsuarioRejeicao": "acdc1761-0f87-420d-8b71-2081043a0071",
- "motivoDaRejeicao": {
- "0": "s",
- "1": "t",
- "2": "r",
- "3": "i",
- "4": "n",
- "5": "g",
- "id": "2ad5e321-5a8d-4904-924f-f0538e85e22e",
- "nome": "MOTIVO"
}, - "descricaoDaRejeicao": "descrição",
- "status": "status",
- "transnacionalizacaoDadosTitulares": true,
- "urgente": true,
- "descricao": "descricao",
- "ocorrencia": {
- "quando": "NAO TENHO CONHECIMENTO",
- "data": "2022-05-10 12:13:14"
}, - "ciencia": {
- "como": "celular",
- "data": "2022-05-10 12:13:14"
}, - "imediata": {
- "status": true,
- "justificativa": "importante"
}, - "medidaSeguranca": {
- "prevencao": "seguranca",
- "apos": "seguranca",
- "reverter": "seguranca"
}, - "relatorioDeImpacto": true,
- "risco": {
- "consequencia": "consequncia",
- "consequenciaStatus": "status",
- "analise": "analise"
}, - "titular": {
- "comunicadoStatus": "status",
- "comunicadoDetalhe": "medida",
- "comunicadoJustificativa": "justificativa"
}, - "origem": "REGISTRO MANUAL",
- "evidencia": "evidencia.pdf",
- "criado_em": "2022-04-05 14:00:43",
- "atualizado_em": "2022-04-05 14:00:43",
- "finalizado_em": "2022-04-05 14:00:43"
}Lista os Criterio Comunicacao
| ativo | boolean Example: ativo=true Filtro por ativo |
{- "itens": [
- {
- "id": "815548b7-0a48-4b6c-a67c-cad1bdf9d0ef",
- "nome": "Nome do criterio comunicação",
- "ativo": true,
- "criadoEm": "2022-04-05 14:00:43",
- "atualizadoEm": "2022-04-05 14:00:43"
}
]
}Lista as Naturezas dados afetados
| ativo | boolean Example: ativo=true Filtro por ativo |
{- "itens": [
- {
- "id": "815548b7-0a48-4b6c-a67c-cad1bdf9d0ef",
- "nome": "Nome da Natureza dados afetados",
- "ativo": true,
- "criadoEm": "2022-04-05 14:00:43",
- "atualizadoEm": "2022-04-05 14:00:43"
}
]
}Lista as Categoria dados afetados
| ativo | boolean Example: ativo=true Filtro por ativo |
{- "itens": [
- {
- "id": "815548b7-0a48-4b6c-a67c-cad1bdf9d0ef",
- "nome": "Nome da categoria dados afetados",
- "ativo": true,
- "criadoEm": "2022-04-05 14:00:43",
- "atualizadoEm": "2022-04-05 14:00:43"
}
]
}Lista os Motivo de rejeição
| ativo | boolean Example: ativo=true Filtro por ativo |
{- "itens": [
- {
- "id": "abc",
- "nome": "abc",
- "ativo": true,
- "criadoEm": "2022-04-05 14:00:43",
- "atualizadoEm": "2022-04-05 14:00:43"
}
]
}Lista as Estimativa Titulares afetados
| ativo | boolean Example: ativo=true Filtro por ativo |
{- "itens": [
- {
- "id": "815548b7-0a48-4b6c-a67c-cad1bdf9d0ef",
- "nome": "Nome da estimativa titulares afetados",
- "ativo": true,
- "criadoEm": "2022-04-05 14:00:43",
- "atualizadoEm": "2022-04-05 14:00:43"
}
]
}Atualiza um evidencia através de um arquivo
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id do incidente a ser atualizado |
Arquivo para atualizar a evidencia
| arquivo | string Arquivo da evidencia a ser adicionada |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Atualiza todos os dados de um incidente
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id do incidente a ser atualizada |
Dados para atualizar o incidente
| idResponsavel | string id do responsavel |
| idCriterio required | string id do criterio |
| idEstimativaTitularesAfetados required | string id da estimativa de titulares afetados |
required | Array of objects |
required | Array of objects |
| tipoDeComunicacao required | string Enum: "COMPLETA" "PRELIMINAR" "COMPLEMENTAR" tipo de comunicação |
| urgente | boolean urgencia |
| idMotivoDaRejeicao required | string <uuid> id do motivo da rejeicao |
| descricaoDaRejeicao | string descricao da rejeicao |
| transnacionalizacaoDadosTitulares required | boolean transnacionalizacao dos dados titulares |
| descricao required | string descricao do incidente |
required | object (OccurrenceRequest) |
required | object (AwareRequest) |
required | object (ImmediateRequest) |
object (SecurityMeasureRequest) | |
| relatorioDeImpacto | boolean relatorio do impacto |
object (RiskRequest) | |
required | object (TitularRequest) |
| status required | string Enum: "TRIAGEM" "ABERTO" "INVESTIGACAO" "NOTIFICACAO" "CONCLUIDO" "REJEITADO" Status do incidente |
{- "idResponsavel": "acdc1761-0f87-420d-8b71-2081043a0071",
- "idCriterio": "27d45b6b-c772-4869-98b6-da43eee18538",
- "idEstimativaTitularesAfetados": "b9702867-8a3e-419f-b8a8-d1f0c4190b0c",
- "idNaturezaDosDadosAfetados": [
- {
- "id": "f8ad6fb9-01de-11ed-b68b-02bfc6b4d41b"
}
], - "IdCategoriaDadosAfetados": [
- {
- "id": "f8ad6fb9-01de-11ed-b68b-02bfc6b4d41b"
}
], - "tipoDeComunicacao": "PARCIAL",
- "urgente": true,
- "idMotivoDaRejeicao": "2ad5e321-5a8d-4904-924f-f0538e85e22e",
- "descricaoDaRejeicao": "descricao",
- "transnacionalizacaoDadosTitulares": true,
- "descricao": "descricao",
- "ocorrencia": {
- "quando": "NAO TENHO CONHECIMENTO",
- "data": "2022-05-10 12:13:14"
}, - "ciencia": {
- "como": "celular",
- "data": "2022-05-10 12:13:14"
}, - "imediata": {
- "status": true,
- "justificativa": "importante"
}, - "medidaSeguranca": {
- "prevencao": "seguranca",
- "apos": "seguranca",
- "reverter": "seguranca"
}, - "relatorioDeImpacto": true,
- "risco": {
- "consequencia": "consequncia",
- "consequenciaStatus": "status",
- "analise": "analise"
}, - "titular": {
- "comunicadoStatus": "SIM",
- "comunicadoDetalhe": "medida",
- "comunicadoJustificativa": "justificativa"
}, - "status": "ABERTO"
}{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Exportar dados de incidente
| id | string <uuid> Example: id=f08c44ec-c930-41a8-92ed-bd6206ed4689 id do incidente |
| nomeSolicitante | string Example: nomeSolicitante=Tiago Nome do solicitante |
| idUsuarioResponsavel | string Example: idUsuarioResponsavel=739f0bf1-600a-49c1-a89e-59fe44ee9747 Id do usuario responsavel |
| origem | string (OriginEnum) Enum: "PORTAL" "INTERNO" Origem do incidente |
| tipoComunicacao | string (CommunicationTypeEnum) Enum: "COMPLETA" "PRELIMINAR" "COMPLEMENTAR" tipo de comunicação |
| status | string (StatusEnum) Enum: "TRIAGEM" "ABERTO" "INVESTIGACAO" "NOTIFICACAO" "CONCLUIDO" "REJEITADO" Filtro por status do incidente |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Cria uma politica
Dados para criar a politica
| nome required | string nome da politica |
| descricao required | string descrição da politica |
| arquivo required | string Arquivo a ser enviado |
{- "id": "cacf412e-de60-482c-b535-e27c6e56a5ed"
}Lista todas as politicas
| ativo | boolean Example: ativo=true se a politica esta ativa ou não |
{- "itens": [
- {
- "id": "efc60910-b586-4411-91d2-bfbbd6232a7f",
- "nome": "politica",
- "descricao": "descricao",
- "arquivo": "politica.pdf",
- "criadoEm": "2022-05-10 12:13:14",
- "atualizadoEm": "2022-05-10 12:13:14",
- "ativo": true
}
]
}Altera o campo ativo da politica
| id required | string Example: e3fd9414-97bf-4ef5-b74c-ee4d98c7479e Numero de identidade da politica |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Altera o campo ativo da politica para falso
| id required | string Example: e3fd9414-97bf-4ef5-b74c-ee4d98c7479e Numero de identidade da politica |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Lista todas as solicitações
| pagina | integer Example: pagina=2 Página atual |
| tamanhoPagina | integer Example: tamanhoPagina=12 Tamanho da página |
string Example: email=bhut@bhut.com filtro por email | |
| nome | string Example: nome=Tiago Mendes filtro por nome |
| login | string Example: login=36478673811 filtro por login |
| idTipo | string <uuid> Example: idTipo=e41645d7-4360-4da3-94ac-527b590b372c Id do tipo |
| prioridade | string (PrioridadeSolicitationEnum) Enum: "MUITO_BAIXA" "BAIXA" "MODERADA" "ALTA" "CRITICA" Prioridade da solicitação |
| idUsuarioResponsavel | string <uuid> Example: idUsuarioResponsavel=e41645d7-4360-4da3-94ac-527b590b372c Usuario Responsavel |
| status | string (StatusSolicitationEnum) Enum: "EM_ABERTO" "EM_ANDAMENTO" "CONCLUIDO" Filtro por status da solicitacao |
| periodoInicio | string Example: periodoInicio=2022-05-10 Data de Criação inicio |
| periodoFim | string Example: periodoFim=2022-05-10 Data de Criação final |
{- "paginacao": {
- "pagina": 1,
- "tamanhoPagina": 10,
- "total": 200
}, - "itens": [
- {
- "id": "0757bb8a-a534-47d4-89a0-399671e1b78b",
- "tipo": {
- "id": "f8ad6fb9-01de-11ed-b68b-02bfc6b4d41b",
- "nome": "Portabilidade dos dados a outro fornecedor de serviço ou produto"
}, - "login": "36478673811",
- "observacao": "Texto",
- "email": "Tiago@bhut.com.br",
- "nome": "Tiago Mendes",
- "idUsuario": "669bfb1b-577c-4e70-a1d3-38167835362b",
- "idUsuarioResponsavel": "669bfb1b-577c-4e70-a1d3-38167835362b",
- "nomeUsuarioResponsavel": "João da Silva",
- "dataLimite": "2022-06-10 15:45:00",
- "resposta": "Pedido atendido",
- "evidencia": "documento.pdf",
- "prioridade": "MUITO_BAIXA",
- "status": "EM_ABERTO",
- "criadoEm": "2022-05-10 15:45:00",
- "atualizadoEm": "2022-05-10 15:45:00"
}
]
}Retorna detalhes de uma solicitacao específica
| id required | string <uuid> Example: e2189d80-e30f-489e-bf5a-fe229cd3d4af id do protocolo da solicitaço |
{- "id": "0757bb8a-a534-47d4-89a0-399671e1b78b",
- "tipo": {
- "id": "f8ad6fb9-01de-11ed-b68b-02bfc6b4d41b",
- "nome": "Portabilidade dos dados a outro fornecedor de serviço ou produto"
}, - "login": "36478673811",
- "observacao": "Texto",
- "email": "Tiago@bhut.com.br",
- "nome": "Tiago Mendes",
- "idUsuario": "669bfb1b-577c-4e70-a1d3-38167835362b",
- "idUsuarioResponsavel": "669bfb1b-577c-4e70-a1d3-38167835362b",
- "nomeUsuarioResponsavel": "João da Silva",
- "dataLimite": "2022-06-10 15:45:00",
- "resposta": "Pedido atendido",
- "evidencia": "documento.pdf",
- "prioridade": "MUITO_BAIXA",
- "status": "EM_ABERTO",
- "criadoEm": "2022-05-10 15:45:00",
- "atualizadoEm": "2022-05-10 15:45:00"
}Atualiza uma solicitação
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id da solicitação a ser atualizada |
Dados para atualizar a solicitação
| status | string Enum: "EM_ABERTO" "EM_ANDAMENTO" "CONCLUIDO" |
| usuarioResponsavel | string <uuid> id da empresa |
| prioridade | string Enum: "MUITO_BAIXA" "BAIXA" "MODERADA" "ALTA" "CRITICA" |
| resposta | string Resposta da solicitação |
{- "status": "CONCLUIDO",
- "usuarioResponsavel": "e2189d80-e30f-489e-bf5a-fe229cd3d4af",
- "prioridade": "ALTA",
- "resposta": "texto"
}{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Retorna a lista de anexos de uma solicitação
| id required | string <uuid> Example: 12199b52-4200-4ae7-a7fd-86e3b24e3ca9 Id da solicitação |
{- "itens": [
- {
- "id": "2cd4eea9-0d42-4e0e-a9d2-767dec8f7323",
- "idSolicitacao": "2cd4eea9-0d42-4e0e-a9d2-767dec8f7323",
- "criadoEm": "2022-08-16 12:13:14",
- "atualizadoEm": "2022-08-16 12:13:14"
}
]
}Retorna o anexo de uma solicitação
| id required | string <uuid> Example: 12199b52-4200-4ae7-a7fd-86e3b24e3ca9 Id da solicitação anexo |
| idSolicitacao required | string <uuid> Example: 345cd8ef-bccb-49e7-b967-b48676c969e3 Id da solicitação |
{- "id": "2cd4eea9-0d42-4e0e-a9d2-767dec8f7323",
- "idSolicitacao": "2cd4eea9-0d42-4e0e-a9d2-767dec8f7323",
- "criadoEm": "2022-08-16 12:13:14",
- "atualizadoEm": "2022-08-16 12:13:14"
}Cria uma configuração de solicitaçào
Dados do tipo da solicitação
| nome required | string |
| prioridade required | string |
| prazoSolicitacao required | number |
| prazoTask required | number |
| qtdDiasSolicitacao required | number |
| qtdDiasTask required | number |
| avisoIntervaloSolicitacao required | number |
| avisoIntervaloTask required | number |
{- "nome": "Portabilidade dos dados a outro fornecedor de serviço ou produto",
- "prioridade": "ALTA",
- "prazoSolicitacao": 30,
- "prazoTask": 30,
- "qtdDiasSolicitacao": 5,
- "qtdDiasTask": 5,
- "avisoIntervaloSolicitacao": 2,
- "avisoIntervaloTask": 2
}{- "id": "2cd4eea9-0d42-4e0e-a9d2-767dec8f7323"
}Lista todos as configurações de solicitação
| ativo | boolean Example: ativo=true Status da solicitação tipo |
[- {
- "id": "f8ad6fb9-01de-11ed-b68b-02bfc6b4d41b",
- "nome": "Portabilidade dos dados a outro fornecedor de serviço ou produto",
- "prazoSolicitacao": "15 dias",
- "prazoTask": "5 dias",
- "prioridade": "MUITO_BAIXA",
- "ativo": true,
- "criadoEm": "2022-08-16 12:13:14",
- "atualizadoEm": "2022-08-16 12:13:14"
}
]Atualiza uma configuração de tipo de solicitação
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id da solicitação a ser atualizada |
Dados para atualizar a solicitação
| nome | string Nome do tipo da solicitação |
| prioridade | string (PrioridadeSolicitationEnum) Enum: "MUITO_BAIXA" "BAIXA" "MODERADA" "ALTA" "CRITICA" |
| prazoSolicitacao | number Prazo da solicitação |
| prazoTask | number Prazo da task |
| qtdDiasSolicitacao | number Quantidade de dias da solicitação |
| qtdDiasTask | number Quantidade de dias da task |
| avisoIntervaloSolicitacao | number Intervalo de aviso da solicitação |
| avisoIntervaloTask | number Intervalo de aviso da task |
{- "nome": "texto",
- "prioridade": "MUITO_BAIXA",
- "prazoSolicitacao": 15,
- "prazoTask": 15,
- "qtdDiasSolicitacao": 5,
- "qtdDiasTask": 5,
- "avisoIntervaloSolicitacao": 1,
- "avisoIntervaloTask": 5
}{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Detalhes configurações de solicitação
| id required | string <uuid> Example: e2189d80-e30f-489e-bf5a-fe229cd3d4af id do protocolo da solicitaço |
[- {
- "id": "2cd4eea9-0d42-4e0e-a9d2-767dec8f7323",
- "nome": "bhuitda",
- "prazoSolicitacao": 30,
- "prazoTask": 30,
- "prioridade": "ALTA",
- "avisoIntervaloSolicitacao": 2,
- "avisoIntervaloTask": 2,
- "qtdDiasTask": 2,
- "qtdDiasSolicitacao": 2,
- "ativo": true,
- "criadoEm": "2022-08-16 12:13:14",
- "atualizadoEm": "2022-08-16 12:13:14"
}
]Altera o campo ativo do tipo de solicitacao
| id required | string Example: e3fd9414-97bf-4ef5-b74c-ee4d98c7479e Numero de identidade da empresa |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Altera o campo ativo do tipo de solicitacao para falso
| id required | string Example: e3fd9414-97bf-4ef5-b74c-ee4d98c7479e Numero de identidade da empresa |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Atualiza um evidencia através de um arquivo
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id da solicitação a ser atualizada |
Arquivo para atualizar a evidencia
| arquivo | string Arquivo da evidencia a ser adicionada |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Exportar dados de solicitação para e-mail
| login | string Example: login=123******00 login a ser retornado |
| nome | string Example: nome=nomesol nome da solicitacao |
| responsavel | string Example: responsavel=respon responsavel pela solicitação |
| status | boolean Example: status=true status da solicitação |
string Example: email=emai*******.com email a ser retornado |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Lista todas as Tarefas
| pagina | integer Example: pagina=2 Página atual |
| tamanhoPagina | integer Example: tamanhoPagina=12 Tamanho da página |
| tipoOperacao | string (TypeOperationEnum) Enum: "SOLICITACAO" "INCIDENTE" "PROCESSO" Tipo da operação |
| idOperacao | string Example: idOperacao=739f0bf1-600a-49c1-a89e-59fe44ee9747 Id da operação |
| idUsuarioResponsavel | string Example: idUsuarioResponsavel=739f0bf1-600a-49c1-a89e-59fe44ee9747 Id do usuário |
| descricao | string Example: descricao=descricao descricao da tarefa |
| status | string (StatusTaskEnum) Enum: "EM_ABERTO" "CONCLUIDO" Filtro por status |
{- "paginacao": {
- "pagina": 1,
- "tamanhoPagina": 10,
- "total": 200
}, - "itens": [
- {
- "id": "0757bb8a-a534-47d4-89a0-399671e1b78b",
- "usuarioResponsavel": {
- "id": "f8ad6fb9-01de-11ed-b68b-02bfc6b4d41b",
- "email": "bhut@bhut.com"
}, - "operacao": {
- "id": "f8ad6fb9-01de-11ed-b68b-02bfc6b4d41b",
- "tipo": "SOLICITACAO"
}, - "tipo": "TASK",
- "descricao": "descrição",
- "idUsuarioSolicitante": "0757bb8a-a534-47d4-89a0-399671e1b78b",
- "status": "EM_ABERTO",
- "prazo": "2022-05-30",
- "resposta": "Chamado atendido com sucesso",
- "criadoEm": "2022-05-10 12:13:14",
- "atualizadoEm": "2022-05-10 12:13:14"
}
]
}Cria uma tarefa
Dados para criar a tarefa
| tipo required | string (TypeTaskEnum) Enum: "TASK" "ANOTACAO" Tipo da tarefa |
required | object (ResponseUserRequest) Usuário responsável |
| idUsuarioSolicitante required | string <uuid> id usuario solicitante |
required | object (OperationRequest) Dados da operação principal |
| descricao required | string Descrição |
| prazo required | string Prazo para finalização |
| status required | string Enum: "EM_ABERTO" "CONCLUIDO" Status da tarefa |
{- "tipo": "TASK",
- "usuarioResponsavel": {
- "id": "f8ad6fb9-01de-11ed-b68b-02bfc6b4d41b",
- "email": "contato@bhut.com.br"
}, - "idUsuarioSolicitante": "b9000063-fd00-45ac-81c8-1049768ea9c4",
- "operacao": {
- "id": "f8ad6fb9-01de-11ed-b68b-02bfc6b4d41b",
- "tipoOperacao": "SOLICITACAO"
}, - "descricao": "texto",
- "prazo": "2022-07-29",
- "status": "EM_ABERTO"
}{- "id": "648e1385-5227-400a-a894-b5f650490768"
}Retorna detalhes de uma tarefa específica
| id required | string <uuid> Example: e2189d80-e30f-489e-bf5a-fe229cd3d4af id da tarefa |
{- "id": "0757bb8a-a534-47d4-89a0-399671e1b78b",
- "usuarioResponsavel": {
- "id": "f8ad6fb9-01de-11ed-b68b-02bfc6b4d41b",
- "email": "bhut@bhut.com"
}, - "operacao": {
- "id": "f8ad6fb9-01de-11ed-b68b-02bfc6b4d41b",
- "tipo": "SOLICITACAO"
}, - "tipo": "TASK",
- "descricao": "descrição",
- "idUsuarioSolicitante": "0757bb8a-a534-47d4-89a0-399671e1b78b",
- "status": "EM_ABERTO",
- "prazo": "2022-05-30",
- "resposta": "Chamado atendido com sucesso",
- "criadoEm": "2022-05-10 12:13:14",
- "atualizadoEm": "2022-05-10 12:13:14"
}Retorna detalhes de uma tarefa específica
| id required | string <uuid> Example: e2189d80-e30f-489e-bf5a-fe229cd3d4af id da tarefa |
| companyId required | string <uuid> Example: e2189d80-e30f-489e-bf5a-fe229cd3d4af id da empresa |
{- "id": "0757bb8a-a534-47d4-89a0-399671e1b78b",
- "usuarioResponsavel": {
- "id": "f8ad6fb9-01de-11ed-b68b-02bfc6b4d41b",
- "email": "bhut@bhut.com"
}, - "operacao": {
- "id": "f8ad6fb9-01de-11ed-b68b-02bfc6b4d41b",
- "tipo": "SOLICITACAO"
}, - "tipo": "TASK",
- "descricao": "descrição",
- "idUsuarioSolicitante": "0757bb8a-a534-47d4-89a0-399671e1b78b",
- "status": "EM_ABERTO",
- "prazo": "2022-05-30",
- "resposta": "Chamado atendido com sucesso",
- "criadoEm": "2022-05-10 12:13:14",
- "atualizadoEm": "2022-05-10 12:13:14"
}Altera o campo resposta da tarefa
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id da solicitação a ser atualizada |
Dados para atualizar a tarefa
| resposta required | string Resposta da tarefa |
{- "resposta": "texto"
}{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Altera o campo resposta da tarefa
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id da tarefa |
| companyId required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id da empresa |
Dados para atualizar a tarefa
| resposta required | string Resposta da tarefa |
{- "resposta": "texto"
}{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Relatório de autorizações por status
| dataInicio required | string <date> Example: dataInicio=2023-01-01 Data inicial do relatório |
| dataFinal required | string <date> Example: dataFinal=2023-01-10 Data final do relatório |
| idBaseLegal | string <uuid> Example: idBaseLegal=396e4239-bbc7-404a-a762-e3c088c3e354 Id da base legal |
| idClasse | string <uuid> Example: idClasse=aa61bac1-187e-4976-b02b-cfe71cc423a0 Id da classe |
[- {
- "descricao": "Concedido",
- "valor": 10
}
]Relatório de autorizações por origem
| dataInicio required | string <date> Example: dataInicio=2023-01-01 Data inicial do relatório |
| dataFinal required | string <date> Example: dataFinal=2023-01-10 Data final do relatório |
| idBaseLegal | string <uuid> Example: idBaseLegal=396e4239-bbc7-404a-a762-e3c088c3e354 Id da base legal |
| idClasse | string <uuid> Example: idClasse=aa61bac1-187e-4976-b02b-cfe71cc423a0 Id da classe |
[- {
- "descricao": "Concedido",
- "valor": 10
}
]Relatório de autorizações por classe
| dataInicio required | string <date> Example: dataInicio=2023-01-01 Data inicial do relatório |
| dataFinal required | string <date> Example: dataFinal=2023-01-10 Data final do relatório |
| idClasse | string <uuid> Example: idClasse=aa61bac1-187e-4976-b02b-cfe71cc423a0 Id da classe |
[- {
- "descricao": "Concedido",
- "valor": 10
}
]Relatório de autorizações por finalidade
| dataInicio required | string <date> Example: dataInicio=2023-01-01 Data inicial do relatório |
| dataFinal required | string <date> Example: dataFinal=2023-01-10 Data final do relatório |
| idBaseLegal | string <uuid> Example: idBaseLegal=396e4239-bbc7-404a-a762-e3c088c3e354 Id da base legal |
| idClasse | string <uuid> Example: idClasse=aa61bac1-187e-4976-b02b-cfe71cc423a0 Id da classe |
[- {
- "classe": "classe",
- "finalidade": "finalidade",
- "pendente": 5,
- "concluido": 5,
- "rejeitado": 5,
- "total": 15
}
]Relatório de Solicitações por status
| dataInicio required | string <date> Example: dataInicio=2023-01-01 Data inicial do relatório |
| dataFinal required | string <date> Example: dataFinal=2023-01-10 Data final do relatório |
[- {
- "descricao": "Concluido",
- "valor": 10
}
]Relatório de Solicitações por direito do titular
| dataInicio required | string <date> Example: dataInicio=2023-01-01 Data inicial do relatório |
| dataFinal required | string <date> Example: dataFinal=2023-01-10 Data final do relatório |
[- {
- "descricao": "texto 1",
- "valor": 1365
}
]Relatório de Solicitações por taxa de fechamento
| dataInicio required | string <date> Example: dataInicio=2023-01-01 Data inicial do relatório |
| dataFinal required | string <date> Example: dataFinal=2023-01-10 Data final do relatório |
[- {
- "direito": "direito",
- "total": 100,
- "percentualFechamento": 20,
- "percentualFechamentoPrazo": 80
}
]Relatório de Solicitações por evolução mensal
| dataInicio required | string <date> Example: dataInicio=2020-01-01 Data inicial do relatório |
| dataFinal required | string <date> Example: dataFinal=2023-11-10 Data final do relatório |
[- {
- "date": "Janeiro",
- "valorOpen": 10,
- "valorClosed": 10
}
]Relatório de Incidentes por tipo de dados
| dataInicio required | string <date> Example: dataInicio=2023-01-01 Data inicial do relatório |
| dataFinal required | string <date> Example: dataFinal=2023-01-10 Data final do relatório |
[- {
- "descricao": "texto 1",
- "valor": 1365
}
]Relatório de Incidentes por titulares afetados
| dataInicio required | string <date> Example: dataInicio=2023-01-01 Data inicial do relatório |
| dataFinal required | string <date> Example: dataFinal=2023-01-10 Data final do relatório |
[- {
- "descricao": "texto 1",
- "valor": 1365
}
]Relatório de Incidentes por fechamento
| dataInicio required | string <date> Example: dataInicio=2023-01-01 Data inicial do relatório |
| dataFinal required | string <date> Example: dataFinal=2023-01-10 Data final do relatório |
[- {
- "risco": "texto 1",
- "total": 100,
- "concluido": 55,
- "tempoMedio": 45
}
]Cria uma integração
Dados para criar a integração
| integracao required | string nome da integração |
| dados required | string dados da integração |
{- "integracao": "OFFICE_365",
- "dados": { }
}{- "id": "7df17a6f-be90-4d29-a520-a98cfb9ec32f"
}Lista todas as integrações
| ativo | boolean Example: ativo=true se a integração esta ativa ou não |
{- "itens": [
- {
- "id": "efc60910-b586-4411-91d2-bfbbd6232a7f",
- "integracao": "OFFICE_365",
- "dados": { },
- "ativo": true,
- "criadoEm": "2023-03-23 11:38:30",
- "atualizadoEm": "2023-03-24 10:49:26"
}
]
}Ativa uma integração específica
| id required | string <uuid> Example: a02206b4-5b7a-4c23-b437-32c7130d944c Id da integração a ser ativada |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Ativa uma integração específica
| id required | string <uuid> Example: a02206b4-5b7a-4c23-b437-32c7130d944c Id da integração a ser desativada |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Atualiza dados de uma integração
| id required | string <uuid> Example: 01aee746-0e9e-4866-be69-694ed22d0dcf Id da integração a ser atualizada |
Dados para atualizar os dados de uma integração
| dados | object dados de uma integração |
{- "dados": { }
}{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Cria um departamento
Dados para criar um departamento
| nome required | string nome do departamento |
| emailResponsavel required | string email do responsavel |
| tipo required | string Enum: "PROPRIO" "TERCERIZADO" tipo do departamento |
{- "nome": "o novo departamento",
- "emailResponsavel": "user@email.com",
- "tipo": "PROPRIO"
}{- "id": "a6d6784e-99bf-4889-9191-952c74457e92"
}Listar todos os departamentos
| ativo | string Example: ativo=true se o departamento esta ativo ou não |
| nome | string Example: nome=departamento o nome do departamento |
| tipo | string Example: tipo=PROPRIO o tio do departamento |
{- "itens": [
- {
- "id": "ebda2e8a-f4a4-41ce-913f-89fe70eff202",
- "nome": "department",
- "emailResponsavel": "email@email.com",
- "tipo": "TERCERIZADO",
- "ativo": true,
- "criadoEm": "2023-04-12 13:05:19",
- "atualizadoEm": "2023-04-12 13:05:19"
}
]
}Retorna um departamento
| id required | string <uuid> Example: ebda2e8a-f4a4-41ce-913f-89fe70eff202 Id do departamento |
{- "id": "ebda2e8a-f4a4-41ce-913f-89fe70eff202",
- "nome": "department",
- "emailResponsavel": "email@email.com",
- "tipo": "TERCERIZADO",
- "ativo": true,
- "criadoEm": "2023-04-12 13:05:19",
- "atualizadoEm": "2023-04-12 13:05:19"
}Atualiza um departamento
| id required | string <uuid> Example: 4757a428-0f86-4e4e-8ea9-515a86908a43 Id do departamento a ser atualizada |
Dados para atualizar a departamento
| nome | string nome do departamento |
| emailResponsavel | string email do responsavel do departamento |
| tipo | string Enum: "PROPRIO" "TERCERIZADO" tipo do departamento |
{- "nome": "updated@email.com",
- "emailResponsavel": "updated departmen",
- "tipo": "TERCERIZADO"
}Altera o campo ativo do departamento
| id required | string Example: ebda2e8a-f4a4-41ce-913f-89fe70eff202 Numero de identidade do departamento |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Altera o campo ativo do departamento
| id required | string Example: 4c0254ea-cbf5-4def-ad62-df961f1f02bf Numero de identidade do departamento |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Cria uma Segurança-proteção
Dados da requisição
| nome required | string nome |
| descricao required | string descricao |
| categoria required | string Enum: "DIGITAL" "FISICO" categoria |
{- "nome": "Segurança-proteção",
- "descricao": "Segurança-proteção digital",
- "categoria": "DIGITAL"
}{- "id": "0e8352d9-467a-4cb8-aabf-cc6436df41ea"
}Lista os Segurança-proteção
| ativo | string Example: ativo=true se sergurança-proteção esta ativa ou não |
| nome | string Example: nome=Segurança-proteção digital o nome da sergurança-proteção |
| tipo | string Example: tipo=DIGITAL a categoria da sergurança-proteção |
{- "itens": [
- {
- "id": "0e8352d9-467a-4cb8-aabf-cc6436df41ea",
- "nome": "Segurança-proteção",
- "descricao": "Segurança-proteção digital",
- "categoria": "DIGITAL",
- "ativo": true,
- "criadoEm": "2022-04-05 14:00:43",
- "atualizadoEm": "2022-04-05 14:00:43"
}
]
}Atualiza uma Segurança-Proteção
| id required | string <uuid> Example: 0e8352d9-467a-4cb8-aabf-cc6436df41ea ID |
Dados da requisição
| nome required | string nome |
| descricao required | string descricao |
| categoria required | string Enum: "DIGITAL" "FISICO" categoria |
{- "nome": "Segurança-proteção",
- "descricao": "Segurança-proteção digital",
- "categoria": "DIGITAL"
}{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Retorna uma Segurança-Proteção específica
| id required | string <uuid> Example: 0e8352d9-467a-4cb8-aabf-cc6436df41ea ID |
{- "id": "0e8352d9-467a-4cb8-aabf-cc6436df41ea",
- "nome": "Segurança-proteção",
- "descricao": "Segurança-proteção digital",
- "categoria": "DIGITAL",
- "ativo": true,
- "criadoEm": "2022-04-05 14:00:43",
- "atualizadoEm": "2022-04-05 14:00:43"
}Ativa uma Segurança-Proteção
| id required | string <uuid> Example: 0e8352d9-467a-4cb8-aabf-cc6436df41ea ID |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Ativa uma Segurança-Proteção
| id required | string <uuid> Example: 0e8352d9-467a-4cb8-aabf-cc6436df41ea ID |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Dados dos Menores
| ativo | string Example: ativo=true se dados-menores esta ativo ou não |
{- "itens": [
- {
- "id": "0e8352d9-467a-4cb8-aabf-cc6436df41ea",
- "nome": "sim, menores de 12 anos",
- "ativo": true,
- "criadoEm": "2022-04-05 14:00:43",
- "atualizadoEm": "2022-04-05 14:00:43"
}
]
}Volume dos Titulares
| ativo | string Example: ativo=true se VolumeTitulares esta ativo ou não |
{- "itens": [
- {
- "id": "0e8352d9-467a-4cb8-aabf-cc6436df41ea",
- "nome": "Dezenas",
- "ativo": true,
- "criadoEm": "2022-04-05 14:00:43",
- "atualizadoEm": "2022-04-05 14:00:43"
}
]
}{- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "tipo": "ROPA/GAP",
- "criadoEm": "2022-04-05 14:00:43",
- "atualizadoEm": "2022-04-05 14:00:43"
}{- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "tipo": "ROPA/GAP",
- "criadoEm": "2022-04-05 14:00:43",
- "atualizadoEm": "2022-04-05 14:00:43"
}Lista todos os processos
| pagina | integer Example: pagina=2 Página atual |
| tamanhoPagina | integer Example: tamanhoPagina=12 Tamanho da página |
| idDepartamento | string <uuid> Example: idDepartamento=c1e9b074-24fc-4fce-9d02-b2107bbcfe48 id Departamento do processo |
| idClasse | string <uuid> Example: idClasse=c1e9b074-24fc-4fce-9d02-b2107bbcfe48 id Classe do processo |
| Status | string Enum: "RASCUNHO" "AGUARDANDO" "EM_ANDAMENTO" "REVISAO" "CONCLUIDO" Example: Status=RASCUNHO Status da criação do processo |
{- "items": [
- {
- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "classe": {
- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "nome": "classe"
}, - "finalidade": [
- {
- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "nome": "finalidade"
}
], - "nome": "processo",
- "usuarioRipdProfile": {
- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "nome": "ripd user"
}, - "departamento": {
- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "nome": "departamento"
}, - "nomeResponsavel": "Lucas Paulo",
- "emailResponsavel": "emailResponsave@gmail.com",
- "detalhamento": "detalhes",
- "relacionamentoDiretoTitular": true,
- "dadosMenores": {
- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "nome": "Sim, maiores e menores de 12 anos"
}, - "volumeTitulares": {
- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "nome": "Centenas"
}, - "origemDado": {
- "titularDeDadosPessoais": true,
- "fontePublica": true,
- "departamento": [
- {
- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "nome": "departamento dados de origem"
}
], - "agenteTratamento": [
- {
- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "nome": "agente de tratamento dados de origem"
}
]
}, - "armazenamento": {
- "agenteTratamento": [
- {
- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "nome": "agente de tratamento dados de origem"
}
], - "armazenamento": [
- {
- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "nome": "armazenamento"
}
], - "recursoDeSegurancaProtecao": [
- {
- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "nome": "recurso de seguranca protecao"
}
], - "dependenciaDeOutroProcesso": {
- "status": true,
- "departamento": {
- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "nome": "departamento dependencia"
}, - "processo": {
- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "nome": "processo dependencia"
}
}, - "compartilhamentoInterno": {
- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "nome": "departamento compartilhamento interno"
}
}, - "risco": {
- "descricao": "risco",
- "mitigacao": "mitigacao",
- "probabilidade": "ALTO",
- "impacto": "BAIXO",
- "parecerDpo": "parecer dpo"
}, - "planoDeAcao": {
- "descricao": "descricao do plano de ação",
- "prazoConclusao": "2023-12-05T03:00:00.000Z"
}, - "alertas": {
- "diasTarefa": 23,
- "intervaloPocesso": 23,
- "diasProcesso": 23,
- "intervaloTarefa": 23
}, - "status": "RASCUNHO",
- "relatorioRipd": {
- "emitidoEm": "2023-07-05T14:36:19.000Z"
}, - "criadoEm": "2023-07-04 16:43:45",
- "atualizadoEm": "2023-07-05 09:47:46"
}
]
}Cria uma Processo
Dados da requisição
| idClasse | string idClasse |
Array of objects | |
| nome required | string nomeDeProcesso |
| idDepartamento required | string idDepartamento |
| nomeResponsavel | string nome do responsavel pelo processo |
| emailResponsavel | string emailResponsavelDoProcesso |
| detalhamento | string detalhamentoDoProcesso |
| relacionamentoDiretoTitular | boolean relacionamentoDiretoTitular |
| idDadosMenores | string idDadosMenores |
| idVolumeTitulares | string idVolumeTitulares |
object | |
object | |
object | |
object | |
object | |
| status required | string statusASerCriado |
{- "idClasse": "37f4df80-9a6c-4c15-adca-14c2c0c1a036",
- "finalidade": [
- {
- "id": "f754731f-75c3-4a90-b777-916cd835a828"
}
], - "nome": "processo",
- "idDepartamento": "37f4df80-9a6c-4c15-adca-14c2c0c1a036",
- "nomeResponsavel": "Lucas Paulo",
- "emailResponsavel": "process@email.com",
- "detalhamento": "processo de vazamento de dados",
- "relacionamentoDiretoTitular": true,
- "idDadosMenores": "b3ec9f7f-9122-48d9-b679-ce3123696786",
- "idVolumeTitulares": "1f568be6-0604-42c9-be7d-ccc299a64814",
- "origemDado": {
- "titularDeDadosPessoais": true,
- "fontePublica": true,
- "departamento": [
- {
- "id": "f754731f-75c3-4a90-b777-916cd835a828"
}
], - "agenteTratamento": [
- {
- "id": "f754731f-75c3-4a90-b777-916cd835a828"
}
]
}, - "armazenamento": {
- "agenteTratamento": [
- {
- "id": "f754731f-75c3-4a90-b777-916cd835a828"
}
], - "armazenamento": [
- {
- "id": "f754731f-75c3-4a90-b777-916cd835a828"
}
], - "recursoDeSegurancaProtecao": [
- {
- "id": "f754731f-75c3-4a90-b777-916cd835a828"
}
], - "dependenciaDeOutroProcesso": {
- "status": true,
- "departamento": "37f4df80-9a6c-4c15-adca-14c2c0c1a036",
- "processo": "37f4df80-9a6c-4c15-adca-14c2c0c1a036"
}, - "compartilhamentoInterno": "37f4df80-9a6c-4c15-adca-14c2c0c1a036"
}, - "risco": {
- "descricao": "risco",
- "mitigacao": "mitigacao",
- "probabilidade": "ALTO",
- "impacto": "BAIXO",
- "parecerDpo": "parecer dpo"
}, - "planoDeAcao": {
- "descricao": "descricao do plano de ação",
- "prazoConclusao": "2023-12-05 14:00:43"
}, - "alertas": {
- "diasTarefa": 12,
- "intervaloPocesso": 23,
- "diasProcesso": 5,
- "intervaloTarefa": 5
}, - "status": "RASCUNHO"
}{- "id": "0e8352d9-467a-4cb8-aabf-cc6436df41ea"
}busca um processo
| id required | string <uuid> Example: 0e8352d9-467a-4cb8-aabf-cc6436df41ea ID |
{- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "classe": {
- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "nome": "classe"
}, - "finalidade": [
- {
- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "nome": "finalidade"
}
], - "nome": "processo",
- "usuarioRipdProfile": {
- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "nome": "ripd user"
}, - "departamento": {
- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "nome": "departamento"
}, - "nomeResponsavel": "Lucas Paulo",
- "emailResponsavel": "emailResponsave@gmail.com",
- "detalhamento": "detalhes",
- "relacionamentoDiretoTitular": true,
- "dadosMenores": {
- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "nome": "Sim, maiores e menores de 12 anos"
}, - "volumeTitulares": {
- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "nome": "Centenas"
}, - "origemDado": {
- "titularDeDadosPessoais": true,
- "fontePublica": true,
- "departamento": [
- {
- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "nome": "departamento dados de origem"
}
], - "agenteTratamento": [
- {
- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "nome": "agente de tratamento dados de origem"
}
]
}, - "armazenamento": {
- "agenteTratamento": [
- {
- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "nome": "agente de tratamento dados de origem"
}
], - "armazenamento": [
- {
- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "nome": "armazenamento"
}
], - "recursoDeSegurancaProtecao": [
- {
- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "nome": "recurso de seguranca protecao"
}
], - "dependenciaDeOutroProcesso": {
- "status": true,
- "departamento": {
- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "nome": "departamento dependencia"
}, - "processo": {
- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "nome": "processo dependencia"
}
}, - "compartilhamentoInterno": {
- "id": "c1293f22-3d46-4168-ba74-a8f6bbea5228",
- "nome": "departamento compartilhamento interno"
}
}, - "risco": {
- "descricao": "risco",
- "mitigacao": "mitigacao",
- "probabilidade": "ALTO",
- "impacto": "BAIXO",
- "parecerDpo": "parecer dpo"
}, - "planoDeAcao": {
- "descricao": "descricao do plano de ação",
- "prazoConclusao": "2023-12-05T03:00:00.000Z"
}, - "alertas": {
- "diasTarefa": 23,
- "intervaloPocesso": 23,
- "diasProcesso": 23,
- "intervaloTarefa": 23
}, - "status": "RASCUNHO",
- "relatorioRipd": {
- "emitidoEm": "2023-07-05T14:36:19.000Z"
}, - "criadoEm": "2023-07-04 16:43:45",
- "atualizadoEm": "2023-07-05 09:47:46"
}Atualiza um Processo
| id required | string <uuid> Example: 0e8352d9-467a-4cb8-aabf-cc6436df41ea ID |
Dados da requisição
| idClasse | string idClasse |
Array of objects | |
| nome required | string nomeDeProcesso |
| idDepartamento required | string idDepartamento |
| nomeResponsavel | string nome do responsavel pelo processo |
| emailResponsavel | string emailResponsavelDoProcesso |
| detalhamento | string detalhamentoDoProcesso |
| relacionamentoDiretoTitular | boolean relacionamentoDiretoTitular |
| idDadosMenores | string idDadosMenores |
| idVolumeTitulares | string idVolumeTitulares |
object | |
object | |
object | |
object | |
object | |
| status required | string statusASerCriado |
{- "idClasse": "37f4df80-9a6c-4c15-adca-14c2c0c1a036",
- "finalidade": [
- {
- "id": "f754731f-75c3-4a90-b777-916cd835a828"
}
], - "nome": "processo",
- "idDepartamento": "37f4df80-9a6c-4c15-adca-14c2c0c1a036",
- "nomeResponsavel": "Lucas Paulo",
- "emailResponsavel": "process@email.com",
- "detalhamento": "processo de vazamento de dados",
- "relacionamentoDiretoTitular": true,
- "idDadosMenores": "b3ec9f7f-9122-48d9-b679-ce3123696786",
- "idVolumeTitulares": "1f568be6-0604-42c9-be7d-ccc299a64814",
- "origemDado": {
- "titularDeDadosPessoais": true,
- "fontePublica": true,
- "departamento": [
- {
- "id": "f754731f-75c3-4a90-b777-916cd835a828"
}
], - "agenteTratamento": [
- {
- "id": "f754731f-75c3-4a90-b777-916cd835a828"
}
]
}, - "armazenamento": {
- "agenteTratamento": [
- {
- "id": "f754731f-75c3-4a90-b777-916cd835a828"
}
], - "armazenamento": [
- {
- "id": "f754731f-75c3-4a90-b777-916cd835a828"
}
], - "recursoDeSegurancaProtecao": [
- {
- "id": "f754731f-75c3-4a90-b777-916cd835a828"
}
], - "dependenciaDeOutroProcesso": {
- "status": true,
- "departamento": "37f4df80-9a6c-4c15-adca-14c2c0c1a036",
- "processo": "37f4df80-9a6c-4c15-adca-14c2c0c1a036"
}, - "compartilhamentoInterno": "37f4df80-9a6c-4c15-adca-14c2c0c1a036"
}, - "risco": {
- "descricao": "risco",
- "mitigacao": "mitigacao",
- "probabilidade": "ALTO",
- "impacto": "BAIXO",
- "parecerDpo": "parecer dpo"
}, - "planoDeAcao": {
- "descricao": "descricao do plano de ação",
- "prazoConclusao": "2023-12-05 14:00:43"
}, - "alertas": {
- "diasTarefa": 12,
- "intervaloPocesso": 23,
- "diasProcesso": 5,
- "intervaloTarefa": 5
}, - "status": "RASCUNHO"
}{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Solicita geração do relatório de ripd do processo
| id required | string <uuid> Example: 0e8352d9-467a-4cb8-aabf-cc6436df41ea ID |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Atualiza uma evidencia através de um arquivo
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id do processo a ser atualizada |
Arquivo para atualizar a evidencia
| arquivo | string Arquivo da evidencia a ser adicionada |
{- "errors": [
- {
- "code": "INVALID_FIELD",
- "message": "Os campos são inválidos/obrigatórios"
}
]
}Lista de importações realizadas
| pagina | number Example: pagina=1 número de páginas |
| tamanhoPagina | number Example: tamanhoPagina=2 tamanho da página |
| id | string <uuid> Example: id=80cf33ee-f0a6-4294-87bb-634f5fc80a9c identificação da planilia |
| tipo required | string Example: tipo=PROCESSO tipo da importação |
| nomeArquivo | string Example: nomeArquivo=cliente.csv nome do arquivo |
| status | string Example: status=Sucesso status do arquivo |
| dataEnvioInicio | string <date> Example: dataEnvioInicio=2023-01-01 a primeira data cujo a mais antiga entre duas |
| dataEnvioFinal | string <date> Example: dataEnvioFinal=2023-01-10 a segunda data cujo a mais nova entre duas |
{- "paginacao": {
- "pagina": 1,
- "tamanhoPagina": 10,
- "total": 200
}, - "itens": [
- {
- "id": "0757bb8a-a534-47d4-89a0-399671e1b78b",
- "nomeArquivo": "cliente.csv",
- "urlArquivo": "tee/cliente.csv",
- "quantidadeLinha": 16,
- "quantidadeLinhaProcessada": 18,
- "status": "SUCESSO",
- "criadoEm": "2022-05-10 15:45:00",
- "atualizadoEm": "2023-05-10 15:45:00"
}
]
}Criar processo de importação
Dados para processar arquivo
| tipo required | string Tipo do arquivo |
| arquivo required | string Arquivo a ser importado |
| dados | string JSON com os dados adicionais da importação |
{- "id": "cacf412e-de60-482c-b535-e27c6e56a5ed"
}Obtem uma lista de erros de uma importação
| id required | string <uuid> Example: 7a5a1e4c-317e-4abe-b302-b88639bb2ac0 Id da importação |
{- "itens": [
- {
- "id": "0cbad99c-0add-4ca8-88e0-58e065be7316",
- "numeroLinha": 2,
- "detalheErro": "ListaDaO3.csv",
- "criadoEm": "2023-04-05T14:00:43.000Z"
}
]
}Lista de contrato do agente de tratamento
| ativo | boolean Example: ativo=true Filtro por ativo |
| nome | string Example: nome=Nome Filtro por nome |
| realizaAvaliacao | string Enum: "SIM" "NAO" "EM_ANDAMENTO" Example: realizaAvaliacao=SIM Filtro de realizada avaliacao |
| pais | string Example: pais=Pais Filtro por pais |
| tipo | string Enum: "OPERADOR" "CONTROLADOR_CONJUNTO" "CONTROLADOR_INDIVIDUAL" Example: tipo=OPERADOR Filtro por tipo |
{- "itens": [
- {
- "id": "0e8352d9-467a-4cb8-aabf-cc6436df41ea",
- "idEmpresa": "0e8352d9-467a-4cb8-aabf-cc6436df41ea",
- "tipo": "OPERADOR",
- "nome": "AWS",
- "pais": "BRASIL",
- "cnpj": "12.123.123/0001-01",
- "email": "contato@teeglobal.com.br",
- "telefone": "(11) 1234-1234",
- "criticidade": "BAIXO",
- "publicoPrivado": "PRIVADO",
- "observacao": "Descrição.....",
- "nomeContrato": "Contrato ABC321",
- "realizaAvaliacao": "SIM",
- "ativo": true,
- "criadoEm": "2022-04-05 14:00:43",
- "atualizadoEm": "2022-04-05 14:00:43"
}
]
}