Histórico da Página

...

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.

Bloco de código

title	Exemplo

{
    "queryParams": {
        "fields" [
            "userCode",
            "userName"
        ],
        "expand": [
            "visualConfigurations"
        ],
    },
    "pathParams": [
        "super"
    ]
}

oOutput

JsonObject

OUTPUT

Informações do aprovador.

Bloco de código

title	Exemplo

{
  "status": 200,
  "payload": {
    "total": 1,
    "hasNext": false,
    "items": [
      {
        "userCode": "super",
        "userName": "Super Usuário",
        "eMail": "",
        "sendEmail": true,
        "receiveEmail": true,
        "masterUser": false,
        "currency": 0,
        "currencyAbbrev": "R$",
        "automaticApproval": true,
        "automaticApprovalApprover": true,
        "siteCode": "1",
        "allocationCode": "10702",
        "releaseAmount": false,
        "configuratorUser": true,
        "companyCode": "10",
        "language": "pt",
        "_expandables": [
          "visualConfigurations"
        ],
        "visualConfigurations": [
          {
            "ordination": 3,
            "allCompanies": false,
            "approveWithoutReason": true,
            "undoTime": 5,
            "rightSwipeAction": 1,
            "leftSwipeAction": 1,
            "initialView": 1,
            "pageRecordsNumber": 50
          }
        ]
      }
    ]
  }
}

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.

pi-get-layoutSetting-data
Requisito	Nenhum.
Descrição	Retorna layout de documento de um usuário
	Parâmetros	Tipo	Input/Output	Descrição
	pcUser	CHARACTER	INPUT	Código do usuário que se deseja buscar o layout
	piInterface	INTEGER	INPUT	Código da interface (1 - Lista / 2 - Detalhe)
	piDocumentType	INTEGER	INPUT	Código do documento
	plOnlyVisible	LOGICAL	INPUT	Indica que deve retornar apenas campos visíveis
	pcFields	LONGCHAR	INPUT	Lista de campos a serem considerados na busca, separados por vírgula (verificar na temp-table tt-document-com-expand para saber os nomes a utilizar).
	pcExpand	LONGCHAR	INPUT	Lista de entidades filhas expansíveis. Para mostrar os campos do layout utilizar "fields"
	tt-document-com-expand	TEMP-TABLE	OUTPUT	Informações do documento
	tt-layout	TEMP-TABLE	OUTPUT	Lista de campos do layout do documento
	RowErrors	Temp-table	OUTPUT	Informações sobre os erros ocorridos durante o processo de busca de layout
Retorno	Layout do documento para o usuário e interface solicitados.

pi-get-layoutSetting-v1

Requisito

Nenhum.

Descrição

Retorna layout de documento de um usuário

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para a busca do layout:

queryParams → expand: Utilizando este parâmetro com a informação "fields", são retornadas também os campos do layout.

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

Bloco de código

title	Exemplo

{
    "queryParams": {
        "expand": [
          "fields"
        ]
     },
  "pathParams": [
    "super",
    "1",
    "2"
  ],
}

oOutput

JsonObject

OUTPUT

Informações do layout:

Bloco de código

title	Exemplo

{
  "status": 200,
  "payload": {
    "userCode": "super",
    "userName": "Super Usuário",
    "interface": 1,
    "documentCode": 2,
    "documentDescription": "Solicitação de Compra - Total",
    "_expandables": [
      "fields"
    ],
    "fields": [
      {
        "id": "doc-nr-requisicao",
        "componentType": 1,
        "label": "",
        "description": "Número da Solicitação de Compra",
        "visible": true,
        "size": 100
      },
      {
        "id": "pend-valor-doc",
        "componentType": 1,
        "label": "",
        "description": "Valor da Pendência de Aprovação",
        "visible": true,
        "size": 100
      }
   }     
}

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

tt-document-com-expand: que contém as informações do documento.

tt-layout (fields): contém as informações de campos do layout.

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante o processo de busca de layout dos aprovadores

Retorno

Layout do documento para o usuário e interface solicitados.

...

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

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

tt-layout					Entrada/Saída
Temp-table com campos de layout					Saída
Atributo	Nome no objeto	Tipo	Descrição	Obrigatório	Evolução
cdn-docto		INTEGER	Código do documento	Sim	Não se aplica
cod-usuar		CHARACTER	Código do aprovador	Sim	Não se aplica
idi-interfac		INTEGER	Interface (1 - Lista / 2 - Detalhe)	Sim	Não se aplica
cod-id-campo	id	CHARACTER	Identificador do campo	Sim	Não se aplica
idi-compon	componentType	INTEGER	Tipo de componente (1 - Campo / 2 - Lista / 3 - Separador)	Sim	Não se aplica
nom-rotu-campo	label	CHARACTER	Rótulo do campo	Não	Não se aplica
des-campo	description	CHARACTER	Descrição do campo	Sim	Não se aplica
log-visivel	visible	LOGICAL	Visibilidade do campo	Sim	Não se aplica
cdn-tamanho	size	INTEGER	Tamanho do campo	Sim	Não se aplica
cdn-ord		INTEGER	Ordem do campo	Sim	Não se aplica
cod-entid-pai		CHARACTER	Identificação da entidade pai	Não	Não se aplica
Índice: visivel-ordem, log-visivel, cdn-ord

Árvore de páginas

Versões comparadas

Versão antiga 6

Nova versão 7

Chave