URL API

Parameters

• flowFileName - (required) - fully qualified path to the Flow file.
• runProfile - (required) - name of the Run Profile to execute.
• parameterSet - (optional) - name of the Parameter Set to use during execution.
• nodeId - (optional) - node ID of the desired node to open upon redirection to a specified flow.
• action - (required) - defines action to perform:
  • open - opens the desired flow, sets the selected Run Profile and active Parameter Set

Open Flow

Without a parameter set

Syntax:

http://[server name]:[port]/EuclidStudio/api?flowfileName=[flow file name]&runProfile=[run profile name]&action=open

Example:

http://localhost:8080/EuclidStudio/api?flowFileName=c:/temp/FirebirdTest.flx&runProfile=default&action=open

With a parameter set

Syntax:

http://[server name]:[port]/EuclidStudio/api?flowfileName=[flow file name]&runProfile=[run profile name]&parameterSet=[parameter set name]&action=open

Example:

http://localhost:8080/EuclidStudio/api?flowFileName=c:/temp/FirebirdTest.flx&runProfile=default&parameterSet=file_example&action=open

Opens up a specific node when the desired flow is opened

Syntax:

http://[server name]:[port]/EuclidStudio/api?flowfileName=[flow file name]&runProfile=[run profile name]&parameterSet=[parameter set name]&nodeId=[node ID]&action=open

Example:

http://localhost:8080/EuclidStudio/api?flowFileName=c:/temp/FirebirdTest.flx&runProfile=default&parameterSet=file_example&nodeId=node_9467756&action=open