Waiting for engine...
Skip to main content

Legacy Data Integration API Reference (1.0.0) - SubRiversColumns

Toggle Pane
API docs by Redocly

Download OpenAPI Specification: Download

Find out more about Data Integration.

Sub Rivers Columns

To manage sub rivers inside a river, there is a need to set first the column subset defined in each river for its sub rivers. That means, every sub river that is created/updated is compared to the valid sub river columns defined in the river.

If a sub river has more columns than the sub river columns defined, an error is raised. The list of the sub river valid columns for each datasource_type or river is based on the Sub River Properties request.

Sub rivers are based on the columns chosen in the the main sub rivers tables. Sub rivers table is composed of global columns per river, and a full or partial row of values by each sub river to fill. Every sub river values are validated by the data type, and the correct values that can be inserted to each column.

For example:

In a parent klaviyo river, we can define columns from the list returned in Sub River Properties requests, and then set the right subset of columns in every river we want to use.

scope: river:list

Get sub rivers columns headers by River.

Authorizations:
BearerToken
path Parameters
riverId
required
string
Example: 5faa7bd17bedeb66f4c287c7

The river ID to reference for

Responses

Response Schema: application/json
cross_id
string (CrossIdSchema)

Cross ID is a referenced ID which crosses between environment and accounts. In this case, the id can be stay the same, but reference between environments and accounts in rivers/connections/logic rivers, etc...

river_id
string (RiverIdSchema)

The river cross id which the sub river is refered to. Every sub river can be reference only one river id.

account
string (AccountSchema)

Data Integration account id.

env_id
string (EnvIdSchema)

The object's environment id.

object (SubRiverColumnSchema)

Request samples 

curl --location -g
--request GET 'https://console.rivery.io/api/rivers/{{riverId}}/sub_rivers/columns' \
--header 'Authorization: Bearer <token>'

Response samples

Content type
application/json
{
  • "cross_id": "5faa7bd17bedeb66f4c287c7",
  • "river_id": "5faa76e31e78e0001d61d7cf",
  • "account": "56643e6770ec07e624d43351",
  • "env_id": "56643e6770ec07e624d43574",
  • "cloumns": {
    • "key": "target_table",
    • "scope": "source"
    }
}

Change the Sub River column headers in River.

Create/Delete/Update order of sub river columns in specific riverId.

Authorizations:
BearerToken
path Parameters
riverId
required
string
Example: 5faa7bd17bedeb66f4c287c7

The river ID to reference for

Request Body schema: application/json
key
string
scope
string
Enum: "source" "target"

Responses

Response Schema: application/json
cross_id
string (CrossIdSchema)

Cross ID is a referenced ID which crosses between environment and accounts. In this case, the id can be stay the same, but reference between environments and accounts in rivers/connections/logic rivers, etc...

river_id
string (RiverIdSchema)

The river cross id which the sub river is refered to. Every sub river can be reference only one river id.

account
string (AccountSchema)

Data Integration account id.

env_id
string (EnvIdSchema)

The object's environment id.

object (SubRiverColumnSchema)

Request samples

Content type
application/json
{
  • "key": "target_table",
  • "scope": "source"
}

Response samples

Content type
application/json
{
  • "cross_id": "5faa7bd17bedeb66f4c287c7",
  • "river_id": "5faa76e31e78e0001d61d7cf",
  • "account": "56643e6770ec07e624d43351",
  • "env_id": "56643e6770ec07e624d43574",
  • "cloumns": {
    • "key": "target_table",
    • "scope": "source"
    }
}