Histórico da Página

...

pi-get-defaults-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:

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

queryParams → expand: 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

Bloco de código

title	Exemplo

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

oOutput

JsonObject

OUTPUT

Informações 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",
          "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 o existe estabelecimento configurado para aprovação (MLA0000)

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetros para a busca do aprovador:

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

Bloco de código

title	Exemplo

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

oOutput

JsonObject

OUTPUT

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

Bloco de código

title	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-query-app-list-v1

pi-query-pending-approval

...

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

ttCompany					Entrada/Saída
Temp-table com dados de empresas					Saída
Atributo	Nome no objeto	Tipo	Descrição	Obrigatório	Evolução
seqGroup		INTEGER	Sequência da empresa	Sim	Não se aplica
cCode	code	CHARACTER	Código da empresa	Sim	Não se aplica
cName	name	CHARACTER	Nome da empresa	Sim	Não se aplica

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 se aplica
cName	name	CHARACTER	Nome do estabelecimento	Sim	Não se aplica
cCodeCompany	codeCompany	CHARACTER	Código da empresa	Sim	Não se aplica.

tt-document					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
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
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

...

Árvore de páginas

Versões comparadas

Versão antiga 2

Nova versão 3

Chave