Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome físico: | lap/mlaapi021.p |
Objetivo
Esta API tem como objetivo realizar a apresentações de dados e realizar configurações visuais para o aplicativo do MLA.
Funcionamento
A API fornece uma série de métodos que podem ser executados individualmente para validações e configurações do MLA.
A sintaxe para a chamada da API, que deve ser de forma persistente:
run lap/mlaapi021.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.
Quando a API estiver executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
pi-get-approverUser-v1 | ||||
Requisito | Nenhum. | |||
Descrição | Retorna informações de um aprovador do MLA. | |||
Parâmetros | Tipo | Input/Output | Descrição | |
oInput | JsonObject | INPUT | Parâmetros para a busca do aprovador: queryParams → fields: Campos que devem ser retornados na busca, separados por vírgula, verificar campos possíveis no oOutput. queryParams → expand: Utilizando este parâmetro com a informação "visualConfigurations", são retornadas também as configurações visuais do usuário. pathParams: Informar o código do aprovador que se deseja buscar as informações.
| |
oOutput | JsonObject | OUTPUT | Informações do aprovador.
Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação.: tt-aprovador: que contém as informações principais do aprovador tt-config-visual (visualConfigurations): contém as informações de configuração visual do usuário. | |
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante o processo de busca dos aprovadores | |
Retorno | Aprovadores do MLA conforme filtros passados. |
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âmentros 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 | Indice 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 do swipe (Direito) (1 - Aprovar / 2 - Rejeitar / 3 - Nenhum) | Não se aplica | |
idi-acao-swip-esq | leftSwipeAction | INTEGER | Ação do swipe (Esquerdo) (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 |