Documento de API
Produto: | Datasul |
Ocorrência: | Documentação da Fachada |
Dados do Documento | |
Nome | Fachada Tarefas |
Descrição |
|
Nome Físico | fchcrm/fchcrm1000.p |
Include com Parâmetros | fchcrm/fchcrm1000.i |
Release Inicial | 12.1.8 |
Versão de Integração | N/A |
Data Liberação | N/A |
Banco | Mdtcrm |
Tabela | crm_tar |
Aplicativo | Portal CRM |
Evolução | |
Versão | 12.1.8 |
Programa | fchcrm/fchcrm1000.p |
Métodos Básicos
REST_GET | ||
Requisito | N/A | |
Sintaxe | N/A | |
Descrição | Retorna os registros (query) conforme parâmetros informados. | |
Parâmetros | Descrição | |
QP_start | Número do registro onde começa a busca. | |
QP_end | Quantidade de registros por busca. | |
QP_properties | Nomeia os campos para busca. | |
QP_values | Atribui os valores para os campos nomeados. | |
QP_orderBy | Nomeia campos para ordenação da busca. | |
QP_asc | Atribui o tipo de ordenação para os campos nomeados. | |
QP_count | Conta o número de registros? | |
QP_type | Tipo de registro. | |
REST_count | Número de registros. | |
DSCRMTarefa | Dataset com todas as temp-tables aninhadas. | |
RowErrors | Temp-table 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. |
findTask | ||
Requisito | N/A | |
Sintaxe | N/A | |
Descrição | Retorna os registros (query) conforme parâmetros informados. | |
Parâmetros | Descrição | |
i_start | Número do registro onde começa a busca. | |
i_end | Quantidade de registros por busca. | |
c_properties | Nomeia os campos para busca. | |
c_values | Atribui os valores para os campos nomeados. | |
c_orderby | Nomeia campos para ordenação da busca. | |
c_asc | Atribui o tipo de ordenação para os campos nomeados. | |
l_count | Conta o número de registros? | |
i_type | Tipo de registro. | |
i_count | Número de registros. | |
DSCRMTarefa | Dataset com todas as temp-tables aninhadas. | |
RowErrors | Temp-table 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. |
REST_GET_description | ||
Requisito | N/A | |
Sintaxe | N/A | |
Descrição | Retorna os registros (query) conforme parâmetros informados. | |
Parâmetros | Descrição | |
PP_id | Id da tarefa | |
dsl_motivo | Descrição da tarefa | |
RowErrors | Temp-table 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. |
getDescription | ||
Requisito | N/A | |
Sintaxe | N/A | |
Descrição | Retorna os registros (query) conforme parâmetros informados. | |
Parâmetros | Descrição | |
i_id | Id da tarefa | |
c_description | Descrição da tarefa | |
RowErrors | Temp-table 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. |
REST_POST_execute | ||
Requisito | N/A | |
Sintaxe | N/A | |
Descrição | Retorna os registros (query) conforme parâmetros informados. | |
Parâmetros | Descrição | |
PP_id | Id da tarefa | |
DSCRMTarefa | DATASET com as tabelas aninhadas | |
RowErrors | Temp-table 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. |
executeTask | ||
Requisito | N/A | |
Sintaxe | N/A | |
Descrição | Retorna os registros (query) conforme parâmetros informados. | |
Parâmetros | Descrição | |
i_id | Id da tarefa | |
DSCRMTarefa | Dataset com as tabelas aninhadas | |
RowErrors | Temp-table 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. |
executePlainTask | ||
Requisito | N/A | |
Sintaxe | N/A | |
Descrição | Retorna os registros (query) conforme parâmetros informados. | |
Parâmetros | Descrição | |
i_id | Id da tarefa | |
RowErrors | Temp-table 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. |
REST_PUT | ||
Requisito | N/A | |
Sintaxe | N/A | |
Descrição | Retorna os registros (query) conforme parâmetros informados. | |
Parâmetros | Descrição | |
PP_id | Id da tarefa | |
ttTarefaVO | Temp-table com os dados para alteração | |
DSCRMTarefa | Dataset com as temp-tables aninhadas | |
RowErrors | Temp-table 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. |
REST_POST | ||
Requisito | N/A | |
Sintaxe | N/A | |
Descrição | Retorna os registros (query) conforme parâmetros informados. | |
Parâmetros | Descrição | |
ttTarefaVO | Temp-table com so dados a serem salvos | |
DSCRMTarefa | Dataset com as temp-tables aninhadas | |
RowErrors | Temp-tables de errors | |
Retorno | A API/BO irá retornar os registros selecionados e a quantidade. Caso ocorra erros, retorna a tabela de erros encontrados para o programa. |
persistTask | ||
Requisito | N/A | |
Sintaxe | N/A | |
Descrição | Retorna os registros (query) conforme parâmetros informados. | |
Parâmetros | Descrição | |
i_id | Id da tarefa | |
ttTarefaVO | Temp-table com so dados a serem salvos | |
DSCRMTarefa | Dataset com as temp-tables aninhadas | |
RowErrors | Temp-table 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. |
REST_GET_detail | ||
Requisito | N/A | |
Sintaxe | N/A | |
Descrição | Retorna os registros (query) conforme parâmetros informados. | |
Parâmetros | Descrição | |
PP_id | Id da tarefa | |
DSCRMTarefa | Dataset com as tabelas aninhadas | |
RowErrors | Temp-table 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. |
getTask | ||
Requisito | N/A | |
Sintaxe | N/A | |
Descrição | Retorna os registros (query) conforme parâmetros informados. | |
Parâmetros | Descrição | |
i_id | Id da tarefa | |
DSCRMTarefa | Dataset com a temp-tables aninhadas | |
RowErrors | Temp-table 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. |