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-get-users-with-layoutSetting-v1

Requisito

Nenhum.

Descrição

Retorna a lista de usuários que possuem 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

{
  "payloadpathParams": {[
    "userCode":"super"USERSWITHLAYOUT ",
    "interface1":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-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 alteração das configurações visuisvisuais:

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 alteraação alteração das configurações visuisvisuais:

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 no 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 no objeto"). Para ordenação decrescente utilizar o sinal "-" antes do campo;
<Nome do no 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 no objeto");
order: Ordenação (verificar campos possíveis na temp-table tt-document no final desta documentação (utilizar o "Nome do no objeto"). Para ordenação decrescente utilizar o sinal "-" antes do campo;
<Nome do no 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-batch-layoutSetting-v1

Requisito

Nenhum.

Descrição

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

Obs: Pode ser usado para criar o layout da Listagem e Detalhe junto para o mesmo documento.

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para criaçã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 criação dos layouts de documentos/usuários.

Retorno

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

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 21

Nova versão Atual

Chave