REST API
  • 23 Dec 2022
  • 1 Minute to read
  • Dark
    Light

REST API

  • Dark
    Light

Article summary

Note that this version of the REST API is deprecated as of version 4.2.0, unlike the current version under REST API.

Parameters

  • flowFileName - (required) - fully qualified path to the Flow file.
  • runProfileName - (required) - name of the Run Profile to execute.
  • parameterSetName - (optional) - name of the Parameter Set to use during execution (defaults to runProfile's saved value if excluded).
  • notificationEnabled - (optional) - enables email notifications when set to true (defaults to false if excluded).
  • runAsync - (optional) - disables blocking until job completion when enabled (defaults to false if excluded).
  • timeoutSeconds - (optional) - include to set timeout in seconds for the rest call (default is one day).

Job Execution

POST

URL : http://localhost:8080/EuclidStudio/api
BODY:

{
	"flowFileName": "C:/Temp/Demo.flx",
	"runProfileName": "default",
	"notificationEnabled": false,
	"runAsync": false
}

Video Guide


Was this article helpful?

What's Next