Legacy Data Integration API Reference (1.0.0) - RunRiver

Toggle Pane

• Run River
  • postExecute an existing river or sub river.
  • getCheck the execution status of a river

API docs by Redocly

Download OpenAPI Specification: Download

Find out more about Data Integration.

Run River

Run rivers, check the run status and get run messages from the platform.

Find out more about running rivers process in our community.

Execute an existing river or sub river.

Use the river_id to execute an existing river or a sub river cross_id.

You can find the river id in the url of the river in the console:

https://console.rivery.io/river/{}/{}/river/{river_id}.

For logic rivers:

https://console.rivery.io/rivers/{}/{}/{river_id}.

The sub river's cross_id can be found by using the GET sub rivers call, or by the id of every sub river in the console.

scope: river:execute

Authorizations:

BearerToken

Request Body schema: application/json

required

River id or sub river id to be executed

Any of

river_id required

string river identifier

Responses

Response Schema: application/json

run_id	string
river_id	string
account	string
run_insert_date	integer
run_update_date	integer
river_run_status	string Enum: "W" "D" "F" "R"
river_run_message	string
_id	string
tasks_status	string
run_end_date	integer

Data Integration Console (US)

https://console.rivery.io/api/run

Data Integration Console (EU)

https://eu-west-1.console.rivery.io/api/run

Request samples

• Payload
• cURL
• Python

Content type

application/json

{

• "river_id": "5e5fbbc2567409482d8511cd"

}

Response samples

• 200
• 429

Content type

application/json

{

• "run_id": "5e473b95567f0hd050tf5ed5",
• "river_id": "5e473b955d7f0h3050tf5ed5",
• "account": "5e473b95564f0h3050tf5ed5",
• "run_insert_date": 1584894117231,
• "run_update_date": 1584894117231,
• "river_run_status": "W",
• "river_run_message": "River river_name is waiting to run",
• "_id": "5e473b95567f0h3050tf5ed5",
• "tasks_status": {

  • "task_status": "D",
  • "task_status_message": "European Central Bank Currencies API to File Zone Done Successfully"

  },
• "run_end_date": 1584894117231

}

Check the execution status of a river

Use the run_id returned for the run endpoint to check the status of a river execution. There are 4 available statuses for a river:

• W = Waiting
• R = Running
• E = Error (failed), includes also the error message under error_description key.
• D = Done Successfully.

Once the river_run_status key is set to 'D' the river has finished successfully

• scope: river:execute

Authorizations:

BearerToken

query Parameters

run_id required

string Run id to check

Responses

Response Schema: application/json

run_id	string
river_id	string
account	string
run_insert_date	integer
run_update_date	integer
river_run_status	string Enum: "W" "D" "F" "R"
river_run_message	string
_id	string
tasks_status	string
run_end_date	integer

Data Integration Console (US)

https://console.rivery.io/api/check_run

Data Integration Console (EU)

https://eu-west-1.console.rivery.io/api/check_run

Request samples

• cURL
• Python

curl --location
--request GET 'https://console.rivery.io/api/check_run' \
--header 'Authorization: Bearer <token>'

Response samples

• 200

Content type

application/json

{

• "run_id": "5e473b95567f0hd050tf5ed5",
• "river_id": "5e473b955d7f0h3050tf5ed5",
• "account": "5e473b95564f0h3050tf5ed5",
• "run_insert_date": 1584894117231,
• "run_update_date": 1584894117231,
• "river_run_status": "W",
• "river_run_message": "River river_name is waiting to run",
• "_id": "5e473b95567f0h3050tf5ed5",
• "tasks_status": {

  • "task_status": "D",
  • "task_status_message": "European Central Bank Currencies API to File Zone Done Successfully"

  },
• "run_end_date": 1584894117231

}