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

Retorno

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

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

{
  "pathParams": [
    "USERSWITHLAYOUT",
    "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.

Definição de temp-tables:

...

Árvore de páginas

Versões comparadas

Versão antiga 7

Nova versão 8

Chave