Histórico da Página

...

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:

tt-config-visual-upd

Bloco de código

title	Exemplo

{
  "payload": {
    "userCode":"super",
    "interface":1,
    "ordination": 3,
    "allCompanies": true,
    "approveWithoutReason": true,
    "initialView": 3
  }
}

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:

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.

...

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 visuis:

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:

tt-config-visual-upd

Bloco de código

title	Exemplo

{
  "pathParams": [
    "super",
    "1"
  ],
  "payload": {
    "ordination": 3,
    "allCompanies": true,
    "approveWithoutReason": true,
    "initialView": 3
  }
}

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:

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 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 a busca dos usuáriosalteraação das configurações visuis:

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:

tt-config-visual-upd

Bloco de código

title	Exemplo

{
  "pathParams": [
    "super",
    "1"
  ],
  "payload": {
    "ordination": 3,
    "allCompanies": true,
    "approveWithoutReason": true,
    "initialView": 3
  }
}

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:

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

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

title	Exemplo

{
  "queryParams": {
    "userCodeIni": [
      "ana"
    ],
    "userCodeEnd": [
      "super"
    ],
    "order": [
      "-userCode"
    ],
    "pageSize": [
      "10"
    ]
  },
}

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:

tt-aprovador

Bloco de código

title	Exemplo

[
  {
    "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"
  }
]

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:

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

title	Exemplo

{
  "queryParams": {
    "userCode": [
      "super"
    ],
    "interface": [
      "1"
    ],
    "order": [
      "shortName"
    ]
  }
}

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:

tt-aprovador

Bloco de código

title	Exemplo

[
  {
    "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"
  }
]

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.

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

{
  "payload": {
    "userCode":"super",
    "interface":1,
    "ordination": 3,
    "allCompanies": true,
    "approveWithoutReason": true,
    "initialView": 3
  }
}

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:

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:

...

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

Nova versão 17

Chave