Histórico da Página

...

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

pi-metada-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 dos dados iniciais:

queryParams :

metadata?type=edit:
metadata?type=list

Utilizando este parâmetro com 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

Exemplo

{
    "queryParams": {
    "expand": [     "visualConfigurations,groupsCompanies,documents,documents.fields,establishments"
    ]
  },
    "pathParams": [
       "getDefaults",
       "super"
    ],
}

oOutput

JsonObject

OUTPUT

Informações iniciais para o APP:

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",
          "documents",
          "documents.fields",
          "establishments"
        ],
        "visualConfigurations": [
          {
            "ordination": 3,
            "allCompanies": false,
            "approveWithoutReason": true,
            "undoTime": 5,
            "rightSwipeAction": 1,
            "leftSwipeAction": 1,
            "initialView": 1,
            "pageRecordsNumber": 50
          }
        ],
        "groupsCompanies": [
          {
            "sequence": 1,
            "name": "Grupo de Empresas 1",
            "companies": [
              {
                "code": "002",
                "name": "TOTVS SA - E-kanban"
              },
              {
                "code": "10",
                "name": "10 TOTVS S.A"
              },
              {
                "code": "11",
                "name": "TOTVS"
              }
           }
         ],
         "documents": [
          {
            "documentCode": 1,
            "documentDescription": "Solicitação de Compra - Item",
            "defaultLayout": false,
            "shortName": "SC",
            "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
              }
            ]
          },
          {
            "documentCode": 5,
            "documentDescription": "Cotação de Materiais",
            "defaultLayout": false,
            "shortName": "CO",
            "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
              }
            ]
          }
        ],
        "establishments": [
          {
            "code": "A1",
            "name": "Estabelecimento TOTVS",
            "codeCompany": "10"
          },
          {
            "code": "10000",
            "name": "Estab 10000",
            "codeCompany": "10"
          }
         ]
      }
    ]
  }
}

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
Requisito	Nenhum.
Descrição	Retorna a sigla do documento
	Parâmetros	Tipo	Input/Output	Descrição
	piDocumentCode	INTEGER	INPUT	Código do documento
	pcDocumentDescription	CHARACTER	INPUT	Descrição do documento
	pcSigla	CHARACTER	OUTPUT	Sigla do documento
Retorno	Sigla do documento.

pi-validate-user-info-v1

Requisito

Nenhum.

Descrição

Realiza validações do usuário para acesso:

Se é aprovador;
Se possui algum documento configurado para aprovação;
Se existe estabelecimento configurado para aprovação (MLA0000)

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para a validação do aprovador:

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

Exemplo

{
    "pathParams": [
    "validateUserInfo",
    "super"
  ],
}

oOutput

JsonObject

OUTPUT

Campo indicando se o usuário está válido:

Exemplo

{
  "status": 200,
  "payload": {
    "total": 1,
    "hasNext": false,
    "items": [
      {
        "passed": true
      }
    ]
  }
}

RowErrors Temp-table OUTPUT Informações sobre os erros ocorridos durante o processo de validação.

Retorno

Indica se o usuário está válido e caso não esteja, os erros de validação.

pi-metadata-v1
Requisito	Nenhum
Sintaxe	RUN pi-metadata-v1 in handle (INPUT <JsonObject>, INPUT <CHARACTER>, INPUT <CHARACTER>, OUTPUT DATASET <JsonObject>, OUTPUT TABLE <temp-table>).
Descrição	Retorna o json com os campos e ações que irão compor a tela dinâmica dos anexos conforme o evento: → list: tela de listagem dos anexos com as ações de Incluir, Excluir e Exluir todos. → edit: tela de inclusão de anexo.
	Parâmetros	Descrição
	oInput cEvent cVersion oOutput RowErrors	Número da ordem de compra Data da cotação para conversão Código da moeda para conversão Informações da ordem de compra Erros ocorridos no processo
Retorno	Retorna um dataset contendos informações da ordem de compra, parcelas, cotações, requisições, recebimentos, alterações, eventos e unidades de negócio e uma temp-table com os erros ocorridos durante o processo.
EPC	afterLoadOrdemCompra
	Após buscar informações relacionadas a ordem detalhada
	Parâmetros	Descrição
	Handle_ttOrdemCompra	Handle da temp-table com informações da ordem de compra: ttOrdemCompra
	Handle_ ttPrazoCompra	Handle da temp-table com informações das parcelas: ttPrazoCompra
	Handle_ttCotacaoItem	Handle da temp-table com informações das cotações: ttCotacaoItem
	Handle_ttAltPed	Handle da temp-table com informações das altrerações do pedido: ttAltPed
	Handle_ttRecebimento	Handle da temp-table com informações do recebimento: ttRecebimento
	Handle_ttEventoPed	Handle da temp-table com informações dos eventos do pedido: ttEventoPed
	Handle_ttItRequisicao	Handle da temp-table com informações de item de requisição: ttItRequisicao
	Handle_ttUnidNegoc	Handle da te

Árvore de páginas

Versões comparadas

Versão antiga 3

Nova versão 4

Chave