Histórico da Página
APIMYPENDINGAPPROVAL - Informações para Aplicativo MLA
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome físico: | lap/apiMyPendingApproval.p |
Objetivo
Esta API tem como objetivo de fornecedor informações para apresentações de dados para o aplicativo do MLA, assim como realização das aprovações.
Funcionamento
A API fornece uma série de métodos que podem ser executados individualmente para apresentação de dados no aplicativo MLA, assim como realização de aprovações de pendências.
A sintaxe para a chamada da API, que deve ser de forma persistente:
run lap/apiMyPendingApproval.p persistent set h-handle. |
A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.
Método Negócio
Quando a API estiver executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
pi-get-defaults-v1 | ||||||||
Requisito | Nenhum. | |||||||
Descrição | Retorna dados principais para carregamento inicial do APP: empresas, estabelecimentos e documentos do aprovador com seus layouts. | |||||||
Parâmetros | Tipo | Input/Output | Descrição | |||||
oInput | JsonObject | INPUT | Parâmetros para a busca dos dados iniciais: pathParams: Informar na seguinte ordem: getDefaults e código do aprovador.
| |||||
oOutput | JsonObject | OUTPUT | Informações iniciais para o APP:
Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:
| |||||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante o processo de busca dos dados | |||||
Retorno | Dados principais para inicialização do APP ou erros ocorridos durante o processo de busca. |
pi-get-document-abrev | ||||
Requisito | Nenhum. | |||
Descrição | Retorna a sigla do documento | |||
Parâmetros | Tipo | Input/Output | Descrição | |
piDocumentCode | INTEGER | INPUT | Código do documento | |
pcDocumentDescription | CHARACTER | INPUT | Descrição do documento | |
pcSigla | CHARACTER | OUTPUT | Sigla do documento | |
Retorno | Sigla do documento. |
pi-validate-user-info-v1 | ||||||||
Requisito | Nenhum. | |||||||
Descrição | Realiza validações do usuário para acesso:
| |||||||
Parâmetros | Tipo | Input/Output | Descrição | |||||
oInput | JsonObject | INPUT | Parâmetros para a validação do aprovador: pathParams: Informar na seguinte ordem: validateUserInfo e código do aprovador.
| |||||
oOutput | JsonObject | OUTPUT | Campo indicando se o usuário está válido:
| |||||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante o processo de validação. | |||||
Retorno | Indica se o usuário está válido e caso não esteja, os erros de validação. |
pi-query-app-list-v1 | ||||||||
Requisito | Nenhum. | |||||||
Descrição | Realiza a busca de pendências a ser apresentada na listagem do APP. Obs.: Os campos são retornados conforme layout configurado para cada usuário e documento. | |||||||
Parâmetros | Tipo | Input/Output | Descrição | |||||
oInput | JsonObject | INPUT | Parâmetros para a busca das pendências: pathParams: Informar: getPendingApprovalToList queryParams:
| |||||
oOutput | JsonObject | OUTPUT | Informações das pendências:
Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:
| |||||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante o processo de busca das pendências. | |||||
Retorno | Informações de pendências a serem apresentadas ou erros ocorridos durante a busca. |
pi-query-pending-approval | ||||
Requisito | Nenhum. | |||
Descrição | Realiza a busca de pendências a ser apresentada na listagem do APP. | |||
Parâmetros | Tipo | Input/Output | Descrição | |
ttParamPendingApproval | TEMP-TABLE | INPUT | Parâmetros para busca dos registros de pendências | |
tt-mla-doc-pend-aprov | TEMP-TABLE | OUTPUT | Listagem com informações das pendências | |
lHasNext | LOGICAL | OUTPUT | Indica que existem mais registros a serem mostrados | |
rNextRowid | ROWID | OUTPUT | Próximo rowid para busca de novos registros | |
RowErrors | TEMP-TABLE | OUTPUT | Informações sobre os erros ocorridos durante o processo de busca das pendências. | |
Retorno | Informações de pendências a serem apresentadas ou erros ocorridos durante a busca. |
pi-query-rejection-options-v1 | ||||||||
Requisito | Nenhum. | |||||||
Descrição | Realiza a busca de códigos de rejeição disponíveis | |||||||
Parâmetros | Tipo | Input/Output | Descrição | |||||
oInput | JsonObject | INPUT | Parâmetros para busca dos códigos de rejeição: pathParams: Informar: rejectionOptions.
| |||||
oOutput | JsonObject | OUTPUT | Lista de rejeições:
Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:
| |||||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante a busca dos códigos de rejeição. | |||||
Retorno | Informações dos códigos de rejeição ou erros ocorridos durante a busca. |
pi-get-detail-pending-v1 | ||||||||
Requisito | Nenhum. | |||||||
Descrição | Realiza a busca dos detalhes de uma pendência de aprovação. Obs.: Os campos são retornados conforme layout configurado para cada usuário e documento. | |||||||
Parâmetros | Tipo | Input/Output | Descrição | |||||
oInput | JsonObject | INPUT | Parâmetros para detalhamento da pendência: pathParams: Informar na ordem: detailPending e o número da transação.
| |||||
oOutput | JsonObject | OUTPUT | Informações de layouts e dados da pendência solicitada:
Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:
| |||||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante a busca de detalhes da pendência. | |||||
Retorno | Informações dos detalhes da pendência ou erros ocorridos durante a busca. |
pi-get-detail-historic-pending-v1 | ||||||||
Requisito | Nenhum. | |||||||
Descrição | Realiza a busca do histórico de aprovação de uma pendência. | |||||||
Parâmetros | Tipo | Input/Output | Descrição | |||||
oInput | JsonObject | INPUT | Parâmetros para busca do histórico de aprovação: pathParams: Informar na ordem: detailHistoricPending e o número da transação.
| |||||
oOutput | JsonObject | OUTPUT | Informações de histórico:
Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:
| |||||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante a busca de histórico. | |||||
Retorno | Informações dos históricos ou erros ocorridos durante a busca. |
pi-approve-v1 | ||||||||
Requisito | Nenhum. | |||||||
Descrição | Realiza a aprovação de pendência(s). | |||||||
Parâmetros | Tipo | Input/Output | Descrição | |||||
oInput | JsonObject | INPUT | Parâmetros para aprovação de pendência(s): pathParams: Informar: approve payload:
| |||||
oOutput | JsonObject | OUTPUT | Informações da aprovação:
| |||||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante a aprovação das pendências. | |||||
Retorno | Informação de sucesso ou erros ocorridos no processo de aprovação. |
pi-reprove-v1 | ||||||||
Requisito | Nenhum. | |||||||
Descrição | Realiza a reprovação de pendência(s). | |||||||
Parâmetros | Tipo | Input/Output | Descrição | |||||
oInput | JsonObject | INPUT | Parâmetros para reprovação de pendência(s): pathParams: Informar: reprove payload:
| |||||
oOutput | JsonObject | OUTPUT | Informações da reprovação:
| |||||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante a reprovação das pendências. | |||||
Retorno | Informação de sucesso ou erros ocorridos no processo de reprovação. |
pi-reapprove-v1 | ||||||||
Requisito | Nenhum. | |||||||
Descrição | Realiza a re-aprovação de pendência(s). | |||||||
Parâmetros | Tipo | Input/Output | Descrição | |||||
oInput | JsonObject | INPUT | Parâmetros para re-aprovação de pendência(s): pathParams: Informar: reapprove payload:
| |||||
oOutput | JsonObject | OUTPUT | Informações da re-aprovação:
| |||||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante a re-aprovação das pendências. | |||||
Retorno | Informação de sucesso ou erros ocorridos no processo de re-aprovação. |
pi-process-pending-v1 | ||||
Requisito | Nenhum. | |||
Descrição | Realiza a aprovação, reprovação ou re-aprovação de pendências. | |||
Parâmetros | Tipo | Input/Output | Descrição | |
iAction | INTEGER | INPUT | Ação 1 - Aprovação 2 - Reprovação 3 - Reaprovação | |
ttTransactions | TEMP-TABLE | INPUT | Lista de transações a serem processadas | |
cText | CHARACTER | INPUT | Comentário de aprovação/reprovação | |
iRejectionCode | INTEIRO | INPUT | Código de rejeição | |
sucessProcess | LOGICAL | OUTPUT | Indica o processamento com sucesso (de pelo menos uma pendência) | |
RowErrors | TEMP-TABLE | OUTPUT | Informações sobre os erros ocorridos durante o processo de aprovação/reprovação. | |
Retorno | Informação de sucesso ou erros ocorridos no processamento das pendências. |
Definição de temp-tables:
RowErrors | Entrada/Saída | |||
Temp-table com dados dos erros ocorridos durante o processo | Saída | |||
Atributo | Tipo | Descrição | Obrigatório | Evolução |
ErrorSequence | INTEGER | Número da sequência do erro | Sim | Não se aplica |
ErrorNumber | INTEGER | Código do erro | Sim | Não se aplica |
ErrorDescription | CHARACTER | Descrição do erro | Sim | Não se aplica |
ErrorParameters | CHARACTER | Parâmetros da mensagem de erro | Sim | Não se aplica |
ErrorType | CHARACTER | Tipo do erro | Sim | Não se aplica |
ErrorHelp | CHARACTER | Texto de ajuda da mensagem de erro | Sim | Não se aplica |
ErrorSubType | CHARACTER | Subtipo do erro | Sim | Não se aplica |
tt-aprovador | Entrada/Saída | ||||
Temp-table com dados dos aprovadores | Saída | ||||
Atributo | Nome no objeto | Tipo | Descrição | Obrigatório | Evolução |
cod-usuar | userCode | CHARACTER | Código do aprovador | Não | Não se aplica |
nome-usuar | userName | CHARACTER | Nome do aprovador | Não | Não se aplica |
CHARACTER | E-mail do aprovador | Não | Não se aplica | ||
envia-email | sendEmail | LOGICAL | Indica se envia e-mail | Não | Não se aplica |
recebe-email | receiveEmail | LOGICAL | Indica se recebe e-mail | Não | Não se aplica |
usuar-mestre | masterUser | LOGICAL | Indica se o usuário é mestre | Não | Não se aplica |
mo-codigo | currency | INTEGER | Moeda do aprovador | Não | Não se aplica |
sigla-moeda | currencyAbbrev | CHARACTER | Sigla da moeda do usuário | Não | Não se aplica |
aprova-auto | automacticApproval | LOGICAL | Indica se o aprovador aprova automaticamente | Não | Não se aplica |
aprova-auto-aprov | automacticApprovalApprover | LOGICAL | Indica se o aprovador aprova automaticamente pendências do aprovador | Não | Não se aplica |
cod-estabel | siteCode | CHARACTER | Estabelecimento do aprovador | Não | Não se aplica |
cod-lotacao | allocationCode | CHARACTER | Lotação do aprovador | Não | Não se aplica |
libera-verba | releaseAmount | LOGICAL | Indica se o aprovador libera verba | Não | Não se aplica |
log-usuar-config | configuratorUser | LOGICAL | Indica se o aprovador é configurador visual | Não | Não se aplica |
empresa | companyCode | CHARACTER | Empresa do aprovador | Não | Não se aplica |
idioma | language | CHARACTER | Idioma do aprovador | Não | Não se aplica |
tt-config-visual | Entrada/Saída | ||||
Temp-table com dados de configurações visuais de aprovadores | Saída | ||||
Atributo | Nome no objeto | Tipo | Descrição | Obrigatório | Evolução |
cod-usuar | CHARACTER | Código do aprovador | Não | Não se aplica | |
idi-ordenacao | ordination | INTEGER | Ordenação padrão: (1 - Mais recentes / 2 - Mais antigas / 3 - Maior valor / 4 - Menor valor / 5 - Tipo de documento / 6 - Empresa / 7 - Estabelecimento) | Não | Não se aplica |
log-mostra-todas-empresas | allCompanies | LOGICAL | Indica apresentação de pendências de todas as empresas | Não | Não se aplica |
log-aprova-sem-motiv | approveWithoutReason | LOGICAL | Indica aprovação sem informar motivo | Não | Não se aplica |
cdn-tempo-desf | undoTime | INTEGER | Tempo de desfazer | Não | Não se aplica |
idi-acao-swip-dire | rightSwipeAction | INTEGER | Ação de deslizar (Direita) (1 - Aprovar / 2 - Rejeitar / 3 - Nenhum) | Não se aplica | |
idi-acao-swip-esq | leftSwipeAction | INTEGER | Ação de deslizar (Esquerda) (1 - Aprovar / 2 - Rejeitar / 3 - Nenhum) | Não | Não se aplica |
idi-visualiz-inicial | initialView | INTEGER | Visualização inicial (1 - Todas as pendências / 2 - Pendências principais / 3 - Pendências alternativas / 4 - Pendências como mestre) | Não | Não se aplica |
num-registro-paginac | pageRecordsNumber | INTEGER | Número de registros por página | Não | Não se aplica |
ttCompany | Entrada/Saída | ||||
Temp-table com dados de empresas | Saída | ||||
Atributo | Nome no objeto | Tipo | Descrição | Obrigatório | Evolução |
seqGroup | INTEGER | Sequência da empresa | Sim | Não se aplica | |
cCode | code | CHARACTER | Código da empresa | Sim | Não se aplica |
cName | name | CHARACTER | Nome da empresa | Sim | Não se aplica |
ttEstablishments | Entrada/Saída | ||||
Temp-table com dados de estabelecimentos | Saída | ||||
Atributo | Nome no objeto | Tipo | Descrição | Obrigatório | Evolução |
cCode | code | CHARACTER | Código do estabelecimento | Sim | Não se aplica |
cName | name | CHARACTER | Nome do estabelecimento | Sim | Não se aplica |
cCodeCompany | codeCompany | CHARACTER | Código da empresa | Sim | Não se aplica. |
tt-document | Entrada/Saída | ||||
Temp-table com dados de documentos | Saída | ||||
Atributo | Nome no objeto | Tipo | Descrição | Obrigatório | Evolução |
cod-usuar | userCode | CHARACTER | Código do aprovador | Sim | Não se aplica |
idi-interfac | interface | INTEGER | Interface (1 - Lista / 2 - Detalhe) | Sim | Não se aplica |
cod-tip-doc | documentCode | INTEGER | Código do documento | Sim | Não se aplica |
desc-tip-doc | documentDescription | CHARACTER | Descrição do documento | Não | Não se aplica |
layout-padrao | defaultLayout | LOGICAL | Layout padrão | Não | Não se aplica |
sigla | shortName | CHARACTER | Sigla do documento | Não | Não se aplica |
tt-layout | Entrada/Saída | ||||
Temp-table com campos de layout | Saída | ||||
Atributo | Nome no objeto | Tipo | Descrição | Obrigatório | Evolução |
cdn-docto | INTEGER | Código do documento | Sim | Não se aplica | |
cod-usuar | CHARACTER | Código do aprovador | Sim | Não se aplica | |
idi-interfac | INTEGER | Interface (1 - Lista / 2 - Detalhe) | Sim | Não se aplica | |
cod-id-campo | id | CHARACTER | Identificador do campo | Sim | Não se aplica |
idi-compon | componentType | INTEGER | Tipo de componente (1 - Campo / 2 - Lista / 3 - Separador) | Sim | Não se aplica |
nom-rotu-campo | label | CHARACTER | Rótulo do campo | Não | Não se aplica |
des-campo | description | CHARACTER | Descrição do campo | Sim | Não se aplica |
log-visivel | visible | LOGICAL | Visibilidade do campo | Sim | Não se aplica |
cdn-tamanho | size | INTEGER | Tamanho do campo | Sim | Não se aplica |
cdn-ord | INTEGER | Ordem do campo | Sim | Não se aplica | |
cod-entid-pai | CHARACTER | Identificação da entidade pai | Não | Não se aplica | |
Índice: visivel-ordem, log-visivel, cdn-ord |
tt-mla-doc-pend-aprov | Entrada/Saída | ||||
Temp-table com dados de pendências | Saída | ||||
Atributo | Nome no objeto | Tipo | Descrição | Obrigatório | Evolução |
nr-trans | transactionNumber | INTEGER | Número da transação | Sim | Não se aplica |
cod-tip-doc | documentType | INTEGER | Código do documento | Sim | Não se aplica |
chave-doc | documentKey | CHARACTER | Chave do documento | Sim | Não se aplica |
dt-geracao | generateDate | DATE | Data de geração | Sim | Não se aplica |
cod-usuar | approver | CHARACTER | Código do aprovador | Sim | Não se aplica |
ind-situacao | status | INTEGER | Situação da pendência 1 - Pendente 2 - Aprovada 3 - Reprovada 4 - Reaprovada | Sim | Não se aplica |
ep-codigo | company | CHARACTER | Empresa | Sim | Não se aplica |
cod-estabel | site | CHARACTER | Estabelecimento | Sim | Não se aplica |
tipo | pendencyType | INTEGER | Tipo 1 - Principal 2 - Alternativa 3 - Mestre | Sim | Não se aplica |
valor-doc | price | DECIMAL | Valor do documento |
tt-fields | Entrada/Saída | ||||
Temp-table com informações de campos e valores das pendências | Saída | ||||
Atributo | Nome no objeto | Tipo | Descrição | Obrigatório | Evolução |
nr-trans | INTEGER | Número da transação | Sim | Não se aplica | |
id-campo | id | CHARACTER | ID do campo | Sim | Não se aplica |
valor-campo | value | CHARACTER | Valor do campo | Sim | Não se aplica |
ttParamPendingApproval | Entrada/Saída | |||
Temp-table com parâmetros para busca de pendências | Saída | |||
Atributo | Tipo | Descrição | Obrigatório | Evolução |
company | CHARACTER | Empresa, se deixar em branco serão consideradas todas as empresas | Não | Não se aplica |
establishment | CHARACTER | Estabelecimento, se deixar em branco serão considerados todos os estabelecimentos | Não | Não se aplica |
initialGenerationDate | DATE | Data de geração inicial | Não | Não se aplica |
finalGenerationDate | DATE | Data de geração final | Não | Não se aplica |
mainPendencies | LOGICAL | Indica se devem ser apresentadas as pendências principais | Sim | Não se aplica |
alternativePendencies | LOGICAL | Indica se devem ser apresentadas as pendências alternativas | Sim | Não se aplica |
masterPendencies | LOGICAL | Indica se devem ser apresentadas as pendências como mestre | Sim | Não se aplica |
documents | CHARACTER | Documentos a serem considerados (separados por vírgula) | Sim | Não se aplica |
pendingPendencies | LOGICAL | Indica se devem ser apresentadas pendências "pendentes" | Sim | Não se aplica |
approvedPendencies | LOGICAL | Indica se devem ser apresentadas pendências "aprovadas" | Sim | Não se aplica |
rejectedPendencies | LOGICAL | Indica se devem ser apresentadas pendências "reprovadas" | Sim | Não se aplica |
reApprovedPendencies | LOGICAL | Indica se devem ser apresentadas pendências "reaprovadas" | Sim | Não se aplica |
sortType | CHARACTER | Ordenação: Opções possíveis (se não informado será utilizado: -generationDate):
| Não | Não se aplica |
pageSize | INTEGER | Tamanho da página (número de registros retornados). Se não informado será considerado: 20. | Não | Não se aplica |
nextPageRowid | ROWID | Rowid do registro da próxima página | Não | Não se aplica |
ttRejectionCode | Entrada/Saída | ||||
Temp-table com informações de códigos de rejeição | Saída | ||||
Atributo | Nome no objeto | Tipo | Descrição | Obrigatório | Evolução |
iCodRejeita | code | INTEGER | Código de rejeição | Sim | Não se aplica |
cCodRejeita | description | CHARACTER | Descrição | Sim | Não se aplica |
obriga-narrativa | reasonIsRequired | LOGICAL | Indica se o código de rejeição obriga narrativa | Sim | Não se aplica |
ttHistoricPending | Entrada/Saída | ||||
Temp-table com informações dos históricos de aprovação | Saída | ||||
Atributo | Nome no objeto | Tipo | Descrição | Obrigatório | Evolução |
nivel | INTEGER | Nível de aprovação | Sim | Não se aplica | |
desc-nivel | approveType | CHARACTER | Descrição do nível de aprovação | Sim | Não se aplica |
cod-aprovador | approverCode | CHARACTER | Código do aprovador | Sim | Não se aplica |
nome-aprovador | approverDescription | CHARACTER | Nome do aprovador | Sim | Não se aplica |
data-aprovacao | approveDate | DATE | Data da aprovação | Sim | Não se aplica |
hora-aprovacao | approveHour | CHARACTER | Hora da aprovação | Sim | Não se aplica |
narrativa | text | CHARACTER | Narrativa | Sim | Não se aplica |
situacao | status | INTEGER | Situação 1 - Pendente 2 - Aprovada 3 - Reprovada 4 - Reaprovada | Sim | Não se aplica |
ttTransactions | Entrada/Saída | ||||
Temp-table com números de transações de pendências | Saída | ||||
Atributo | Nome no objeto | Tipo | Descrição | Obrigatório | Evolução |
nr-trans | transactionNumber | INTEGER | Número da transação | Sim | Não se aplica |