Histórico da Página

...

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.

pi-delete-layoutSetting
Requisito	Nenhum.
Descrição	Elimina o 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 eliminar o layout
	piInterface	INTEGER	INPUT	Código da interface (1 - Lista / 2 - Detalhe)
	piDocumentType	INTEGER	INPUT	Código do documento
	oError	Progress.Lang.AppError	OUTPUT	Informações sobre os erros ocorridos durante o processo de eliminação de layout
	RowErrors	Temp-table	OUTPUT	Informações sobre os erros ocorridos durante o processo de eliminação de layout
Retorno	Erros ocorridos no processo de eliminação.

pi-delete-layoutSetting-v1

Requisito

Nenhum.

Descrição

Elimina o layout de documento de um 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.

Bloco de código

title	Exemplo

{
  "pathParams": [
    "super",
    "1",
    "2"
  ],
}

oOutput

JsonObject

OUTPUT

Informações dos usuários:

Bloco de código

title	Exemplo

{
  "status": 200,
  "payload": {
  }
}

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante o processo de eliminação de layout

Retorno

Erros ocorridos no processo de eliminação.

Definição de temp-tables:

...

Árvore de páginas

Versões comparadas

Versão antiga 8

Nova versão 9

Chave