Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

pi-query-approverUser-v1

Requisito

Nenhum.

Descrição

Retorna informações de aprovadores conforme filtros informados.

Parâmetros

Tipo

Input/Output

Descrição

oInputJsonObjectINPUT

Parâmetros para a busca de aprovadores:

queryParams:

  • fields: Campos que devem ser retornados na busca, separados por vírgula, verificar campos possíveis na temp-table tt-aprovador no final desta documentação (utilizar o "Nome do objeto");
  • quickSearch: Filtro rápido por código ou nome do aprovador;
  • order: Ordenação (verificar campos possíveis na temp-table tt-aprovador no final desta documentação (utilizar o "Nome do objeto"). Para ordenação decrescente utilizar o sinal "-" antes do campo;
  • <Nome do objeto>: Filtro pelo campo informado;
  • userCodeIni: Filtra por aprovadores com código maior ou igual ao informado;
  • userCodeEnd: Filtra por aprovadores com código menor ou igual ao informado;
  • userNameIni: Filtra por aprovadores com nome maior ou igual ao informado;
  • userNameEnd: Filtra por aprovadores com nome menor ou igual ao informado;
  • pageSize: Tamanho da página (registros que serão retornados por vez);


Bloco de código
titleExemplo
{
  "queryParams": {
    "userCodeIni": [
      "ana"
    ],
    "userCodeEnd": [
      "super"
    ],
    "order": [
      "-userCode"
    ],
    "pageSize": [
      "10"
    ]
  },
}
aOutputJsonArrayOUTPUT

Lista de aprovadores retornados na busca.

Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação: 

  • tt-aprovador


Bloco de código
titleExemplo
[
  {
    "userCode": "super",
    "userName": "Super Usuário",
    "eMail": "[email protected]",
    "sendEmail": true,
    "receiveEmail": true,
    "masterUser": true,
    "currency": 0,
    "automaticApproval": false,
    "automaticApprovalApprover": false,
    "siteCode": "1",
    "allocationCode": "10702",
    "releaseAmount": true,
    "configuratorUser": true,
    "companyCode": "10",
    "language": "pt"
  },
  {
    "userCode": "massao",
    "userName": "M.Massao Matsunaka-Ger.Suprim.",
    "eMail": "[email protected]",
    "sendEmail": true,
    "receiveEmail": true,
    "masterUser": false,
    "currency": 0,
    "automaticApproval": true,
    "automaticApprovalApprover": false,
    "siteCode": "1",
    "allocationCode": "",
    "releaseAmount": false,
    "configuratorUser": false,
    "companyCode": "10",
    "language": "pt"
  },
  {
    "userCode": "ana claudia",
    "userName": "Ana Cludia de Oliveira",
    "eMail": "[email protected]",
    "sendEmail": false,
    "receiveEmail": false,
    "masterUser": false,
    "currency": 0,
    "automaticApproval": true,
    "automaticApprovalApprover": false,
    "siteCode": "a1",
    "allocationCode": "",
    "releaseAmount": false,
    "configuratorUser": false,
    "companyCode": "",
    "language": "pt"
  }
]
lHasNextLOGICALOUTPUTIndica existência de mais registros para busca
RowErrorsTemp-tableOUTPUTInformações sobre os erros ocorridos durante a busca de aprovadores.

Retorno

Informações de aprovadores ou erros ocorridos no processo de busca.

Definição de temp-tables:



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

oInputJsonObjectINPUT

Parâmetros para a busca de documentos:

queryParams:

  • userCode: Código do aprovador que se deseja verificar os layouts;
  • interface: Interface para qual se deseja verificar os layouts;
  • fields: Campos que devem ser retornados na busca, separados por vírgula, verificar campos possíveis na temp-table tt-document no final desta documentação (utilizar o "Nome do objeto");
  • order: Ordenação (verificar campos possíveis na temp-table tt-document no final desta documentação (utilizar o "Nome do objeto"). Para ordenação decrescente utilizar o sinal "-" antes do campo;
  • <Nome do objeto>: Filtro pelo campo informado;
  • documentCodeIni: Filtra por documentos com código maior ou igual ao informado;
  • documentCodeEnd: Filtra por documentos com código menor ou igual ao informado;


Bloco de código
titleExemplo
{
  "queryParams": {
    "userCode": [
      "super"
    ],
    "interface": [
      "1"
    ],
    "order": [
      "shortName"
    ]
  }
}
aOutputJsonArrayOUTPUT

Lista de documentos retornados na busca.

Para verificar o que significa cada campo, conferir nas temp-tables no final desta documentação: 

  • tt-aprovador


Bloco de código
titleExemplo
[
  {
    "documentCode": 5,
    "documentDescription": "Cotação de Materiais",
    "defaultLayout": false,
    "shortName": "CO"
  },
  {
    "documentCode": 501,
    "documentDescription": "Documento Específico",
    "defaultLayout": true,
    "shortName": "D"
  },
  {
    "documentCode": 1,
    "documentDescription": "Solicitação de Compra - Item",
    "defaultLayout": false,
    "shortName": "SC"
  }
]
lHasNextLOGICALOUTPUTIndica existência de mais registros para busca
RowErrorsTemp-tableOUTPUTInformações sobre os erros ocorridos durante a busca de documentos.

Retorno

Informações de documentos ou erros ocorridos no processo de busca.



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

ErrorDescriptionCHARACTER Descrição do erro SimNão se aplica
ErrorParametersCHARACTER Parâmentros da mensagem de erro SimNão se aplica
ErrorTypeCHARACTER Tipo do erro SimNão se aplica
ErrorHelpCHARACTER Texto de ajuda da mensagem de erro SimNão se aplica
ErrorSubTypeCHARACTERSubtipo do erroSimNão se aplica



tt-aprovador

RowErrors

Entrada/Saída

Temp-table com dados

dos erros ocorridos durante o processo

dos aprovadores

Saída

Atributo

Nome no objeto

Tipo

Descrição

Obrigatório

Evolução

ErrorSequence

cod-usuar

 INTEGER

Número da sequência do erro

Sim

Não se aplica

ErrorNumber

INTEGER Código do erro 
userCode

CHARACTER 

Código do aprovador

Não

Sim

Não se aplica

nome-usuar

ErrorDescription
userNameCHARACTER 
Descrição
Nome do
erro 
aprovador
Sim

Não

Não se aplica

ErrorParametersCHARACTER Parâmentros da mensagem de erro SimNão se aplicaErrorTypeCHARACTER Tipo do erro 
e-maileMailCHARACTER E-mail do aprovadorNão
Sim
Não se aplica
ErrorHelpCHARACTER Texto de ajuda da mensagem de erro 
envia-emailsendEmailLOGICALIndica se envia e-mailNão
Sim
Não se aplica
recebe-email
ErrorSubType
receiveEmail
CHARACTERSubtipo do erro
LOGICALIndica se recebe e-mailNão
SimttaprovadorCódigo nomeusuarNome do aprovadorLotação
Não se aplica
usuar-mestre

Entrada/Saída

Temp-table com dados dos aprovadores

Saída

Atributo

Nome no objeto

Tipo

Descrição

Obrigatório

Evolução

masterUserLOGICALIndica se o usuário é mestreNãoNão se aplica
mo-codigocurrencyINTEGERMoeda

cod-usuar

userCode

CHARACTER 

do aprovadorNãoNão se aplica
sigla-moedauserNamecurrencyAbbrevCHARACTER Sigla da moeda do usuárioNãoNão se aplica
eaprova-mailautoeMailautomacticApprovalCHARACTER LOGICALIndica se o aprovador aprova automaticamenteE-mail do aprovadorNãoNão se aplica
enviaaprova-auto-emailaprovsendEmailautomacticApprovalApproverLOGICALIndica se envia e-mailo aprovador aprova automaticamente pendências do aprovadorNãoNão se aplica
recebecod-emailestabelreceiveEmailsiteCodeLOGICALCHARACTER Estabelecimento do aprovadorIndica se recebe e-mailNãoNão se aplica
usuarcod-mestrelotacaomasterUserallocationCodeLOGICALCHARACTER Lotação do aprovadorIndica se o usuário é mestreNãoNão se aplica
molibera-codigoverbacurrencyreleaseAmountINTEGERLOGICALIndica se o aprovador libera verbaMoeda do aprovadorNãoNão se aplica
siglalog-usuar-moedaconfigcurrencyAbbrevconfiguratorUserCHARACTER LOGICALIndice se o aprovador é configurador visualSigla da moeda do usuárioNãoNão se aplica
aprova-autoempresaautomacticApprovalcompanyCodeLOGICALCHARACTER Empresa do aprovadorIndica se o aprovador aprova automaticamenteNãoNão se aplica
idiomalanguageCHARACTER Idioma aprova-auto-aprovautomacticApprovalApproverLOGICALIndica se o aprovador aprova automaticamente pendências do aprovadorNãoNão se aplica
cod-estabelsiteCodeCHARACTER Estabelecimento do aprovadorNãoNão se aplica
cod-lotacaoallocationCodeCHARACTER 



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

libera

idi-

verba

ordenacao

ordination
releaseAmount
INTEGER
LOGICALIndica se o aprovador libera verba

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-
usuar
mostra-todas-
config
empresas
configuratorUser
allCompaniesLOGICAL
Indice se o aprovador é configurador visual
Indica apresentação de pendências de todas as empresasNãoNão se aplica
empresacompanyCodeCHARACTER Empresa do aprovador
log-aprova-sem-motivapproveWithoutReasonLOGICALIndica aprovação sem informar motivoNãoNão se aplica
idiomalanguageCHARACTER Idioma do aprovadorttconfigvisualordenacaoOrdenação padrão: Mais recentes Mais antigas Maior valor Menor valor / 5 - Tipo de documento / 6 - Empresa / 7 - Estabelecimento
cdn-tempo-desfundoTimeINTEGERTempo de desfazerNãoNão se aplica
idi-acao-swip-dire

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

rightSwipeActionINTEGER

Ação do swipe (Direito)

(1 - Aprovar / 2 - Rejeitar / 3 - Nenhum)


Não se aplica
idi-acao-swip-esqleftSwipeActionINTEGER

Ação do swipe (Esquerdo)

(1 - Aprovar / 2 - Rejeitar / 3 - Nenhum)

cod-usuar

CHARACTER 

Código do aprovadorNãoNão se aplica
idi-visualiz-inicialordinationinitialViewINTEGER

Visualização inicial

(1 -

Todas as pendências / 2 -

Pendências principais / 3 -

Pendências alternativas / 4 -

Pendências como mestre)

NãoNão se aplica
lognum-mostraregistro-todas-empresaspaginacallCompaniespageRecordsNumberLOGICALINTEGERIndica apresentação de pendências de todas as empresasNúmero de registros por páginaNãoNão se aplicalog



aprova-sem-motivNãoAção do swipe (Esquerdo) Aprovar Rejeitar Nenhum)

Visualização inicial

(1 - Todas as pendências / 2 - Pendências principais / 3 - Pendências alternativas / 4 - Pendências como mestrettconfigvisual-updSimordenacaoOrdenação padrão: Mais recentes Mais antigas Maior valor Menor valor / 5 - Tipo de documento / 6 - Empresa / 7 - EstabelecimentoNão

tt-config-

visual-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

approveWithoutReasonLOGICALIndica aprovação sem informar motivoNãoNão se aplicacdn-tempo-desfundoTimeINTEGERTempo de desfazer

Não se aplica

idi-acao-swip-direrightSwipeActionINTEGERinterfacidi-interfacINTEGERInterfaceSim

Ação do swipe (Direito)

(1 - Aprovar / 2 - Rejeitar / 3 - Nenhum)
Não se aplica

idi-ordenacao

ordinationacao-swip-esqleftSwipeActionINTEGER

Ordenação padrão:

(1 -

Mais recentes / 2 -

Mais antigas / 3 -

NãoNão se aplicaidi-visualiz-inicialinitialViewINTEGER

Maior valor / 4 - Menor valor / 5 - Tipo de documento / 6 - Empresa / 7 - Estabelecimento)

Não

Não se aplica

numlog-mostra-registrotodas-paginacempresaspageRecordsNumberallCompaniesINTEGERLOGICALIndica apresentação de pendências de todas as empresasNúmero de registros por páginaNãoNão se aplica
log-aprova-

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

sem-motivapproveWithoutReasonLOGICALIndica aprovação sem informar motivoNãoNão se aplica
cdn-tempo-desfundoTimeINTEGERTempo de desfazerNãoNão se aplica
idi-acao-swip-direrightSwipeActionINTEGER

Ação do swipe (Direito)

(1 - Aprovar / 2 - Rejeitar / 3 - Nenhum)

cod-usuar

userCode

CHARACTER 

Código do aprovador


Não se aplica
idi-interfacidi-interfacINTEGERInterfaceacao-swip-esqleftSwipeActionINTEGER

Ação do swipe (Esquerdo)

(1 - Aprovar / 2 - Rejeitar / 3 - Nenhum)

NãoSimNão se aplica
idi-visualiz-inicialordinationinitialViewINTEGER

Visualização inicial

(1 -

Todas as pendências / 2 -

Pendências principais / 3 -

Pendências alternativas / 4 -

Pendências como mestre)

NãoNão se aplica
lognum-mostraregistro-todas-empresaspaginacallCompaniespageRecordsNumberLOGICALINTEGERIndica apresentação de pendências de todas as empresasNãoNão se aplicalog-aprova-sem-motivapproveWithoutReasonLOGICALIndica aprovação sem informar motivoNúmero de registros por páginaNãoNã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

cdn
idi-
tempo-desf
interfac
undoTime
interfaceINTEGER
Tempo de desfazer
Interface (1 - Lista / 2 - Detalhe)Sim
Não
Não se aplica
idi
cod-
acao
tip-
swip-dire
doc
rightSwipeAction
documentCodeINTEGER

Ação do swipe (Direito)

Código do documentoSim
(1 - Aprovar / 2 - Rejeitar / 3 - Nenhum)
Não se aplica
desc-tip-docdocumentDescriptionCHARACTER Descrição do documento
idi-acao-swip-esqleftSwipeActionINTEGER

Ação do swipe (Esquerdo)

(1 - Aprovar / 2 - Rejeitar / 3 - Nenhum)
NãoNão se aplica
idi
layout-
visualiz-inicial
padrao
initialView
defaultLayout
INTEGER
LOGICAL

Visualização inicial

(1 - Todas as pendências / 2 - Pendências principais / 3 - Pendências alternativas / 4 - Pendências como mestre)

Layout padrãoNãoNão se aplica
num-registro-paginacpageRecordsNumberINTEGERNúmero de registros por página
siglashortNameCHARACTERSigla do documentoNãoNã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

userNameCHARACTER 

Nome do aprovador

Não

Não se aplica

idi-interfacinterfaceINTEGERInterface (1 - Lista / 2 - Detalhe)SimNão se aplica
cod-tip-docdocumentCodeINTEGERCódigo do documentoSimNão se aplica
desc-tip-docdocumentDescriptionCHARACTER Descrição do documentoNãoNão se aplica
expandables_expandablesCHARACTER (Extent 1)Lista de entidades filhas expansíveisNãoNão se aplica

...