Using the REST API

Prev Next

Euclid Studio flows can be called via the REST API. To do so, we need to execute an HTTP request against

http://<server>:<port>/EuclidStudio/api/v1

where <server> and <port> are the address to the Euclid Studio server. E.g.,

http://localhost:8080/EuclidStudio/api/v1


Flow Navigation

The REST API can be used to navigate flows. See details here.


Running Flows from Planning Analytics

IBM Planning Analytics can execute flows directly via TI process. There are a set of TI processes and batch files provided to be able to run a flow from Planning Analytics, depending on the Euclid Studio version and whether the call on premise or via the cloud.


Call a flow from Planning Analytics

On Premise local call

Call a flow from a TI Process directly from an on premise PA instance to an on premise Euclid Studio instance.

TI Process in .pro format

quebit_sample_-_euclid_studio_-_call_flow_local.pro

Batch file (place in Data folder)

euclid-api-local.bat


Call using the Cloud Connector

Call a flow from a TI Process to a Euclid Studio instance made publicly available via the Cloud Connector.

TI Process in .pro format

quebit_sample_-_euclid_studio_-_call_flow_cloud.pro

Batch file (place in Data folder)

euclid-api-cloud.bat


Call a TI Process from a flow

Euclid Studio can also be used to run a TI process from a flow.