Histórico da Página
...
02. API x Pontos UPC Relacionados Âncora 2 2
| 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 |
|---|
| Dados | |||
|---|---|---|---|
| Endpoint | Evento | Entrada | |
| Objetivo |
|---|
| findById |
new
Metadados
Estrutura metadados da tela de inclusão de parâmetros dos itens de obrigações fiscais.
edit
Metadados
Estrutura metadados da tela de inclusão de parâmetros dos itens de obrigações fiscais.
| findById |
| Get: retorna os dados de um único roteiro. Permite alterar os dados retornados antes de apresentá-los na tela. | |
| FindAll | FindAll |
| Query: retorna os dados de vários roteiros, conforme filtro. Permite alterar os dados retornados antes de apresentá-los na tela. |
getResults |
| Retorna os exames e resultados do roteiro (tanto a informar quanto já informados). | |
| findSampling | findSampling |
| Permite alterar os dados retornados após a execução do método. |
| getStockMovement |
| Retorna os dados de estoque do roteiro | |
| findStockMovement | findStockMovement | Permite alterar os dados retornados antes de apresentá-los na tela. | |
| saveResults | beforeSaveResults | permite capturar os dados enviados antes da execução do método | |
| saveResults | afterSaveResults | permite alterar os dados retornados ou atualizar no os dados capturados no banco de dados após a execução do método | |
| saveSampling | beforeSaveSampling | 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. | |
| saveSampling | afterSaveSampling | Permite alterar os dados retornados após a execução do método. | |
| confirmInspection | beforeConfirmInspection | ||
| afterConfirmInspection | |||
| saveStockMovement | beforeSaveStockMovement | ||
| afterSaveStockMovement |
view
Metadados
Estrutura metadados da tela de visualização de parâmetros dos itens de obrigações fiscais.
| Manipulação de Dados | |||||
|---|---|---|---|---|---|
| Endpoint | Evento | Entrada | Objetivo | ||
| get | findById |
| Retorna os dados de um único roteiro. Permite alterar os dados retornados antes de apresentá-los na tela. | ||
| query | FindAll |
| Retorna os dados de vários roteiros, conforme filtro. Permite alterar os dados retornados antes de apresentá-los na tela. | ||
getResults | findSampling |
| Executado antes de buscar os documentos. | ||
| Executado depois de buscar os documentos. |
| Executado antes de criar um documento. | ||
03. JSON de metadata Âncora 3 3
| 3 | |
| 3 |
...