HOP Server REST API

[Phillip Brown]

Hi

Trying to understand the Hop Server REST API, and not finding the user 
manual all that helpful (Note, the Pentaho documentation is not any 
better in this regard)

First, there seems to be duplication without any explanation of when to 
use some calls rather than other calls. For example, when would I use 
addPipeline vs registerPipeline? Why would I use prepareExec and 
startExec instead of startPipeline?

Second, "Request body should contain xml containing 
pipeline_configuration (pipeline and pipeline_execution_configuration 
wrapped in pipeline_configuration tag)" is there without any real 
explanation of how you go about creating that request body, or where the 
pieces come from. There appears to be the implicit assumption that 
people should just know what it means. And the example in 
registerPipeline doesn't really help, and has an additional 
"metastore_json is base64 encoded GZip content" which also isn't explained.

Finally, how would I go about doing something like running a pipeline 
from another application like Oracle APEX (see, for example, 
https://pretius.com/blog/pentaho-data-integration-oracle-apex/) ?

Regards

Phil Brown