Histórico da Página
...
Esta API tem como objetivo realizar a apresentações apresentação de dados e realizar configurações visuais para o aplicativo do MLA.
...
pi-get-users-with-layoutSetting-v1 | ||||||||
Requisito | Nenhum. | |||||||
Descrição | Retorna a lista de usuários que possuem layouts salvos para determinado documento | |||||||
Parâmetros | Tipo | Input/Output | Descrição | |||||
oInput | JsonObject | INPUT | Parâmetros para a busca dos usuários: pathParams: Informar na seguinte ordem: USERSWITHLAYOUT e número de documento.
| |||||
oOutput | JsonObject | OUTPUT | Informações dos usuários:
Sobre os campos retornados:
| |||||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante o processo de busca de usuários | |||||
Retorno | Usuários que possuem layout salvo para o documento solicitado. |
...
pi-delete-batch-layoutSetting-v1 | ||||||||
Requisito | Nenhum. | |||||||
Descrição | Eliminação de layouts de documento de usuário em lote | |||||||
Parâmetros | Tipo | Input/Output | Descrição | |||||
oInput | JsonObject | INPUT | Parâmetros para a busca dos usuários: pathParams: Informar na seguinte ordem: BATCH payload: Informar o objeto com layouts a serem eliminados
| |||||
oOutput | JsonObject | OUTPUT | Informações do processamento (para cada layout):
| |||||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante o processo de eliminação de layouts | |||||
Retorno | Erros ocorridos no processo de eliminação. |
...
pi-create-visualConfiguration-v1 | ||||||||
Requisito | Nenhum. | |||||||
Descrição | Cria as configurações visuais do usuário | |||||||
Parâmetros | Tipo | Input/Output | Descrição | |||||
oInput | JsonObject | INPUT | Parâmetros para a busca dos usuárioscriação das configurações visuis: payload: Informações das configurações visuais a serem criadas. Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:
| |||||
oOutput | JsonObject | OUTPUT | Resultado da criação do registro: 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 criação das configurações visuais. | |||||
Retorno | Informações do registro salvo ou erros ocorridos no processo. |
...
pi-upatch-visualConfiguration-v1 | ||||||||
Requisito | Nenhum. | |||||||
Descrição | Atualiza as configurações visuais do usuário. Obs.: Permite atualização parcial dos dados, ou seja, pode-se enviar apenas os campos que se deseja alterar. | |||||||
Parâmetros | Tipo | Input/Output | Descrição | |||||
oInput | JsonObject | INPUT | Parâmetros para a busca dos usuáriosalteração das configurações visuais: pathParams: Informar na seguinte ordem: o código do aprovador e interface. payload: Informações das configurações visuais a serem alteradas. Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:
| |||||
oOutput | JsonObject | OUTPUT | Resultado da alteração do registro: 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 alteração das configurações visuais. | |||||
Retorno | Informações do registro salvo ou erros ocorridos no processo. |
pi-update-visualConfiguration-v1 | ||||
Requisito | Nenhum. | |||
Descrição | Atualiza as configurações visuais do usuário. Obs.: Realiza atualização total dos dados, ou seja, se algum campo não for enviado seu conteúdo será limpo. | |||
Parâmetros | Tipo | Input/Output | Descrição | |
oInput | JsonObject | INPUT | Parâmetros para |
alteração das configurações visuais: pathParams: Informar na seguinte ordem: o código do aprovador e interface. payload: Informações das configurações visuais a serem alteradas. Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:
| ||||||||
oOutput | JsonObject | OUTPUT | Resultado da alteração do registro: 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 alteração das configurações visuais. | |||||
Retorno | Informações do registro salvo ou erros ocorridos no processo. |
pi-query-approverUser-v1 | ||||
Requisito | Nenhum. | |||
Descrição | Retorna informações de aprovadores conforme filtros informados. | |||
Parâmetros | Tipo | Input/Output | Descrição | |
oInput | JsonObject | INPUT | Parâmetros para a busca |
de aprovadores: queryParams |
:
|
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.
title | Exemplo |
---|
|
|
|
|
|
|
aOutput |
JsonArray | OUTPUT |
Lista de aprovadores retornados na busca. Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Retorno
Informações do registro salvo ou erros ocorridos no processo.
Definição de temp-tables:
| ||||
lHasNext | LOGICAL | OUTPUT | Indica existência de mais registros para busca | |
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante a busca de aprovadores. | |
Retorno | Informações de aprovadores ou erros ocorridos no processo de busca. |
pi-query-layoutSetting-v1 | ||||||||
Requisito | Nenhum. | |||||||
Descrição | Retorna informações de documentos disponíveis para configuração de layout do aprovador conforme filtros informados. | |||||||
Parâmetros | Tipo | Input/Output | Descrição | |||||
oInput | JsonObject | INPUT | Parâmetros para a busca de documentos: queryParams:
| |||||
aOutput | JsonArray | OUTPUT | Lista de documentos retornados na busca. Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação:
| |||||
lHasNext | LOGICAL | OUTPUT | Indica existência de mais registros para busca | |||||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante a busca de documentos. | |||||
Retorno | Informações de documentos ou erros ocorridos no processo de busca. |
pi-create-layoutSetting-v1 | ||||||||
Requisito | Nenhum. | |||||||
Descrição | Cria layout de documento do usuário | |||||||
Parâmetros | Tipo | Input/Output | Descrição | |||||
oInput | JsonObject | INPUT | Parâmetros para criação do layout do usuário para documento: payload: Informações do layout a ser criado:
| |||||
oOutput | JsonObject | OUTPUT | Resultado da criação do registro:
| |||||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante a criação do layout de documento do usuário. | |||||
Retorno | Informações do registro salvo ou erros ocorridos no processo. |
pi-create-batch-layoutSetting-v1 | ||||||||
Requisito | Nenhum. | |||||||
Descrição | Criação de layout de documento do usuário em lote. Obs: Pode ser usado para criar o layout da Listagem e Detalhe junto para o mesmo documento. | |||||||
Parâmetros | Tipo | Input/Output | Descrição | |||||
oInput | JsonObject | INPUT | Parâmetros para criação do layout do usuário para documento: pathParams: Informar BATCH payload: Informações do layout a ser criado:
| |||||
oOutput | JsonObject | OUTPUT | Resultado da criação do registro:
| |||||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante a criação dos layouts de documentos/usuários. | |||||
Retorno | Informações do registro salvo ou erros ocorridos no processo. |
pi-update-layoutSetting-v1 | ||||||||
Requisito | Nenhum. | |||||||
Descrição | Alteração de layout de documento do usuário | |||||||
Parâmetros | Tipo | Input/Output | Descrição | |||||
oInput | JsonObject | INPUT | Parâmetros para alteração do layout do usuário para documento: pathParams: Informar na seguinte ordem: o código do aprovador, interface e código do documento payload: Informações do layout a ser alterado:
| |||||
oOutput | JsonObject | OUTPUT | Resultado da criação do registro:
| |||||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante a alteração do layout de documento do usuário. | |||||
Retorno | Informações do registro salvo ou erros ocorridos no processo. |
pi-update-batch-layoutSetting-v1 | ||||||||
Requisito | Nenhum. | |||||||
Descrição | Alteração de layout de documento do usuário em lote. Obs: Pode ser usado para alteração do layout da Listagem e Detalhe junto para o mesmo documento. | |||||||
Parâmetros | Tipo | Input/Output | Descrição | |||||
oInput | JsonObject | INPUT | Parâmetros para alteração do layout do usuário para documento: pathParams: Informar BATCH. payload: Informações do layout a ser criado:
| |||||
oOutput | JsonObject | OUTPUT | Resultado da criação do registro:
| |||||
RowErrors | Temp-table | OUTPUT | Informações sobre os erros ocorridos durante a alteração dos layouts de documentos/usuários. | |||||
Retorno | Informações do registro salvo ou erros ocorridos no processo. |
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â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 |
RowErrors
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 |
INTEGER
Sim
Não se aplica
ErrorNumber
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 | |||||||||
tt-aprovador | Entrada/Saída | ||||||||
Temp-table com dados dos aprovadores | Saída | ||||||||
Atributo | Nome no objeto | Tipo | Descrição | Obrigatório | Evolução | ||||
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 | cod-usuar | userCode | CHARACTER | Código do aprovadorNão | Não se aplica | nome|
aprova-auto- | usuaraprov | userNameautomacticApprovalApprover | CHARACTER | NomeLOGICAL | Indica se o aprovador aprova automaticamente pendências do aprovador | Não | Não se aplica | ||
ecod-mailestabel | eMailsiteCode | CHARACTER | E-mail Estabelecimento do aprovador | Não | Não se aplica | ||||
enviacod-emaillotacao | sendEmailallocationCode | LOGICAL | CHARACTER | Lotação do aprovadorIndica se envia e-mail | Não | Não se aplica | |||
recebelibera-emailverba | receiveEmailreleaseAmount | LOGICAL | Indica se recebe e-mailo aprovador libera verba | Não | Não se aplica | ||||
log-usuar-mestreconfig | masterUserconfiguratorUser | LOGICAL | Indica Indice se o usuário aprovador é mestreconfigurador visual | Não | Não se aplica | ||||
mo-codigoempresa | currencycompanyCode | INTEGERCHARACTER | Moeda Empresa do aprovador | Não | Não se aplica | ||||
sigla-moedaidioma | currencyAbbrevlanguage | CHARACTER | Sigla da moeda Idioma do usuárioaprovador | Não | Não se aplicaaprova |
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- | config-visualEntrada/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 | |||||
acao-swip-esq | leftSwipeAction | INTEGER | Ação do swipe (Esquerdo) (1 - Aprovar / 2 - Rejeitar / 3 - Nenhum) | cod-usuar | CHARACTER | Código do aprovador | Não | Não se aplica | ||
idi-visualiz- | ordenacaoinicial | ordinationinitialView | INTEGER | Ordenação padrão:Visualização inicial (1 - | Mais recentes Todas as pendências / 2 - | Mais antigas Pendências principais / 3 - | Maior valor Pendências alternativas / 4 - | Menor valor / 5 - Tipo de documento / 6 - Empresa / 7 - EstabelecimentoPendências como mestre) | Não | Não se aplica |
lognum-mostraregistro-todas-empresaspaginac | allCompaniespageRecordsNumber | LOGICALINTEGER | Indica apresentação de pendências de todas as empresasNúmero de registros por página | Não | Não se aplicalog |
tt-config- | aprova-sem-motivvisual-upd | 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 | userCode | CHARACTER | Código do aprovador | Sim | approveWithoutReason | LOGICAL | Indica aprovação sem informar motivo | Não | Não se aplica | cdn-tempo-desf | undoTime | INTEGER | Tempo de desfazer | NãoNão se aplica | |
idi-acao-swip-direinterfac | idi-interfacrightSwipeAction | INTEGER | Interface | Sim Ação do swipe (Direito) (1 - Aprovar / 2 - Rejeitar / 3 - Nenhum) | Não se aplica | ||||||||||
idi-ordenacao | ordinationacao-swip-esqleftSwipeAction | INTEGER | Ação do swipe (Esquerdo)Ordenação padrão: (1 - | Aprovar Mais recentes / 2 - | Rejeitar Mais antigas / 3 - | Nenhum)Não | Não se aplica | idi-visualiz-inicial | initialView | INTEGER | Maior valor / 4 - Menor valor / 5 - Tipo de documento / 6 - Empresa / 7 - Estabelecimento) | Não | Não se aplica | ||
numlog-mostra-registrotodas-paginacempresas | pageRecordsNumberallCompanies | INTEGER | LOGICAL | Indica apresentação de pendências de todas as empresasNúmero de registros por página | Não | Não se aplica | |||||||||
log- | configaprova- | visual-updEntrada/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 | ||||||||||
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) | cod-usuar | userCode | CHARACTER | Código do aprovador | SimNão se aplica | |||||||
idi-interfac | idi-interfac | INTEGER | Interface | acao-swip-esq | leftSwipeAction | INTEGER | Ação do swipe (Esquerdo) (1 - Aprovar / 2 - Rejeitar / 3 - Nenhum) | NãoSim | Não se aplica | ||||||
idi-visualiz- | ordenacaoinicial | ordinationinitialView | INTEGER | Ordenação padrão:Visualização inicial (1 - | Mais recentes Todas as pendências / 2 - | Mais antigas Pendências principais / 3 - | Maior valor Pendências alternativas / 4 - | Menor valor / 5 - Tipo de documento / 6 - Empresa / 7 - EstabelecimentoPendências como mestre) | Não | Não se aplica | |||||
lognum-mostraregistro-todas-empresaspaginac | allCompaniespageRecordsNumber | LOGICALINTEGER | Indica apresentação de pendências de todas as empresasNúmero de registros por página | 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
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 |
Ação do swipe (Direito)
Interface (1 - |
Lista / 2 |
- |
Detalhe) | Sim | Não se aplica |
cod- |
tip- |
doc |
documentCode | INTEGER |
Ação do swipe (Esquerdo)
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 |
Visualização inicial
LOGICAL | Layout padrão |
Não | Não se aplica |
sigla | shortName | CHARACTER | Sigla do documento | Não | Não se aplica |
tt-document-com-expand | 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 |
nome-usuar | userName | CHARACTER | Nome do aprovador | Não | 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 |
expandables | _expandables | CHARACTER (Extent 1) | Lista de entidades filhas expansíveis | Não | Não se aplica |
...