Histórico da Página

...

Quando a API estiver executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

pi-get-approverUser-v1

Requisito

Nenhum.

Descrição

Retorna informações de um aprovador do MLA.

Parâmetros

Tipo

Input/Output

Descrição

oInput

pi-get-defaults-v1

pi-get-document-abrev

pi-validate-user-info-v1

pi-query-app-list-v1

pi-query-pending-approval

pi-query-rejection-options-v1

pi-get-detail-pending-v1

pi-get-detail-historic-pending-v1

pi-approve-v1

pi-reprove-v1

pi-reapprove-v1

pi-process-pending-v1

Requisito	Nenhum.
Descrição	Retorna dados principais para carregamento inicial do APP: empresas, estabelecimentos e documentos do aprovador com seus layouts.
	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

pathParams: Informar na seguinte ordem: getDefaults e código do aprovador.

queryParams → expand: Utilizando este parâmetro com

a informação "visualConfigurations", são retornadas também as configurações visuais do usuário.

as opções abaixo permite retornar também as informações de:

visualConfigurations: Configurações Visuais
groupCompanies: Grupo de empresas
documents: Documentos
documents.fields: Componentes de cada docmento
establishments: Estabelecimentos

pathParams: Informar o código do aprovador que se deseja buscar as informações.

Bloco de código

title	Exemplo

{
    "queryParams": {

fields

expand": [

"userCode",

"visualConfigurations,groupsCompanies,documents,documents.fields,establishments"
    ]

},
    "

userName

pathParams": [

]

"getDefaults",

expand

super"

: [

"visualConfigurations" ], }, "pathParams": [ "super" ] }

],
}

oOutput

JsonObject

OUTPUT

Informações

do aprovador.

iniciais para o APP:

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",

]

"groupsCompanies",
          "

visualConfigurations

documents"

: [

{

"documents.fields",
          "

ordination

establishments"

:

3,

],

"

   "visualConfigurations": [
          {
            "ordination": 3,
            "allCompanies": false,
            "approveWithoutReason": true,
            "undoTime": 5,
            "rightSwipeAction": 1,
            "leftSwipeAction": 1,
            "initialView": 1,
            "pageRecordsNumber": 50
          }
        ],

}

  "groupsCompanies": [

]

} }

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.

RowErrorsTemp-tableOUTPUTInformaçõ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

pcUserCHARACTERINPUTCódigo do usuário que se deseja buscar o layoutpiInterfaceINTEGERINPUTCódigo da interface (1 - Lista / 2 - Detalhe)piDocumentTypeINTEGERINPUTCódigo do documentoplOnlyVisibleLOGICALINPUTIndica que deve retornar apenas campos visíveispcFieldsLONGCHARINPUTLista 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).pcExpandLONGCHARINPUTLista de entidades filhas expansíveis. Para mostrar os campos do layout utilizar "fields"tt-document-com-expandTEMP-TABLEOUTPUTInformações do documento tt-layoutTEMP-TABLEOUTPUTLista de campos do layout do documentoRowErrorsTemp-tableOUTPUTInformaçõ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

oInputJsonObjectINPUT

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"
  ],
}

oOutputJsonObjectOUTPUT

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.

RowErrorsTemp-tableOUTPUTInformaçõ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

oInputJsonObjectINPUT

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

{
  "payload": {
    "userCode":"super",
    "interface":1,
    ""
  }
}

oOutputJsonObjectOUTPUT

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

RowErrorsTemp-tableOUTPUTInformaçõ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

pcUserCHARACTERINPUTCódigo do usuário que se deseja eliminar o layoutpiInterfaceINTEGERINPUTCódigo da interface (1 - Lista / 2 - Detalhe)piDocumentTypeINTEGERINPUTCódigo do documentooErrorProgress.Lang.AppErrorOUTPUTInformações sobre os erros ocorridos durante o processo de eliminação de layoutRowErrorsTemp-tableOUTPUTInformaçõ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

oInputJsonObjectINPUT

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"
  ],
}

oOutputJsonObjectOUTPUT

Informações do processamento:

Bloco de código

title	Exemplo

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

RowErrorsTemp-tableOUTPUTInformações sobre os erros ocorridos durante o processo de eliminação de layout

Retorno

Erros ocorridos no processo de eliminação.

pi-delete-every-layoutSetting-v1

Requisito

Nenhum.

Descrição

Elimina todos os layout de documento de um usuário

Parâmetros

Tipo

Input/Output

Descrição

cUsuarioCHARACTERINPUTCódigo do usuárioRowErrorsTemp-tableOUTPUTInformações sobre os erros ocorridos durante o processo de eliminação de layouts

Retorno

Erros ocorridos no processo de eliminação.

pi-delete-batch-layoutSetting-v1

Requisito

Nenhum.

Descrição

Eliminação de layouts de documento de usuário em lote

Parâmetros

Tipo

Input/Output

Descrição

oInputJsonObjectINPUT

Parâmetros para a busca dos usuários:

pathParams: Informar: BATCH

payload: Informar o objeto com layouts a serem eliminados

userCode: Código do usuário
interface: Interface
documentCode: Documento

Bloco de código

title	Exemplo

{
  "pathParams": [
    "BATCH"
  ],
  "payload": {
    "layouts": [
      {
          "userCode":"super",
          "interface":1,
          "documentCode":2
      },
      {
          "userCode":"super",
          "interface":2,
          "documentCode":2
      },
      {
          "userCode":"super",
          "interface":1,
          "documentCode":3
      },
      {
          "userCode":"super",
          "interface":2,
          "documentCode":3
      }
    ]
   }
}

oOutputJsonObjectOUTPUTInformações do processamento (para cada layout):

Bloco de código

title	Exemplo

{
  "batchReturn": [
    {
      "status": 200,
      "payload": {
      }
    },
    {
      "status": 200,
      "payload": {
      }
    },
    {
      "status": 200,
      "payload": {
      }
    },
    {
      "status": 200,
      "payload": {
      }
    }
  ]
}

RowErrorsTemp-tableOUTPUTInformações sobre os erros ocorridos durante o processo de eliminação de layouts

Retorno

Erros ocorridos no processo de eliminação.

Parâmetros para criação das configurações visuis:

payload: Informações das configurações visuais a serem criadas.

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

tt-config-visual-upd

pi-create-visualConfiguration-v1
Requisito	Nenhum.
Descrição	Cria as configurações visuais do usuário
	Parâmetros	Tipo	Input/Output	Descrição
	oInput	JsonObject	INPUT

Bloco de código

title	Exemplo

{
  "payload": {
    "userCode":"super",
    "interface":1,
    "ordination": 3,
    "allCompanies": true,
    "approveWithoutReason": true,
    "initialView": 3
  }
}

oOutputJsonObjectOUTPUT

Resultado da criaçã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
}

RowErrorsTemp-tableOUTPUTInformações sobre os erros ocorridos durante a criação das configurações visuais.

Retorno

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

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

oInputJsonObjectINPUT

Parâmetros para alteração das configurações visuis:

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
  }
}

oOutputJsonObjectOUTPUT

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
}

RowErrorsTemp-tableOUTPUTInformaçõ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

oInputJsonObjectINPUT

Parâmetros para alteraação das configurações visuis:

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
  }
}

oOutputJsonObjectOUTPUT

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
}

RowErrorsTemp-tableOUTPUTInformaçõ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

oInputJsonObjectINPUT

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 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 objeto"). Para ordenação decrescente utilizar o sinal "-" antes do campo;
<Nome do 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"
    ]
  },
}

aOutputJsonArrayOUTPUT

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"
  }
]

lHasNextLOGICALOUTPUTIndica existência de mais registros para buscaRowErrorsTemp-tableOUTPUTInformaçõ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

oInputJsonObjectINPUT

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

aOutputJsonArrayOUTPUT

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"
  }
]

lHasNextLOGICALOUTPUTIndica existência de mais registros para buscaRowErrorsTemp-tableOUTPUTInformações sobre os erros ocorridos durante a busca de documentos.

Retorno

Informações de documentos ou erros ocorridos no processo de busca.

pi-create-layoutSetting-v1

Requisito

Nenhum.

Descrição

Cria layout de documento do usuário

Parâmetros

Tipo

Input/Output

Descrição

oInputJsonObjectINPUT

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

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

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

{
   "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": 100
         },
         {
           "id": "pend-valor-doc",
           "componentType": 1,
           "label": "Valor",
           "description": "Valor da Pendência de Aprovação",
           "visible": true,
           "size": 100
         }
       ]
   }
}

oOutputJsonObjectOUTPUT

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": 100
    },
    {
      "id": "pend-valor-doc",
      "componentType": 1,
      "label": "Valor",
      "description": "Valor da Pendência de Aprovação",
      "visible": true,
      "size": 100
    }
  ]
}

RowErrorsTemp-tableOUTPUTInformações sobre os erros ocorridos durante a criação do layout de documento do usuário.

Retorno

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

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

oInputJsonObjectINPUT

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
          }
        ]
      }
    ]
   }
}

oOutputJsonObjectOUTPUT

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
        }
      ]
    }
  ]
}

RowErrorsTemp-tableOUTPUTInformaçõ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

oInputJsonObjectINPUT

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
         }
       ]
   }
}

oOutputJsonObjectOUTPUT

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
    }
  ]
}

RowErrorsTemp-tableOUTPUTInformaçõ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

oInputJsonObjectINPUT

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          "sequence": 1,
            "name": "Grupo de Empresas 1",
        "interface": 2,
        "documentCodecompanies": 5,[
        "fields": [
      {
    {
            "idcode": "pend-chave-doc002",
            "componentType": 1,
            "labelname": "Chave",TOTVS SA - E-kanban"
            "description": "Chave do},
 Documento da Pendência de Aprovação",
         {
   "visible": true,
            "sizecode": 100"10",
          },
      "name": "10 TOTVS S.A"
 {
            "id": "pend-cod-usuar-doc" },
             "componentType": 1, {
                "labelcode": "Usuário11",
                "descriptionname": "TOTVS"Código
   do Usuário da Pendência de Aprovação",
      }
      "visible": true,
    }
        "size": 50 ],
          },"documents": [
          {
            "iddocumentCode": "pend-valor-doc"1,
            "componentTypedocumentDescription": 1 "Solicitação de Compra - Item",
            "labeldefaultLayout": "Valor"false,
            "descriptionshortName": "Valor da Pendência de AprovaçãoSC",
            "visiblefields": true,[
            "size": 50
  {
                  }"id": "doc-nr-requisicao",
        ]
      }
    ]
   }
}

oOutputJsonObjectOUTPUT

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": [
    {
  "componentType": 1,
                "label": "",
                "description": "Número da Solicitação de Compra",
                "visible": true,
                "size": 100
              },
              {
                "userCodeid": "superpend-valor-doc",
        "userName": "Super Usuário",
      "interfacecomponentType": 1,
                "documentCodelabel": 5"",
      "documentDescription": "Cotação de Materiais",
          "_expandablesdescription": [
"Valor da Pendência de Aprovação",
    "fields"
      ],
      "fieldsvisible": [true,
        {
          "idsize": "pend-chave-doc",
100
             "componentType": 1,
 }
           "label": "Chave", ]
          "description": "Chave do Documento da Pendência de Aprovação",
},
          {
            "visibledocumentCode": true5,
            "sizedocumentDescription": 100 "Cotação de Materiais",
        },
    "defaultLayout": false,
   {
          "idshortName": "pend-valor-docCO",
            "componentTypefields": 1,
[
              {
     "label": "Valor",
          "descriptionid": "Valor da Pendência de Aprovação",
pend-chave-doc",
                "visiblecomponentType": true1,
          "size": 100
        }"label": "Chave",
      ]
    },
    {
      "userCodedescription": "super",
Chave do Documento da Pendência de "userName": "Super Usuário",
Aprovação",
         "interface": 2,
      "documentCodevisible": 5true,
      "documentDescription": "Cotação de Materiais",
       "_expandablessize": [100
        "fields"
      ]},
      "fields": [
        {
                "id": "pend-chavevalor-doc",
                "componentType": 1,
                "label": "ChaveValor",
                "description": "ChaveValor do Documento da Pendência de Aprovação",
                "visible": true,
                "size": 100

              }
            ]
          },
        {],
          "idestablishments": "pend-cod-usuar-doc",[
          "componentType": 1,
 {
            "labelcode": "UsuárioA1",
            "descriptionname": "Código do Usuário da Pendência de AprovaçãoEstabelecimento TOTVS",
            "visiblecodeCompany": true,"10"
          "size": 50
   },
     },
        {
          "id": "pend-valor-doc",
          "componentTypecode": 1"10000",
            "labelname": "ValorEstab 10000",
            "descriptioncodeCompany": "10"Valor
 da Pendência de Aprovação",
      }
    "visible": true,
    ]      "size": 50
  
      }
      ]
    }
  ]
}

RowErrorsTemp-tableOUTPUTInformaçõ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:

}
}

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

tt-aprovador: contém as informações principais do aprovador
tt-config-visual (visualConfigurations): contém as informações de configuração visual do usuário.
groupsCompanies:
- sequencia: sequência do grupo de empresa;
- name: Nome do grupo de empresa;
- ttCompany (companies): contém informações de empresas
tt-document (documents): contém informações dos documentos
- tt-layout (fields): contém informações de campos do layout de documento
ttEstablishments (establishments): contém informações dos estabelecimentos

RowErrors

Temp-table

OUTPUT

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

Retorno

Dados principais para inicialização do APP ou erros ocorridos durante o processo de busca.

pi-get-document-abrev

pi-validate-user-info-v1

pi-query-app-list-v1

pi-query-pending-approval

pi-query-rejection-options-v1

pi-get-detail-pending-v1

pi-get-detail-historic-pending-v1

pi-approve-v1

pi-reprove-v1

pi-reapprove-v1

pi-process-pending-v1

Definição de temp-tables:

RowErrors

Entrada/Saída

Temp-table com dados dos erros ocorridos durante o processo

Saída

Atributo

Tipo

Descrição

Obrigatório

Evolução

ErrorSequence

INTEGER

Número da sequência do erro

Sim

Não se aplica

ErrorNumber

INTEGER Código do erro

Sim

Não se aplica

ErrorDescriptionCHARACTER Descrição do erro SimNão se aplicaErrorParametersCHARACTER Parâmentros da mensagem de erro SimNão se aplicaErrorTypeCHARACTER Tipo do erro SimNão se aplicaErrorHelpCHARACTER Texto de ajuda da mensagem de erro SimNão se aplicaErrorSubTypeCHARACTERSubtipo do erroSimNão se aplicatt-aprovador

				Entrada/Saída
Temp-table com dados dos

aprovadores

erros ocorridos durante o processo				Saída
Atributo

Nome no objeto

Tipo

Descrição

Obrigatório

Evolução

cod-usuar

userCode

CHARACTER

Código do aprovador

Não

Não se aplica

nome-usuar

userNameCHARACTER Nome do aprovador

Não

Não se aplica

e-maileMailCHARACTER E-mail do aprovadorNãoNão se aplicaenvia-emailsendEmailLOGICALIndica se envia e-mail

	Tipo	Descrição	Obrigatório	Evolução
ErrorSequence	INTEGER	Número da sequência do erro	Sim

Não

Não se aplica

recebe-email

ErrorNumber

receiveEmail

INTEGER

LOGICALIndica se recebe e-mail

Código do erro

Sim

Não

se aplica

usuar-mestre

ErrorDescription

masterUser

CHARACTER

LOGICALIndica se o usuário é mestre

Descrição do erro

Sim

Não

Não se aplica

mo-codigo

ErrorParameters

currencyINTEGERMoeda do aprovador

CHARACTER

Parâmentros da mensagem de erro

Sim

Não

Não se aplica

sigla-moedacurrencyAbbrev

ErrorType

CHARACTER

Sigla da moeda

Tipo do

usuário

erro

Não

Sim	Não se aplica

aprova-auto

ErrorHelp

automacticApprovalLOGICALIndica se o aprovador aprova automaticamente

CHARACTER

Texto de ajuda da mensagem de erro

Sim

Não

Não se aplica

aprova-auto-aprovautomacticApprovalApproverLOGICALIndica se o aprovador aprova automaticamente pendências do aprovador

ErrorSubType

CHARACTER

Subtipo do erro

Sim

Não

Não se aplica

codestabelIndica se o aprovador libera verbalog-configIndice se o aprovador é configurador visual

tt-

aprovador

siteCode

CHARACTER

Estabelecimento do aprovador

Não

Não se aplica

cod-lotacao

allocationCode

CHARACTER

Lotação do aprovador

Não

Não se aplica

Entrada/Saída

Temp-table com dados dos aprovadores

Saída

Atributo

Nome no objeto

Tipo

Descrição

Obrigatório

Evolução

cod-usuar

userCode

CHARACTER

Código do aprovador

libera-verba

releaseAmount

LOGICAL

Não

Não se aplica

nome-usuar

configuratorUseruserName

LOGICAL

CHARACTER

Nome do aprovador

Não

Não se aplica

empresae-mail

companyCodeeMail

CHARACTER

Empresa E-mail do aprovador

Não

Não se aplica

idiomaenvia-email

languagesendEmail

CHARACTER

LOGICAL

Indica se envia e-mailIdioma do aprovador

Não

Não se aplica

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

recebe-email	receiveEmail	LOGICAL	Indica se recebe e-mail	Não	Não se aplica
usuar-mestre	masterUser	LOGICAL	Indica se o usuário é mestre	Não	Não se aplica
mo-codigo	currency	INTEGER	Moeda

cod-usuar

CHARACTER

Código

do aprovador

Não

Não se aplica

idi

sigla-

ordenacao

moeda

ordination

currencyAbbrev

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)

CHARACTER

Sigla da moeda do usuário

Não

Não se aplica

log-mostra-todas-empresasallCompanies

aprova-auto

automacticApproval

LOGICAL

Indica

apresentação de pendências de todas as empresas

se o aprovador aprova automaticamente

Não

Não se aplica

log-

aprova-

sem

auto-

motiv

aprov

approveWithoutReason

automacticApprovalApprover

LOGICAL

Indica

aprovação sem informar motivo

se o aprovador aprova automaticamente pendências do aprovador

Não

Não se aplica

cdn

cod-

tempo-desf

estabel

undoTime

siteCode

INTEGERTempo de desfazer

CHARACTER

Estabelecimento do aprovador

Não

Não se aplica

idi-acao-swip-direrightSwipeActionINTEGER

cod-lotacao

allocationCode

CHARACTER

Lotação do aprovador

Não

Ação do swipe (Direito)

(1 - Aprovar / 2 - Rejeitar / 3 - Nenhum)

Não se aplica

idi-acao-swip-esqleftSwipeActionINTEGER

libera-verba

releaseAmount

LOGICAL

Indica se o aprovador libera verba

Ação do swipe (Esquerdo)

(1 - Aprovar / 2 - Rejeitar / 3 - Nenhum)

Não

Não se aplica

idi

log-

visualiz-inicial

usuar-config	configuratorUser	LOGICAL	Indice se o aprovador é configurador visual	Não	Não se aplica
empresa	companyCode	CHARACTER	Empresa do aprovador

initialViewINTEGER

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-paginacpageRecordsNumberINTEGERNúmero de registros por página

idioma

language

CHARACTER

Idioma do aprovador

Não

Não se aplica

Sim

tt-config-visual-upd					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	userCode	CHARACTER	Código do aprovador	Sim	Não se aplica

cod-usuar		CHARACTER	Código do aprovador	Não	idi-interfac	idi-interfac	INTEGER	Interface	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

ttCompany					Entrada/Saída
Temp-table com dados de

documentos

empresas					Saída
Atributo	Nome no objeto	Tipo	Descrição	Obrigatório	Evolução

cod-usuar

seqGroup

userCode

INTEGER

CHARACTER

Código do aprovador

Sequência da empresa

Sim

Não se aplica

idi-interfac

cCode

interface

code

INTEGERInterface (1 - Lista / 2 - Detalhe)

CHARACTER

Código da empresa

Sim

Não se aplica

cod-tip-docdocumentCodeINTEGERCódigo do documento

cName

name

CHARACTER

Nome da empresa

Sim

Não se aplica

desc-tip-docdocumentDescriptionCHARACTER Descrição do documento

ttEstablishments					Entrada/Saída
Temp-table com dados de estabelecimentos					Saída
Atributo	Nome no objeto	Tipo	Descrição	Obrigatório	Evolução
cCode	code	CHARACTER	Código do estabelecimento	Sim

Não

Não se aplica

layout-padrao

cName

defaultLayout

name

LOGICALLayout padrão

CHARACTER

Nome do estabelecimento

Sim

Não

Não se aplica

sigla

cCodeCompany

shortName

codeCompany

CHARACTER

Sigla do documento

Código da empresa

Sim

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

userNameCHARACTER

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_expandablesCHARACTER (Extent 1)Lista de entidades filhas expansíveis


layout-padrao	defaultLayout	LOGICAL	Layout padrão	Não	Não se aplica
sigla	shortName	CHARACTER	Sigla do documento	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 1

Nova versão 2

Chave