Documentação de API - POAPI001 - API de Consulta da Agenda do Técnico

Produto:	Datasul
Ocorrência:	Documentação de API
Nome Físico:	pop/poapi001.p
Release Inicial	12.1.10
Versão de Integração:	001
Data de Liberação:	07/04/2016
Banco:	MGMNT / MOVMNT
Aplicativo:	Manutenção Industrial

Evolução
Versão	Programa
001	poapi001.p

Uma API (Application Programming Interface) é um programa que recebe parâmetros específicos e executa uma tarefa determinada no Datasul EMS Framework. A tarefa pode ser uma atualização ou pode retornar informações, resultados de um cálculo ou um gráfico. Uma API é uma interface aberta para as funções de negócio do Datasul EMS Framework.

O DBO é um programa Progress que contém a lógica de negócio e acesso aos dados para uma tabela do banco de dados. É uma evolução das APIs dos produtos Datasul.

Objetivo

O objetivo desta API é consultar as agendas dos técnicos.

Funcionamento

Através dos parâmetros de entrada a API filtra as agendas e mostra os agendamentos dos técnicos.

A sintaxe para executar a API em modo persistente é:

run pop\poapi001.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

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

Tabela Temporária	Descrição	Entrada/Saída
ttListAgenda	Tabela que contém a lista das agendas.	Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
datAgenda	DATE		Data da agenda	Não
nrOrdem	INT		Número da Ordem	Não
descOrdem	CHAR		Descrição da Ordem	Não
cdTarefa	INT		Código da Tarefa	Não
descTarefa	CHAR		Descrição da Tarefa	Não
tpEspecial	CHAR		Tipo Especialidade	Não
descEspecial	CHAR		Descrição Especialidade	Não
situacao	INT		Situação	Não
hraInicial	CHAR		Hora Inicial	Não
hraFinal	CHAR		Hora Final	Não
descAgenda	CHAR		Descrição Agenda	Não
cdTurno	INT		Código Turno	Não
valDatHoraInvrtdaInicial	DECIMAL		Data hora invertida	Não
cdEquipto	CHAR		Código Equipamento	Não
descEquipto	CHAR		Descrição Equipamento	Não
prioridade	INT		Prioridade	Não
estadoTaref	CHAR		Estado da Tarefa	Não
estadoOrd	CHAR		Estado da Ordem	Não
codEstabel	CHAR		Código Estabelecimento	Não
scCodigo	INT		Centro Custo	Não

Tabela Temporária	Descrição	Entrada/Saída
ttDetailAgenda	Tabela que contém o detalhe da agenda.	Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
datAgenda	DATE		Data da agenda	Não
cdTarefa	INT		Código da Tarefa	Não
tpEspecial	CHAR		Tipo Especialidade	Não
nrOrdem	INT		Número da Ordem	Não
descOrdem	CHAR		Descrição da Ordem	Não
descTarefa	CHAR		Descrição da Tarefa	Não
descEspecial	CHAR		Descrição especialidade	Não
hraInicial	CHAR		Hora Inicial	Não
hraFinal	CHAR		Hora Final	Não
cdEstabel	CHAR		Código Estabelecimento	Não
cdTurno	INT		Código Turno	Não
estadoTaref	CHAR		Estado da Tarefa	Não
estadoOrd	CHAR		Estado da Ordem	Não
scCodigo	INT		Centro de Custo	Não
prioridade	INT		Prioridade	Não
situacao	INT		Situação	Não
descTecnico	CHAR		Descrição do Técnico	Não
descTurno	CHAR		Descrição do Turno	Não
descEstabel	CHAR		Descrição do Estabelecimento	Não
desAgenda	CHAR		Descrição da Agenda	Não
narrativaTaref	CHAR		Narrativa da Tarefa	Não
tipoTempo	INT		Tipo do tempo	Não
conclusao	DECIMAL		Conclusão	Não
nrHomens	INT		Número de homens	Não
tempo	DECIMAL		Tempo	Não
log1	LOGICAL		Grupo de Técnicos ou apenas um Técnico	Não

Tabela Temporária	Descrição	Entrada/Saída
ttListTurno	Tabela que contém a lista de turnos	Saída

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
cdTurno	INT		Código do Turno	Não
descTurno	CHAR		Descrição do Turno	Não

Tabela Temporária	Descrição	Entrada/Saída
ttParamListAgendaSearch	Temp-table com os valores da consulta agrupada conforme as dimensões definidas	Entrada

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
datAgendaIni	DATE		Data Inicial	Não
datAgendaFim	DATE		Data Final	Não
limitAt	INT		Quantidade de registros retornados	Não
startAt	INT		Número do registro inicial	Não

Tabela Temporária	Descrição	Entrada/Saída
ttDetailParam	Parâmetros para busca de detalhe da agenda	Entrada

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
cdTecnico	INT		Código do Técnico	Não
cdTarefa	INT		Código da Tarefa	Não
nrOrdem	INT		Número da ordem	Não

Tabela Temporária	Descrição	Entrada/Saída
ttSelecaoConsultaAgenda	Tabela que contém os filtros da busca avançada	Entrada

Atributo	Tipo	Formato	Descrição	Obrigatório	Evolução
cdTecnico	INTEGER		Código do Técnico	Sim
cEstabIni	INTEGER		Estabelecimento Inicial	Não
limitAt	INTEGER		Quantidade de registros a retornar	Sim
startAt	INTEGER		Número do registro inicial	Sim
cEstabFim	CHAR		Estabelecimento Final	Não
cPlanejadIni	CHAR		Planejador Inicial	Não
cPlanejadFim	CHAR		Planejador Final	Não
cEquipeIni	CHAR		Equipe Inicial	Não
cEquipeFim	CHAR		Equipe Final	Não
cTagIni	CHAR		Tag Inicial	Não
cTagFim	CHAR		Tag Final	Não
cEquiptoIni	CHAR		Equipamento Inicial	Não
cEquiptoFim	INTEGER		Equipamento Final	Não
iOrdIni	INTEGER		Ordem Inicial	Não
iOrdFim	INTEGER		Ordem Final	Não
cEspecIni	CHAR		Especialidade Inicial	Não
cEspecFim	CHAR		Especialidade Final	Não
cUnidNegocIni	CHAR		Unidade de Negocio Inicial	Não
cUnidNegocFim	CHAR		Unidade de Negócio Final	Não
cTipoInicial	CHAR		Tipo Inicial	Não
cTipoFinal	CHAR		Tipo Final	Não
cdManutInicial	CHAR		Manutenção Inicial	Não
cdManutFinal	CHAR		Manutenção Final	Não
lPreventiva	LOGICAL		Manutenção Preventiva	Não
lCorretiva	LOGICAL		Manutenção Corretiva	Não
lPreditiva	LOGICAL		Manutenção Preditiva	Não
lOutros	LOGICAL		Outros	Não
lHoje	LOGICAL		Hoje	Não
lTarefaAtrasada	LOGICAL		Tarefa Atrasada	Não
periodoInicial	DATE		Período Inicial	Não
periodoFinal	DATE		Período Final	Não
lAbertas	LOGICAL		Agendas Abertas	Não
lFechadas	LOGICAL		Agendas Fechadas	Não
lSomenteConflitos	LOGICAL		Agendas com conflitos	Não

Métodos

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

Método Negócio

getListAgendaSearch

Requisito	Handles estarem inicializados.
Sintaxe	RUN getListAgendaSearch IN h-handle(INPUT TABLE ttParamListAgendaSearch, OUTPUT TABLE ttListAgenda, OUTPUT i-length-page, OUTPUT l-paginate).
Descrição	Busca as agendas com base nos filtros.
	Parâmetros	Descrição
	ttParamListAgendaSearch	Parâmetros de seleção
	ttListAgenda	Lista com as agendas
	i-length-page	Número de registros da paginação
	l-paginate	Se existe paginação
Retorno	A API irá retornar uma temp-table: para apresentar as agendas dentro dos parâmetros da pesquisa.

getListAgendaAdvancedSearch

Requisito	Handles estarem inicializados.
Sintaxe	RUN getListAgendaAdvancedSearch IN h-handle (INPUT cdTecnico, INPUT TABLE ttSelecaoConsultaAgenda, OUTPUT TABLE ttListAgenda, OUTPUT i-lenght-page, OUTPUT l-paginate).
Descrição	Busca as agendas dos técnicos com base nos filtros.
	Parâmetros	Descrição
	cdTecnico	Código do Técnico
	ttSelecaoConsultaAgenda	Filtro da pesquisa avançada
	ttListAgenda	Agendas retornadas
	i-lenght-page	Número do registro
	l-paginate	Se existe paginação

getDetailAgenda

Requisito	Handles estarem inicializados.
Sintaxe	RUN getDetailAgenda IN h-handle (INPUT TABLE ttDetailParam, OUTPUT TABLE ttDetailAgenda).
Descrição	Busca detalhes da agenda.
	Parâmetros	Descrição
	ttDetailParam	Parâmetros para o detalhe
	ttDetailAgenda	Detalhes da agenda

getListTecnico

Requisito	Handles estarem inicializados.
Sintaxe	RUN getListTecnico IN h-handle (OUTPUT TABLE ttListTecnico).
Descrição	Busca lista de técnicos.
	Parâmetros	Descrição
	ttListTecnico	Lista de Técnicos

getListTurno

Requisito	Handles estarem inicializados.
Sintaxe	RUN getListTurno IN h-handle (OUTPUT TABLE ttListTurno).
Descrição	Busca lista de turnos.
	Parâmetros	Descrição
	ttListTurnos	Lista de Turnos

getDetailAgendaAndShift

Requisito	Handles estarem inicializados.
Sintaxe	RUN getDetailAgendaAndShift IN h-handle (INPUT TABLE ttDetailParam, OUTPUT TABLE ttDetailAgenda, OUTPUT TABLE ttListTurno).
Descrição	Busca detalhe da tarefa agendada e lista de turnos.
	Parâmetros	Descrição
	ttDetailParam	Parâmetros
	ttDetailAgenda	Detalhes da agenda
	ttListTurno	Lista de turnos