Histórico da Página

...

pi-get-users-with-layoutSetting-v1

Requisito

Nenhum.

Descrição

Retorna a lista de usuários que 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.

Bloco de código

title	Exemplo

{
  "pathParamspayload": [{
    "USERSWITHLAYOUTuserCode":"super",
    "interface":1,
    ""
  ],}
}

oOutput

JsonObject

OUTPUT

Informações dos usuários:

Bloco de código

title	Exemplo

{
  "status": 200,
  "payload": {
    "layoutUsers": [
        {
            "userCode": "super",
            "userName": "Super Usuário"
        },
        {
            "userCode": "super2",
            "userName": "Super Usuário 2"
        }
     ]
   }     
}

Sobre os campos retornados:

userCode: Código do usuário
userName: Nome do usuário

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

userCode: Código do usuário
interface: Interface
documentCode: Documento

Bloco de código

title	Exemplo

{
  "pathParams": [
    "BATCH"
  ],
  "payload": {
    "layouts": [
      {
          "userCode":"super",
          "interface":1,
          "documentCode":2
      },
      {
          "userCode":"super",
          "interface":2,
          "documentCode":2
      },
      {
          "userCode":"super",
          "interface":1,
          "documentCode":3
      },
      {
          "userCode":"super",
          "interface":2,
          "documentCode":3
      }
    ]
   }
}

oOutput

JsonObject

OUTPUT

Informações do processamento (para cada layout):

Bloco de código

title	Exemplo

{
  "batchReturn": [
    {
      "status": 200,
      "payload": {
      }
    },
    {
      "status": 200,
      "payload": {
      }
    },
    {
      "status": 200,
      "payload": {
      }
    },
    {
      "status": 200,
      "payload": {
      }
    }
  ]
}

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.

Bloco de códigotitle

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ários:

pathParams: Informar na seguinte ordem: o código do aprovador, interface e número de documento.

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:

tt-config-visual-upd

Bloco de código

title

Exemplo

{
  "

pathParams

payload":

[

{
    "userCode":"super",
    "interface":1

"

,
    "

2

ordination": 3,

], }oOutputJsonObjectOUTPUT

Informações do processamento:

Bloco de código

title	Exemplo

{

"allCompanies": true,
    "

status

approveWithoutReason":

200

true,
    "

payload

initialView":

{

3
  }
}

RowErrors

oOutput

Temp-table

JsonObject

OUTPUT

Informações sobre os erros ocorridos durante o processo de criação das configurações visuais do usuário.

Retorno

Erros ocorridos no processo de criação das configurações visuais do usuário.

Definição de temp-tables:

Resultado da criação do registro:

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

tt-config-visual-upd

Bloco de código

title	Exemplo

{
  "userCode": "super",
  "interface": 1,
  "ordination": 3,
  "allCompanies": true,
  "approveWithoutReason": true,
  "undoTime": 5,
  "rightSwipeAction": 1,
  "leftSwipeAction": 2,
  "initialView": 3,
  "pageRecordsNumber": 50
}

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.

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

erros ocorridos durante o processo

aprovadores					Saída
Atributo	Nome no objeto	Tipo	Descrição	Obrigatório	Evolução

ErrorSequence

INTEGER

Número da sequência do erroSim


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
e-mail	eMail	CHARACTER	E-mail do aprovador	Não	Não se aplica
envia-email

ErrorNumber

sendEmail

INTEGER Código do erro

LOGICAL

Indica se envia e-mail

Não

Sim

	Não se aplica
recebe-email

ErrorDescription

receiveEmail

CHARACTER Descrição do erro

LOGICAL

Indica se recebe e-mail

Não

Sim

	Não se aplica
usuar-mestre

ErrorParameters

masterUser

CHARACTER Parâmentros da mensagem de erro

LOGICAL

Indica se o usuário é mestre

Não

Sim

Não se aplica

ErrorTypeCHARACTER Tipo do erro

mo-codigo

currency

INTEGER

Moeda do aprovador

Não

Sim

	Não se aplica
sigla-moeda

ErrorHelp

currencyAbbrev

CHARACTER

Texto de ajuda da mensagem de erro

Sigla da moeda do usuário

Não

Sim

	Não se aplica
aprova-auto

ErrorSubType

automacticApproval

CHARACTERSubtipo do erro

LOGICAL

Indica se o aprovador aprova automaticamente

Não

SimCódigo nomeusuarNome Moeda

	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
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	cod-usuar	userCode	CHARACTER	do aprovador	Não	Não se aplica
cod-	lotacao	userNameallocationCode	CHARACTER	Lotação do aprovador	Não	Não se aplica
elibera-mailverba	eMailreleaseAmount	CHARACTER	LOGICAL	Indica se o aprovador libera verbaE-mail do aprovador	Não	Não se aplica
envialog-usuar-emailconfig	sendEmailconfiguratorUser	LOGICALIndica se envia e-mail	Indice se o aprovador é configurador visual	Não	Não se aplica
empresa	companyCode	CHARACTER	Empresa do aprovador	Não	Não se aplica
recebe-emailidioma	receiveEmaillanguage	LOGICAL	CHARACTER	Idioma do aprovadorIndica 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

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

sigla

idi-

moeda

ordenacao

ordination

currencyAbbrev

INTEGER

CHARACTER Sigla da moeda do usuário

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

aprova-autoautomacticApproval

log-mostra-todas-empresas

allCompanies

LOGICAL

Indica

se o aprovador aprova automaticamente

apresentação de pendências de todas as empresas	Não	Não se aplica
log-aprova-

auto

sem-

aprov

motiv

automacticApprovalApprover

approveWithoutReason

LOGICAL

Indica

se o aprovador aprova automaticamente pendências do aprovador

aprovação sem informar motivo

Não

Não se aplica

cod

cdn-tempo-

estabel

desf

siteCode

undoTime

CHARACTER

INTEGER

Tempo de desfazer

Estabelecimento do aprovador

Não

Não se aplica

cod-lotacaoallocationCodeCHARACTER Lotação do aprovador

idi-acao-swip-dire

rightSwipeAction

INTEGER

Ação do swipe (Direito)

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

Não

Não se aplica

libera-verbareleaseAmountLOGICAL

idi-acao-swip-esq

leftSwipeAction

INTEGER

Ação do swipe (Esquerdo)

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

Indica se o aprovador libera verba

Não

Não se aplica

log

idi-

usuar

visualiz-

configconfiguratorUserLOGICALIndice se o aprovador é configurador visualNãoNão se aplica

inicial

initialView

INTEGER

Visualização inicial

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

empresacompanyCodeCHARACTER Empresa do aprovador

Não

Não se aplica

idiomalanguageCHARACTER Idioma do aprovador

num-registro-paginac

pageRecordsNumber

INTEGER

Número de registros por página

Não

Não se aplica

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	Não se aplica
idi-interfac	idi-interfac	INTEGER	Interface	Sim	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

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

...

Árvore de páginas

Versões comparadas

Versão antiga 11

Nova versão 12

Chave