Hop Server Web Services Overview

Hop Server has a rich set of web services that can be used to query and manage the server’s status, or to manage pipeline and workflow execution details.

when specified, the id for a workflow or pipeline represents one execution of a workflow or pipeline on the server.

addExport

name

addExport

description

Upload a resources export file. Add a zipped pipeline or workflow to the body payload as a binary file.

endPoint

GET hop/addExport

parameters

  • type: pipeline or workflow

  • load: -

example request

http://localhost:8081/hop/addExport/?type=workflow with zipped workflow as payload

result

A zip file with the export is created on the server’s file system.

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <webresult>
  3.     <result>OK</result>
  4.     <message>file:///tmp/export_70eb8ef1-9721-4cf5-afa3-940cd0f771d9.zip</message>
  5.     <id/>
  6. </webresult>

addPipeline

name

addPipeline

description

Add a pipeline for execution

endPoint

GET hop/addPipeline

parameters

  • xml Request body should contain xml containing pipeline_configuration (pipeline and pipeline_execution_configuration wrapped in pipeline_configuration tag).

example request

http://localhost:8081/hop/addPipeline/xml=Y with XML payload

result

\== addWorkflow

name

addWorkflow

description

Add a workflow for execution

endPoint

GET hop/addWorkflow

parameters

  • xml Request body should contain xml containing workflow_configuration (pipeline and workflow_execution_configuration wrapped in pipeline_configuration tag).

example request

http://localhost:8081/hop/addWorkflow/xml=Y with XML payload

result

\== getPipelineImage

name

getPipelineImage

description

Generate a SVG image of a pipeline

endPoint

GET hop/pipelineImage

parameters

  • name: name of the pipeline to generate the image for

  • id: id of the pipeline to generate the image for

example request

GET http://localhost:8081/hop/pipelineImage/?name=remote-pipeline&id=c1451bfb-b867-4c76-b123-c29d2b05da17

result

an SVG image of the pipeline graph

getPipelineStatus

name

getPipelineStatus

description

Get the status of a pipeline

endPoint

GET hop/pipelineStatus

parameters

  • name: name of the pipeline to get the status for

  • id: id of the pipeline to get the status for

example request

GET http://localhost:8081/hop/pipelineStatus/?name=<NAME>>&id=<ID>

result

an HTML response with the execution status, transform details and canvas preview for this pipeline

Status

name

status

description

Get the status of the server

parameters

none

example request

GET http://localhost:8081/hop/status

result

an HTML page with an overview of the pipelines and workflows on the server, their execution details and the server’s configuration details.

getWorkflowImage

name

getWorkflowImage

description

Generate an SVG image of a workflow

endPoint

GET hop/workflowImage

parameters

  • name: name of the workflow to generate the image for

  • id: id of the workflow to generate the image for

example request

GET http://localhost:8081/hop/workflowImage/?name=<NAME>>&id=<ID>

result

an SVG image of the workflow graph

getWorkflowStatus

name

getWorkflowStatus

description

Get the status of a workflow

endPoint

GET hop/workflowStatus

parameters

  • name: name of the workflow to get the status for

  • id: id of the workflow to get the status for

example request

GET http://localhost:8081/hop/workflowStatus/?name=<NAME>&id=<ID>

result

an HTML response with the execution status, action details and canvas preview for this workflow

pausePipeline

name

pausePipeline

description

Pause or continue a pipeline

endPoint

GET /hop/pausePipeline

parameters

  • name: name of the pipeline to pause or restart

  • id: id of the pipeline to pause or restart

example request

GET http://localhost:8081/hop/pausePipeline/?name=<NAME>&id=<ID>

result

HTML page with the request status, e.g.

  1. <HTML>
  3. <HEAD>
  4.     <TITLE>Pause pipeline</TITLE>
  5.     <META http-equiv="Refresh" content="2;url=/hop/pipelineStatus?name=<NAME>&id=<ID>">
  6.     <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. </HEAD>
  9. <BODY>
  10.     <H1>Pipeline [tmp] : pause requested.</H1>
  11.     <a href="/hop/pipelineStatus?name=<NAME>&id=<ID>">Back to the pipeline status page</a>
  12.     <p>
  13.         <p>
  14. </BODY>
  16. </HTML>

Prepare Execution

name

prepareExec

description

Prepare the execution of a pipeline

endPoint

GET /hop/prepareExec

parameters

  • xml: use xml, default Y

  • name: the name of the pipeline to prepare execution for

  • id: the id of the pipeline to prepare execution for

example request

GET http://localhost:8081/hop/prepareExec/?xml=Y&name=<NAME>&id=<ID>

result

Example result:

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <webresult>
  3.     <result>OK</result>
  4.     <message/>
  5.     <id/>
  6. </webresult>

Register Pipeline

name

registerPipeline

description

Register a pipeline for execution

endPoint

GET hop/registerPipeline

parameters

  • xml Request body should contain xml containing pipeline_configuration (pipeline and pipeline_execution_configuration wrapped in pipeline_configuration tag).

example request

http://localhost:8081/hop/registerPipeline/xml=Y with XML payload

result

\== Register Workflow

name

registerWorkflow

description

Register a workflow on the server

endPoint

GET /hop/registerWorkflow

parameters

  • xml:

example request

-

result

-

Remove Pipeline

name

removePipeline

description

Remove a pipeline from the server

endPoint

GET /hop/removePipeline

parameters

  • name: the name of the pipeline to remove

  • id: the id of the pipeline to remove

example request

GET http://localhost:8081/hop/removePipeline/?name=<NAME>&id=<ID>

result

Example result:

  1. <HTML>
  3. <HEAD>
  4.     <TITLE>The pipeline was removed</TITLE>
  5.     <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
  6. </HEAD>
  8. <BODY>
  9.     <H3>The pipeline with name [<NAME>] and hopServer object id <ID> was removed from Hop
  10.         Server.</H3>
  11.     <a href="/hop/status">Back to the status page</a><br>
  12.     <p>
  13. </BODY>

Remove Workflow

name

removeWorkflow

description

Remove a workflow from the server

endPoint

GET /hop/removeWorkflow

parameters

  • name: the name of the workflow to remove

  • id: the id of the workflow to remove

example request

GET http://localhost:8081/hop/removeWorkflow/?name=<NAME>&id=<ID>

result

Example result:

  1. <HTML>
  3. <HEAD>
  4.     <TITLE>The workflow was removed</TITLE>
  5.     <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
  6. </HEAD>
  8. <BODY>
  9.     <H3>The workflow with name [<NAME>] and hopServer object id <ID> was removed from Hop
  10.         Server.</H3>
  11.     <a href="/hop/status">Back to the status page</a><br>
  12.     <p>
  13. </BODY>

Sniff Transform

name

sniffTransform

description

Sniff test a pipeline transform

endPoint

GET /hop/sniffTransform

parameters

  • xml: use XML (default: Y)

  • name: name of the pipeline to sniff

  • id: id of the pipeline to sniff

  • transform: name of the transform to sniff

  • type: (input/output) sniff input or output

example request

GET http://localhost:8081/hop/sniffTransform/?xml=Y&name=<NAME>&id=<ID>&transform=<TRANSFORMNAME>&type=output

result

Example result (empty):

  1. <row-buffer>
  2. <row-meta/>
  3. </row-buffer>

Start Pipeline Execution

name

startExec

description

Start the execution of a pipeline

endPoint

GET /hop/startExec

parameters

  • name: the name of the pipeline to start

example request

GET http://localhost:8081/hop/startExec?name=<NAME>

result

Example result:

  1. <HTML>
  3. <HEAD>
  4.     <TITLE>Start of pipeline</TITLE>
  5.     <META http-equiv="Refresh" content="2;url=/hop/pipelineStatus?name=<NAME>">
  6.     <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. </HEAD>
  9. <BODY>
  10.     <H1>Pipeline [<NAME>] was started.</H1>
  11.     <a href="/hop/pipelineStatus?name=<NAME>&id=8bea27db-de97-4bd0-a210-d9bba3aacac2">Back to the status page</a>
  12.     <p>
  13.         <p>
  14. </BODY>
  16. </HTML>

Start Pipeline

name

startPipeline

description

Prepare and start the execution of a pipeline

endPoint

GET /hop/startPipeline

parameters

  • name: the name of the pipeline to start

example request

GET http://localhost:8081/hop/startPipeline?name=<NAME>

result

Example result:

  1. <HTML>
  3. <HEAD>
  4.     <TITLE>Start of pipeline</TITLE>
  5.     <META http-equiv="Refresh" content="2;url=/hop/pipelineStatus?name=<NAME>">
  6.     <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. </HEAD>
  9. <BODY>
  10.     <H1>Pipeline [<NAME>] was started.</H1>
  11.     <a href="/hop/pipelineStatus?name=<NAME>&id=8bea27db-de97-4bd0-a210-d9bba3aacac2">Back to the status page</a>
  12.     <p>
  13.         <p>
  14. </BODY>
  16. </HTML>

Start Workflow

name

startWorkflow

description

Prepare and start the execution of a workflow

endPoint

GET /hop/startPipeline

parameters

  • name: the name of the workflow to start

example request

GET http://localhost:8081/hop/startWorkflow?name=<NAME>

result

Example result:

  1. <HTML>
  3. <HEAD>
  4.     <TITLE>Start of workflow</TITLE>
  5.     <META http-equiv="Refresh" content="2;url=/hop/startWorkflow?name=<NAME>">
  6.     <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. </HEAD>
  9. <BODY>
  10.     <H1>Workflow [<NAME>] was started.</H1>
  11.     <a href="/hop/workflowStatus?name=<NAME>&id=8bea27db-de97-4bd0-a210-d9bba3aacac2">Back to the status page</a>
  12.     <p>
  13.         <p>
  14. </BODY>
  16. </HTML>

Stop Pipeline

name

stopPipeline

description

Stop a pipeline

endPoint

GET /hop/stopPipeline

parameters

  • name: the name of the pipeline to stop

  • id: the id of the pipeline to stop

example request

GET http://localhost:8081/hop/stopPipeline?name=<NAME>&id=<ID>

result

Example Result:

  1. <HTML>
  3. <HEAD>
  4.     <TITLE>Stop pipeline</TITLE>
  5.     <META http-equiv="Refresh" content="2;url=/hop/pipelineStatus?name=<NAME>>">
  6.     <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. </HEAD>
  9. <BODY>
  10.     <H1>Pipeline [<NAME>] stop requested.</H1>
  11.     <a href="/hop/pipelineStatus?name=<NAME>&id=<ID>">Back to the pipeline status page</a>
  12.     <p>
  13.         <p>
  14. </BODY>
  16. </HTML>

Stop Workflow

name

stopWorkflow

description

Stop a workflow

endPoint

GET /hop/stopWorkflow

parameters

  • name: the name of the workflow to stop

  • id: the id of the workflow to stop

example request

GET http://localhost:8081/hop/stopWorkflow?name=<NAME>&id=<ID>

result

Example Result:

  1. <HTML>
  3. <HEAD>
  4.     <TITLE>Stop workflow</TITLE>
  5.     <META http-equiv="Refresh" content="2;url=/hop/workflowStatus?name=<NAME>>">
  6.     <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
  7. </HEAD>
  9. <BODY>
  10.     <H1>Workflow [<NAME>] stop requested.</H1>
  11.     <a href="/hop/workflowStatus?name=<NAME>&id=<ID>">Back to the pipeline status page</a>
  12.     <p>
  13.         <p>
  14. </BODY>
  16. </HTML>