Documento de API
Produto: | Datasul |
| Ocorrência:
| Documentação de API |
Dados do Documento | |
Nome | API Fachada Controle de Acesso |
Descrição |
|
Nome Físico | fchcrm/fchcrm1045api.p |
Include com Parâmetros | fchcrm/fchcrm1045.i |
Release Inicial | 12.1.8 |
Versão de Integração | N/A |
Data Liberação | N/A |
Banco | Mdtcrm |
Tabela | crm_acess_portal |
Aplicativo | Portal CRM |
Evolução | |
Versão | 12.1.8 |
Programa | fchcrm/fchcrm1045api.p |
Objetivo
Realizar a manutenção de controle de acesso.
Tabelas Temporárias
Nos atributos das tabelas temporárias de entrada e saída:
ttFilter | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
c_table | character |
| Tabela | Sim |
c_property | character |
| Propriedade | Sim |
c_value | character |
| Valor | Sim |
ttRestricaoAcesso | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. identificador | Sim |
nom_acess | character |
| Nome acesso | Sim |
idi_tip_acess | integer |
| Tipo acesso | Sim |
ttRegraAcesso | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. identificador | Sim |
num_id_acess_portal | integer |
| Numero Id acesso | Sim |
idi_tip_acess | integer |
| Tipo acesso | Sim |
num_id_acess_compon | integer |
| Numero Id componente | Sim |
nom_compon | character |
| Nome componente | Sim |
num_id_acess_form_portal | Integer |
| Numero Id formulário | Sim |
nom_form | Character |
| Nome formulário | Sim |
log_livre_1 | Logical |
| Logico livre 1 | Sim |
log_visivel | Logical |
| Visível | Sim |
log_editavel | Logical |
| Editável | Sim |
log_op_editavel | logical |
| Formulário editável | Sim |
ttUsuario | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. identificador | Sim |
num_id_acess_portal | integer |
| Numero Id acesso | Sim |
num_id_grp_usuar | integer |
| Numero Id grupo usuário | Sim |
nom_grp_usuar | character |
| Nome grupo usuário | Sim |
num_id_usuar | integer |
| Numero Id usuário | Sim |
nom_usuar | character |
| Nome usuário | Sim |
cod_usuario | character |
| Codigo usuário | Sim |
log_usuar | logical |
| Usuário | Sim |
ttFormulario | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. identificador | Sim |
nom_form | character |
| Nome formulário | Sim |
cod_form | character |
| Codigo formulário | Sim |
log_padr | logical |
| Padrão | Sim |
log_livre_1 | logical |
| Logico livre 1 | Sim |
ttRestricaoFormulario | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. identificador | Sim |
num_id_acess_portal | integer |
| Numero Id acesso | Sim |
idi_tip_acess | integer |
| Tipo acesso | Sim |
num_id_acess_compon | integer |
| Numero Id componente | Sim |
nom_compon | character |
| Nome componente | Sim |
num_id_acess_form_portal | Integer |
| Numero Id formulário | Sim |
nom_form | Character |
| Nome formulário | Sim |
log_livre_1 | Logical |
| Logico livre 1 | Sim |
log_visivel | Logical |
| Visível | Sim |
log_editavel | Logical |
| Editável | Sim |
log_op_editavel | logical |
| Formulário editável | Sim |
ttRestricaoUsuario | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
num_id | integer |
| Cod. identificador | Sim |
num_id_acess_portal | integer |
| Numero Id acesso | Sim |
num_id_grp_usuar | integer |
| Numero Id grupo usuário | Sim |
nom_grp_usuar | character |
| Nome grupo usuário | Sim |
num_id_usuar | integer |
| Numero Id usuário | Sim |
nom_usuar | character |
| Nome usuário | Sim |
cod_usuario | character |
| Codigo usuário | Sim |
log_usuar | logical |
| Usuário | Sim |
ttRestricaoFormularioUsuario | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório |
cod_compon | character |
| Codigo componente | Sim |
log_visivel | logical |
| Visivel | Sim |
idi_tip_acess | integer |
| Tipo acesso | Sim |
log_editavel | logical |
| Editavel | Sim |
Metodo Básico
Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
findAccessRestriction | ||
Requisito | N/A | |
Sintaxe | findAccessRestriction (INPUT i_start, INPUT i_end, INPUT c_properties, INPUT c_values, INPUT c_orderBy, INPUT c_asc, INPUT l_count, INPUT i_type, OUTPUT i_count, OUTPUT DATASET DSCRMRestricaoAcesso, OUTPUT TABLE RowErrors) | |
Descrição | Retorna os registros (query) conforme parâmetros informados. | |
Parâmetros | Descrição | |
i_start | Valor inicial da faixa de registros | |
i_end | Valor final da faixa de registros | |
c_properties | Propriedades | |
c_values | Valores | |
c_orderBy | Campo para ordenação | |
c_asc | Ascendente ou Decrescente | |
l_count | Contador | |
i_type | Tipo | |
i_count | Quantidade de registros selecionados | |
DATASET DSCRMRestricaoAcesso | Dataset com os registros selecionados | |
TABLE RowErros | Tabela de erros | |
Retorno | A API/BO irá retornar os registros selecionados e a quantidade. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. | |
persistAccessRestriction |
| ||
Requisito | N/A |
| |
Sintaxe | persistAccessRestriction (INPUT i_id, INPUT TABLE ttRestricaoAcessoVO, DATASET DSCRMRestricaoAcesso, OUTPUT TABLE RowErrors) |
| |
Descrição | Cria ou atualiza restrição de acesso. |
| |
Parâmetros | Descrição |
| |
i_id | Codigo Identificador Sequencial |
| |
TABLE ttRestricaoAcessoVO | Tabela restrição de acesso |
| |
DATASET DSCRMRestricaoAcesso | Dataset com os registros selecionados |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá criar ou atualizar a restrição de acesso solicitada. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
| |
deleteAccessRestriction |
| ||
Requisito | N/A |
| |
Sintaxe | deleteAccessRestriction (INPUT i_id, OUTPUT l_ok, OUTPUT TABLE RowErrors) |
| |
Descrição | Exclui a restrição de acesso. |
| |
Parâmetros | Descrição |
| |
i_id | Código Identificador Sequencial |
| |
l_ok | Indentificador sucesso |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá excluir a restrição de acesso. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
| |
Metodo Negócio
getAccessRestriction |
| ||
Requisito | N/A |
| |
Sintaxe | getAccessRestriction (INPUT i_id, OUTPUT DATASET DSCRMRestricaoAcesso, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna o detalhe da restrição de acesso solicitada. |
| |
Parâmetros | Descrição |
| |
i_id | Codigo Identificador Sequencial |
| |
DATASET DSCRMRestricaoAcesso | Dataset com os registros selecionados |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá retornar o detalhe da restrição de acesso solicitada. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
| |
getAllForms |
| ||
Requisito | N/A |
| |
Sintaxe | getAllForms (INPUT l_general, OUTPUT TABLE ttFormulario, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna todos os formulários. |
| |
Parâmetros | Descrição |
| |
l_general | Geral |
| |
TABLE ttFormulario | Tabela Formulário |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá retornar todos os formulários cadastrados. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
| |
persistRestrictionForm |
| ||
Requisito | N/A |
| |
Sintaxe | persistRestrictionForm (INPUT i_restriction, INPUT-OUTPUT TABLE ttRestricaoFormularioVO, OUTPUT TABLE RowErrors) |
| |
Descrição | Cria nova restrição de acesso ao formulário. |
| |
Parâmetros | Descrição |
| |
i_restriction | Codigo Identificador Sequencial |
| |
TABLE ttRestricaoFormularioVO | Tabela restrição formulário |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá retornar a restrição de acesso formulário cadastrada na base. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
| |
deleteRestrictionForm |
| ||
Requisito | N/A |
| |
Sintaxe | deleteRestrictionForm (INPUT i_id, OUTPUT l_ok, OUTPUT TABLE RowErrors) |
| |
Descrição | Exclui a restrição de acesso formulário. |
| |
Parâmetros | Descrição |
| |
i_id | Código Identificador Sequencial |
| |
l_ok | Indentificador sucesso |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá excluir a restrição de acesso formulário. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
| |
getAllFormComponents |
| ||
Requisito | N/A |
| |
Sintaxe | getAllFormComponents (INPUT i_restriction, INPUT i_form, OUTPUT TABLE ttRegraAcesso, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna todos os componentes cadastrados para o formulário. |
| |
Parâmetros | Descrição |
| |
i_restriction | Codigo Identificador Sequencial Restrição |
| |
i_form | Codigo Identificador Sequencial Formulário |
| |
TABLE ttRegraAcesso | Tabela regras acesso |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá retornar todos os componentes cadastrados para o formulário. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
| |
setFormComponentRestriction |
| ||
Requisito | N/A |
| |
Sintaxe | setFormComponentRestriction (INPUT-OUTPUT TABLE ttRegraAcesso, OUTPUT TABLE RowErrors) |
| |
Descrição | Cria nova restrição de acesso ao componente do formulario. |
| |
Parâmetros | Descrição |
| |
TABLE ttRegraAcesso | Tabela regras acesso |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá retornar a restrição de acesso ao componente do formulário cadastrada na base. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
| |
persistRestrictionUserGroup |
| ||
Requisito | N/A |
| |
Sintaxe | persistRestrictionUserGroup (INPUT i_restriction, INPUT-OUTPUT TABLE ttRestricaoUsuarioVO, OUTPUT TABLE RowErrors) |
| |
Descrição | Cria nova restrição de acesso ao grupo de usuário. |
| |
Parâmetros | Descrição |
| |
i_restriction | Codigo Identificador Sequencial |
| |
TABLE ttRestricaoUsuarioVO | Tabela restrição usuário |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá retornar a restrição de acesso ao grupo de usuário cadastrada na base. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
| |
deleteRestrictionUserGroup |
| ||
Requisito | N/A |
| |
Sintaxe | deleteRestrictionUserGroup (INPUT i_id, OUTPUT l_ok, OUTPUT TABLE RowErrors) |
| |
Descrição | Exclui o grupo de usuário da restrição de acesso. |
| |
Parâmetros | Descrição |
| |
i_id | Código Identificador Sequencial |
| |
l_ok | Indentificador sucesso |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá excluir o grupo de usuário da restrição de acesso. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
| |
getUserRestrictions |
| ||
Requisito | N/A |
| |
Sintaxe | getUserRestrictions (INPUT c_form, INPUT c_user, OUTPUT TABLE ttRestricaoFormularioUsuario, OUTPUT TABLE RowErrors) |
| |
Descrição | Retorna todas as restrições do usuário. |
| |
Parâmetros | Descrição |
| |
c_form | Codigo Identificador Sequencial Formulário |
| |
c_user | Codigo Identificador Sequencial Usuário |
| |
TABLE ttRestricaoFormularioUsuario | Tabela restrição formulário usuário |
| |
TABLE RowErrors | Tabela de erros |
| |
Retorno | A API/BO irá retornar todas as restrições cadastradas para o usuário. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
| |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas