Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

02. API x Pontos UPC Relacionados
Âncora
2
2

Abaixo estão listadas as APIs e Pontos de UPC responsáveis pelo processamento da interface dinâmica e dos dados do programa. Para mais detalhes sobre como cadastrar uma UPC para essa API, consulte o tópico 5 da documentação  Customização PO-UI.


A API REST - cqp/api/v1/fichaCQInspecao.p deve ser cadastrada no menu do Datasul para que seja possível informar o programa customizado do cliente.  Para mais detalhes sobre como cadastrar uma UPC para API, consulte o tópico 5 da documentação  Customização PO-UI.

Nesta API REST foi implementada a técnica de chamada de UPC padrão para Nesta API REST foi implementada a técnica de chamada de UPC padrão para APIs REST Datasul.

O programa customizado (UPC) deverá tratar os seguintes parâmetros:
•    Endpoint: identifica o método que está sendo executado
•    Evento: identifica o evento/ponto UPC dentro do método
•    Programa: nome do programa que está sendo executado (API REST)
•    Objeto JSON: handle do objeto que contém o JSON que está sendo recebido ou retornado pelo método


Manipulação de
Objetos da Interface (Metadata)
Dados
EndpointEventoEntrada
Observação
Objetivo
getMetaData
findById

new

Metadados

Estrutura metadados da tela de inclusão de parâmetros dos itens de obrigações fiscais.

getMetaData

edit

Metadados

Estrutura metadados da tela de inclusão de parâmetros dos itens de obrigações fiscais.

findById

Payload, PathParams, QueryParams

Get: retorna os dados de um único roteiro.   Permite alterar os dados retornados antes de apresentá-los na tela.

FindAllFindAll

Payload, PathParams, QueryParams

Query: retorna os dados de vários roteiros, conforme filtro.   Permite alterar os dados retornados antes de apresentá-los na tela.

getResults


Payload, PathParams, QueryParams

Retorna os exames e resultados do roteiro (tanto a informar quanto já informados).

findSamplingfindSampling

Payload, PathParams, QueryParams

Permite alterar os dados retornados após a execução do método.

getStockMovement

Payload

Retorna os dados de estoque do roteiro

findStockMovementfindStockMovement
Permite alterar os dados retornados antes de apresentá-los na tela.
saveResultsbeforeSaveResults
permite capturar os dados enviados antes da execução do método
saveResultsafterSaveResults 
permite alterar os dados retornados ou atualizar no os dados capturados no banco de dados após a execução do método
saveSamplingbeforeSaveSampling
Salva dos dados de amostragem, caso entre os exames retornados para o roteiro exista exame que tenha amostragem.   Permite capturar os dados enviados antes de salvar no banco.
saveSamplingafterSaveSampling
Permite alterar os dados retornados após a execução do método.
confirmInspectionbeforeConfirmInspection


afterConfirmInspection

saveStockMovementbeforeSaveStockMovement 


afterSaveStockMovement
getMetaData

view

Metadados

Estrutura metadados da tela de visualização de parâmetros dos itens de obrigações fiscais.

Manipulação de Dados
EndpointEventoEntradaObjetivo
getfindById

Payload, PathParams, QueryParams

Retorna os dados de um único roteiro.   Permite alterar os dados retornados antes de apresentá-los na tela.

queryFindAll

Payload, PathParams, QueryParams

Retorna os dados de vários roteiros, conforme filtro.   Permite alterar os dados retornados antes de apresentá-los na tela.

getResults

findSampling

Payload, PathParams, QueryParams

Executado antes de buscar os documentos.

Payload, PathParams, QueryParams

Executado depois de buscar os documentos.

Payload

Executado antes de criar um documento.

03. JSON de metadata
Âncora
3
3

...