Documento de API
Produto: | Datasul |
Ocorrência: | Documentação de API |
Nome Físico: | mip/miapi093.p |
Objetivo
Criação de solicitação de serviço.
Funcionamento
A sintaxe para executar a BO em modo persistente é:
run mip/miapi093.p persistent set h-handle.
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:
Tabela Temporária | Descrição | Entrada/Saída | ||||
tt-solic-serv | Temp-Table da “solici-serv”. | Entrada | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução | |
RowNum | int | 001 | ||||
r-Rowid | Rowid | Row ID | 001 |
Tabela Temporária | Descrição | Entrada/Saída | ||||
tt-solic-serv-html | Temp-table da solicitação de serviço no HTML. | Entrada | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução | |
nrSoliServ | int | Número da solicitação de serviço | Sim | 001 | ||
cdEquipto | character | x(16) | Equipamento | Sim | 001 | |
cdManut | character | x(8) | Manutenção | Não | 001 | |
cdSintPadr | character | x(8) | Sintoma Padrão | Não | 001 | |
cdTag | character | x(16) | Tag | Não | 001 | |
descricao | character | x(50) | Descrição | Não | 001 | |
narrativa | character | x(50) | Narrativa | Não | 001 | |
nomeUsua | character | x(20) | Nome do Usuário | Não | 001 | |
codDoctoAnexo | character | x(30) | Documento Anexo | Não | 001 |
Tabela Temporária | Descrição | Entrada/Saída | ||||
tt-solic-serv-retorno | Temp-Table com as descrições da solicitação de serviço. | Entrada | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | Evolução | |
des-estado | character | Descrição do estado | 001 | |||
des-equipto | character | Descrição do equipamento | 001 | |||
des-usuario | character | Descrição do usuário | 001 | |||
des-planejador | character | Descrição do planejador | 001 | |||
des-manutencao | character | Descrição da manutenção | 001 | |||
des-narrativa | character | Descrição da narrativa | 001 | |||
des-sintoma-padrao | character | Descrição do sintoma padrão | 001 | |||
des-causa-padrao | character | Descrição da causa padrão | 001 | |||
des-interv-padrao | character | Descrição do intervalo padrão | 001 | |||
des-equipe-resp | character | Descrição da equipe responsável | 001 | |||
des-plano-parada | character | Descrição do plano parada | 001 | |||
des-tag | character | Descrição do tag | 001 | |||
des-familia-eqpto | character | Descrição da família do equipamento | 001 | |||
des-centro-custo | character | Descrição do centro de custo | 001 | |||
nr-ord-orig-pred | integer | Número da ordem origem | 001 | |||
des-ord-origem | character | Descrição da ordem origem | 001 | |||
des-plano-orig | character | Descrição do plano origem | 001 | |||
cd-tar-orig | integer | Código da tarefa origem | 001 | |||
des-tar-manut | character | Descrição da tarefa | 001 | |||
nr-ord-produ | integer | >>>,>>>,>>9 | Número da ordem de produção | 001 | ||
des-man-corr | character | Descrição da manutenção | 001 | |||
total-orcado | decimal | ->>>,>>>,>>0.00 | Total Orçado | 001 | ||
des-unid-negoc | character | Descrição da unidade de negócio | 001 |
Métodos
Quando a API for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
getListServiceRequest
Requisito | Nenhum | ||
Sintaxe | run getListServiceRequest in h-handle. | ||
Descrição | Retorna a lista com as solicitações de serviço. | ||
| Parâmetros | Descrição | Tipo |
| ttSelecao | Parâmetros para criar a lista de solicitação. | Input |
tt-solic-serv-retorno | Temp-Table com a lista das solicitações de serviços. | Output | |
paginate | Número de páginas. | Output | |
totalRecords | Número de registros na lista. | Output | |
Retorno | A API/BO irá 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. |
createRecord
Requisito | Nenhum | ||
Sintaxe | run createRecord in h-handle. | ||
Descrição | Cria solicitação de serviço. | ||
| Parâmetros | Descrição | Tipo |
| tt-solic-serv-html | Temp-table com as informações da solicitação a ser criada. | Input |
tt-solic-serv-retorno | Temp-Table com as solicitações de serviços. | Output | |
Retorno | A API/BO irá 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. |
getAvailableNumber
Requisito | Nenhum | ||
Sintaxe | run getAvailableNumber in h-handle. | ||
Descrição | Retorna um número disponível para solicitação de serviço. | ||
| Parâmetros | Descrição | Tipo |
| i-solic-serv | Número solicitação de serviço disponível. | Output |
Retorno | A API/BO irá 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. |
getRowErrors
Requisito | Nenhum | ||
Sintaxe | run getRowErrors in h-handle. | ||
Descrição | Retorna RowErrors com os erros. | ||
| Parâmetros | Descrição | Tipo |
| RowErrors | Temp-table com os erros. | Output |
Retorno | A API/BO irá 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. |
createTtSoliciServ
Requisito | Nenhum | ||
Sintaxe | run createTtsoliciServ in h-handle. | ||
Descrição | Cria temp-table para a criação de solicitação de serviço. | ||
| Parâmetros | Descrição | Tipo |
| tt-solic-serv-html | Temp-table com os os dados para solicitação. | Input |
tt-solic-serv | Temp-table completa para criação da solicitação de serviço. | Output | |
Retorno | A API/BO irá 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. |
updateTtSoliciServ
Requisito | Nenhum | ||
Sintaxe | run updateTtsoliciServ in h-handle. | ||
Descrição | Atualiza a temp-table para a criação de solicitação de serviço. | ||
| Parâmetros | Descrição | Tipo |
| tt-solic-serv-html | Temp-table com os os dados para solicitação. | Input |
tt-solic-serv | Temp-table completa para criação da solicitação de serviço. | Output | |
Retorno | A API/BO irá 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. |