Package io.vertigo.orchestra.webservices

Class WsExecution

java.lang.Object
io.vertigo.orchestra.webservices.WsExecution
All Implemented Interfaces:
io.vertigo.core.node.component.Component, io.vertigo.core.node.component.CoreComponent, io.vertigo.vega.webservice.WebServices
@PathPrefix("/orchestra/executions") public class WsExecution extends Object implements io.vertigo.vega.webservice.WebServices
WebService API for managing Executions
Version:
$Id$
Author:
mlaroche.

  • Constructor Details

    • WsExecution

      public WsExecution()

  • Method Details

    • getProcessExecutionsByProcessName

      @GET("/") public List<ProcessExecution> getProcessExecutionsByProcessName(@QueryParam("processName") String processName, @QueryParam("status") Optional<String> status, @QueryParam("limit") Optional<Integer> limit, @QueryParam("offset") Optional<Integer> offset)
      Retourne la liste des executions d'un processus répondant à des critères triés par ordre chronologique décroissant
      Parameters:
      processName - l'id du processus concerné par la requête
      status - le status des executions à retourner
      limit - le nombre de resultat souhaités
      offset - le rang du premier résultat retourné
      Returns:
      la liste des éxécutions répondant aux critères

    • getProcessExecutionById

      @GET("/{preId}") public ProcessExecution getProcessExecutionById(@PathParam("preId") Long preId)
      Retourne une execution de processus.
      Parameters:
      preId - l'id de l'execution
      Returns:
      l'execution

    • getActivityExecutionsByPreId

      @GET("/{preId}/activities") public List<ActivityExecution> getActivityExecutionsByPreId(@PathParam("preId") Long preId)
      Récupère la liste des activités d'une execution de processus.
      Parameters:
      preId - l'id de l'exécution
      Returns:
      la liste des activités associées

    • getLogFileByPreId

      @GET("/{preId}/logFile") public io.vertigo.datastore.filestore.model.VFile getLogFileByPreId(@PathParam("preId") Long preId)
      Récupère le fichier de log d'une execution de processus
      Parameters:
      preId - l'id de l'exécution
      Returns:
      le fichier de log

    • getActivityExecutionById

      @GET("/{preId}/activities/{aceId}") public ActivityExecution getActivityExecutionById(@PathParam("aceId") Long aceId, @PathParam("preId") Long preId)
      Retourne une execution d'activité par son id.
      Parameters:
      aceId - l'id de l'execution d'activité
      Returns:
      l'activité

    • getLogFileByAceId

      @GET("/{preId}/activities/{aceId}/attachment") public io.vertigo.datastore.filestore.model.VFile getLogFileByAceId(@PathParam("aceId") Long aceId, @PathParam("preId") Long preId)
      Récupère le fichier de log d'une execution d'activité
      Parameters:
      aceId - l'id de l'exécution
      Returns:
      le fichier de log

    • getTechnicalLogFileByAceId

      @GET("/{preId}/activities/{aceId}/logFile") public io.vertigo.datastore.filestore.model.VFile getTechnicalLogFileByAceId(@PathParam("aceId") Long aceId, @PathParam("preId") Long preId)
      Récupère le fichier de log d'une execution d'activité
      Parameters:
      aceId - l'id de l'exécution
      Returns:
      le fichier de log

    • getWeekSummaryByProcessName

      @GET("/summaries/{processName}") public ExecutionSummary getWeekSummaryByProcessName(@PathParam("processName") String processName)
      Retourne le rapport d'execution d'un processus sur une période.
      Parameters:
      processName - l'id du processus
      Returns:
      le résumé

    • getWeekSummaries

      @GET("/summaries") public List<ExecutionSummary> getWeekSummaries(@QueryParam("weekOffset") int weekOffset, @QueryParam("status") Optional<String> status)
      Retourne le rapport d'execution d'orchestra de la semaine courante.
      Parameters:
      weekOffset - le décalage de semaine (-1 semaine dernière etc...)
      status - permet de filtrer sur un état d'execution (par exemple voir les processus qui ont eu une execution en erreur sur la période.
      Returns:
      la liste de résumés répondant aux critères