Skip to main content

Uniphore Customer Portal

Start Data Flow

This method starts a specified Data Flow.

For complete details on creating and working with Data Flows, click here.

Invoking the Method Using REST

URL Syntax and Example

http(s)://[host:port/internalPath]/ApplicationName/version/[version]/account/[accountID]/flows/data/run/[FlowID]?optionalKeyName=optionalKeyValue

https://gointeract.io/interact/version/2/account/12345678/flows/data/run/f6bf518b743d-ea4aaf7637098abc-5ed0?reportQuarter=3

HTTP Method

POST

HTTP Headers

Content-Type: application/json
Tenant-Id: <account>
Application-Key: <public API service application key>
Environment-Name: <environment-name>
Optional: <optional-key-name:optional-key-value> 

The optional key may be passed either in the URL (as above) or in the Header.

Sample Response

HTTP/1.1 200 OK
{"itemsCredited":{"2018-07-01":"1561.83","2018-08-01":"653.24","2018-09-01":"697.63"}}
{"itemsPayable":{"2018-07-01":"1561.83","2018-08-01":"653.24","2018-09-01":"697.63"}}