Histórico da Página

...

Esta API tem como objetivo realizar a apresentações apresentação de dados e realizar configurações visuais para o aplicativo do MLA.

...

pi-update-layoutSetting-v1

Requisito

Nenhum.

Descrição

Alteração de layout de documento do usuário

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para alteração do layout do usuário para documento:

pathParams: Informar na seguinte ordem: o código do aprovador, interface e código do documento

payload: Informações do layout a ser alterado:

userCode: Código do aprovador
interface: Interface (1 - Lista / 2 - Detalhe)
documentCode: Código do documento
fields: Componentes do layout:
- id: Id do componente;
- componentType: Tipo de componente (1 - Campo / 2 - Lista / 3 - Separador);
- label: Rótulo do campo;
- description: Descrição do campo;
- visible: Visibilidade do campo;
- size: Tamanho do componente;
- fields: Campos do componente em questão
  - Mesma estrutura de campos acima

Bloco de código

title	Exemplo

{
   "pathParams": [
    "super",
    "1",
    "5"
   ],
   "payload": {
      "userCode": "super",
      "interface": 1,
      "documentCode": 5,
      "fields": [
        {
           "id": "pend-chave-doc",
           "componentType": 1,
           "label": "Chave",
           "description": "Chave do Documento da Pendência de Aprovação",
           "visible": true,
           "size": 50
         },
         {
           "id": "pend-valor-doc",
           "componentType": 1,
           "label": "Valor",
           "description": "Valor da Pendência de Aprovação",
           "visible": true,
           "size": 50
         }
       ]
   }
}

oOutput

JsonObject

OUTPUT

Resultado da criação do registro:

userCode: Código do aprovador
userName: Nome do aprovador
interface: Interface (1 - Lista / 2 - Detalhe)
documentCode: Código do documento
documentDescription: Descrição do documento
fields: Componentes do layout:
- id: Id do componente;
- componentType: Tipo de componente (1 - Campo / 2 - Lista / 3 - Separador);
- label: Rótulo do campo;
- description: Descrição do campo;
- visible: Visibilidade do campo;
- size: Tamanho do componente;
- fields: Campos do componente em questão
  - Mesma estrutura de campos acima

Bloco de código

title	Exemplo

{
  "userCode": "super",
  "userName": "Super Usuário",
  "interface": 1,
  "documentCode": 5,
  "documentDescription": "Cotação de Materiais",
  "_expandables": [
    "fields"
  ],
  "fields": [
    {
      "id": "pend-chave-doc",
      "componentType": 1,
      "label": "Chave",
      "description": "Chave do Documento da Pendência de Aprovação",
      "visible": true,
      "size": 50
    },
    {
      "id": "pend-valor-doc",
      "componentType": 1,
      "label": "Valor",
      "description": "Valor da Pendência de Aprovação",
      "visible": true,
      "size": 50
    }
  ]
}

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante a alteração do layout de documento do usuário.

Retorno

Informações do registro salvo ou erros ocorridos no processo.

pi-update-batch-layoutSetting-v1

Requisito

Nenhum.

Descrição

Alteração de layout de documento do usuário em lote.

Obs: Pode ser usado para alteração do layout da Listagem e Detalhe junto para o mesmo documento.

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para alteração do layout do usuário para documento:

pathParams: Informar BATCH.

payload: Informações do layout a ser criado:

layouts: Layouts de documentos/usuários:
- userCode: Código do aprovador
- interface: Interface (1 - Lista / 2 - Detalhe)
- documentCode: Código do documento
- fields: Componentes do layout:
  - id: Id do componente;
  - componentType: Tipo de componente (1 - Campo / 2 - Lista / 3 - Separador);
  - label: Rótulo do campo;
  - description: Descrição do campo;
  - visible: Visibilidade do campo;
  - size: Tamanho do componente;
  - fields: Campos do componente em questão
    - Mesma estrutura de campos acima

Bloco de código

title	Exemplo

{
   "pathParams": [
      "BATCH"
   ],
   "payload": {
      "layouts": [
      {
        "userCode": "super",
        "interface": 1,
        "documentCode": 5,
        "fields": [
          {
            "id": "pend-chave-doc",
            "componentType": 1,
            "label": "Chave",
            "description": "Chave do Documento da Pendência de Aprovação",
            "visible": true,
            "size": 100
          },
          {
            "id": "pend-valor-doc",
            "componentType": 1,
            "label": "Valor",
            "description": "Valor da Pendência de Aprovação",
            "visible": true,
            "size": 100
          }
        ]
      },
      {
        "userCode": "super",
        "interface": 2,
        "documentCode": 5,
        "fields": [
          {
            "id": "pend-chave-doc",
            "componentType": 1,
            "label": "Chave",
            "description": "Chave do Documento da Pendência de Aprovação",
            "visible": true,
            "size": 100
          },
          {
            "id": "pend-cod-usuar-doc",
            "componentType": 1,
            "label": "Usuário",
            "description": "Código do Usuário da Pendência de Aprovação",
            "visible": true,
            "size": 50
          },
          {
            "id": "pend-valor-doc",
            "componentType": 1,
            "label": "Valor",
            "description": "Valor da Pendência de Aprovação",
            "visible": true,
            "size": 50
          }
        ]
      }
    ]
   }
}

oOutput

JsonObject

OUTPUT

Resultado da criação do registro:

layouts: Layouts de documentos/usuários:
- userCode: Código do aprovador
- userName: Nome do aprovador
- interface: Interface (1 - Lista / 2 - Detalhe)
- documentCode: Código do documento
- documentDescription: Descrição do documento
- fields: Componentes do layout:
  - id: Id do componente;
  - componentType: Tipo de componente (1 - Campo / 2 - Lista / 3 - Separador);
  - label: Rótulo do campo;
  - description: Descrição do campo;
  - visible: Visibilidade do campo;
  - size: Tamanho do componente;
  - fields: Campos do componente em questão
    - Mesma estrutura de campos acima

Bloco de código

title	Exemplo

{
  "layouts": [
    {
      "userCode": "super",
      "userName": "Super Usuário",
      "interface": 1,
      "documentCode": 5,
      "documentDescription": "Cotação de Materiais",
      "_expandables": [
        "fields"
      ],
      "fields": [
        {
          "id": "pend-chave-doc",
          "componentType": 1,
          "label": "Chave",
          "description": "Chave do Documento da Pendência de Aprovação",
          "visible": true,
          "size": 100
        },
        {
          "id": "pend-valor-doc",
          "componentType": 1,
          "label": "Valor",
          "description": "Valor da Pendência de Aprovação",
          "visible": true,
          "size": 100
        }
      ]
    },
    {
      "userCode": "super",
      "userName": "Super Usuário",
      "interface": 2,
      "documentCode": 5,
      "documentDescription": "Cotação de Materiais",
      "_expandables": [
        "fields"
      ],
      "fields": [
        {
          "id": "pend-chave-doc",
          "componentType": 1,
          "label": "Chave",
          "description": "Chave do Documento da Pendência de Aprovação",
          "visible": true,
          "size": 100
        },
        {
          "id": "pend-cod-usuar-doc",
          "componentType": 1,
          "label": "Usuário",
          "description": "Código do Usuário da Pendência de Aprovação",
          "visible": true,
          "size": 50
        },
        {
          "id": "pend-valor-doc",
          "componentType": 1,
          "label": "Valor",
          "description": "Valor da Pendência de Aprovação",
          "visible": true,
          "size": 50
        }
      ]
    }
  ]
}

RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante a alteração dos layouts de documentos/usuários.

Retorno

Informações do registro salvo ou erros ocorridos no processo.

Definição de temp-tables:

...

Árvore de páginas

Versões comparadas

Versão antiga 22

Nova versão 23

Chave