Árvore de páginas

Versões comparadas

Chave

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

...

Produto:

Datasul

Ocorrência:

Documentação de API

Nome Físico

 mip/miapi071.p

 

Objetivo

A API tem como objetivo detalhar, alterar e remover ordens simuladas.

 

Funcionamento

Através dos parâmetros de entrada a API posiciona os registros na tabela de Planejamento da Manutenção removendo ou alterando os registros.

...

A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.

 

Tabelas Temporárias

Nos atributos das tabelas temporárias de entrada e saída:

...

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

 

Método Negócio

updateOrder

 

Requisito

Handles estarem inicializados.

 

Sintaxe

RUN updateOrder IN h-handle(INPUT TABLE ttPlanningDetailVO,

                             OUTPUT TABLE RowErrors).

 

Descrição

Atualizar  ordem planejada.

 

 

Parâmetros

Descrição

 

ttPlanningDetailVO

RowErrors

Tabela Temporária com as informações do planejamento.

 

Tabela temporária com os erros que poderão retornar da API.

Retorno

A API/BO irá alterar na tabela os valores solicitados o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

 

 

   

deletePlannedOrders

 

Requisito

Handles estarem inicializados.

 

Sintaxe

RUN deletePlannedOrders IN h-handle (INPUT TABLE ttPlanningDetailVO,

                                      OUTPUT TABLE RowErrors).

 

Descrição

Deletar ordens planejadas.

 

 

Parâmetros

Descrição

 

ttPlanningDetailVO

RowErrors

Tabela Temporária com as informações do planejamento.

Tabela temporária com os erros que poderão retornar da API.

Retorno

A API/BO irá deletar o registro da ordem planejada e setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.