- 02 Jan 2024
- 1 Minute to read
- Print
- DarkLight
Using the REST API
- Updated on 02 Jan 2024
- 1 Minute to read
- Print
- DarkLight
DataWORQ flows can be called via the REST API. To do so, we need to execute an HTTP request against
http://<server>:<port>/DataWORQ/api/v1
where <server>
and <port>
are the machine name and port for the DataWORQ server.
http://localhost:8080/DataWORQ/api/v1
, for example.
You will also need to the following headers:
Header | Value |
---|---|
Content-Type | application/json |
user-api-key | Api key created under user management |
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 a TI process. There is a set of TI processes and batch files provided for running a flow from Planning Analytics, depending on the DataWORQ version and whether the call is local or via the cloud.
Call a flow from Planning Analytics
On Premise local call/Call using the Cloud Connector
Call a flow from a TI Process directly from a local PA instance to a local DataWORQ instance, or call a flow from a TI Process to a DataWORQ instance made publicly available via the Cloud Connector.
TI Process in .pro format
PAaaS - Call using the Cloud Connector
Call a flow from a TI Process to a DataWORQ instance made publicly available via the Cloud Connector.
TI Process in .json format
DataWORQ - Call Flow - PAaaS.json
Call a TI Process from a flow
DataWORQ can also be used to run a TI process from a flow.