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-metadata-v1

Requisito

Nenhum.

Descrição

Retorna os metadados (estrutura de tela) para a construção dinâmica das interfaces de Listagem (list) ou Edição (edit/create/detail).

Parâmetros Tipo Input/Output Descrição

oInput

JsonObject

INPUT

Parâmetros para a busca de metadados:

queryParams:

Informar o atributo type com uma das opções:

• list: Metadados da tela de listagem.

• edit: Metadados da tela de edição/inclusão.

• detail: Metadados da tela de detalhe.

Bloco de código

title	Exemplo

{
  "queryParams": {
    "type": "list"
  }
}

cEvent Character INPUT Identifica qual o tipo de evento (list, edit, new, detail).

cVersion Character INPUT Identifica a versão da API.

oOutput JsonObject OUTPUT Retorno contendo o objeto de metadados com campos (fields) e ações configuradas.

RowErrors Temp-table OUTPUT Informações sobre erros ocorridos.

Retorno

Retorna informações do metadados ou erros ocorridos durante a busca

pi-query-v1

Requisito

Nenhum.

Descrição

Realiza a busca de registros de NBS com suporte a paginação e filtros.

Parâmetros Tipo Input/Output Descrição

oInput

JsonObject

INPUT

Parâmetros de filtro e paginação:

queryParams:

• searchBy: Array de strings para busca rápida (filtra por código ou descrição).

• pageSize: Quantidade de registros por página (Default: 20).

• startRow: Registro inicial.

Bloco de código

title	Exemplo

{
  "queryParams": {
    "searchBy": ["Serviço"],
    "pageSize": 10
  }
}

aOutput JsonArray OUTPUT Lista de registros encontrados (vide estrutura CadNbs).

lHasNext Logical OUTPUT Indica se existem mais páginas a serem buscadas.

RowErrors Temp-table OUTPUT Informações sobre erros ocorridos.

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

Retorno

Retorna a lista de códigos NBS ou erros ocorridos durante a busca.

...

Árvore de páginas

Versões comparadas

Versão antiga 2

Nova versão 3

Chave