Boomi Data Integration API Reference (1.0.0) - BetaEndpoints

Toggle Pane

• Beta Endpoints
  • putEdit River
  • postAdd River
  • postCopy River
  • putRestore River Version
  • postEnable Cdc
  • postDisable Cdc
  • postActivate River
  • postDisable River
  • getGet Predefined Columns
  • getGet Predefined Tables
  • getGet Predefined Metadata
  • getGet Source Metadata
  • getGet Connections
  • postAdd Connection
  • putUpdate Connection
  • postAdd File

API docs by Redocly

Download OpenAPI Specification: Download

Find out more about Data Integration

Beta Endpoints

Beta endpoints

Edit River

Authorization scope: river:write

This endpoint updates a river.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)

Request Body schema: application/json

required

name required	string (Name) The name of the river.
type required	string (RiverTypeEnum) Enum: "source_to_target" "actions" "logic" "connector_executor" The type of river.
required	object (RiverMetadata) An object containing river metadata.
required	object (RiverSettings) An object containing river settings.
required	any (Properties) The properties of a river.
	RiverKindEnum (string) or null Default: "main_river" The kind of the river.
	Group Id (string) or Group Id (null) (Group Id) The id of the group the river belongs to.
	Group Name (string) or Group Name (null) (Group Name) The name of the group the river belongs to.
	Array of objects (Schedulers) [ 0 .. 1 ] items Default: [] An object containing the schedule settings. Currently support only one scheduler
	Cross Id (string) or Cross Id (null) (Cross Id) The cross_id of the river to be deployed.
	Deployment Definition (object) or Deployment Definition (null) (Deployment Definition) The deployment definition of the river to be deployed.

Responses

Response Schema: application/json

cross_id required	string (Cross Id) The river cross id.
account_id required	string (Account Id) The account id.
type required	string (RiverTypeEnum) Enum: "source_to_target" "actions" "logic" "connector_executor" The type of the river.
name required	string (Name) The name of the river.
environment_id required	string (Environment Id) The environment cross id.
environment_name required	string (Environment Name) The environment name.
group_id required	string (Group Id) The group id.
group_name required	string (Group Name) The group name.
required	object (RiverMetadataExtended) The river metadata.
required	any (Properties) The river properties, will change according to the river type.
kind	string (RiverKindEnum) Default: "main_river" Enum: "sub_river" "main_river" The kind of the river.
	RiverSettings (object) or null River settings.
	Array of Schedulers (objects) or Schedulers (null) (Schedulers) Default: [] River schedulers.

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}

Request samples

• Payload

Content type

application/json

{

• "name": "river_name",
• "kind": "main_river",
• "type": "source_to_target",
• "group_id": "55fr7d4270fdca16cac18261",
• "group_name": "river_group_1",
• "metadata": {

  • "description": "River 1 description",
  • "river_status": "active"

  },
• "settings": {

  • "run_timeout_seconds": 43200,
  • "notification": {

    • "warning": {

      • "email": "test@test.com",
      • "is_enabled": true,
      • "execution_time_limit_seconds": 43200

      },
    • "failure": {

      • "email": "test@test.com",
      • "is_enabled": true,
      • "execution_time_limit_seconds": 43200

      },
    • "run_threshold": {

      • "email": "test@test.com",
      • "is_enabled": true,
      • "execution_time_limit_seconds": 43200

      }

    }

  },
• "properties": {

  • "properties_type": "source_to_target",
  • "source": {

    • "name": "mysql",
    • "connection_id": "5f4d3b3d9f9c8b0001f6b0e6",
    • "connection_name": "Connection 1",
    • "run_type": "predefined_report",
    • "cdc_settings": {

      • "default_tables_migration_option": "SKIP_INITIAL_MIGRATION",
      • "include_snapshot_tables": true,
      • "datasource_id": "mysql"

      },
    • "additional_settings": {

      • "extract_method": "all"

      }

    },
  • "target": {

    • "name": "snowflake",
    • "connection_id": "5f4d3b3d9f9c8b0001f6b0e6",
    • "connection_name": "Connection 1",
    • "table_name": "Table 1",
    • "target_prefix": "start_at_",
    • "is_ordered_merge_key": true,
    • "order_expression": "id desc,createDate asc",
    • "loading_method": "merge",
    • "merge_method": "merge",
    • "file_zone_settings": {

      • "path": "my_path",
      • "bucket_name": "my_bucket",
      • "partitioned_kind": "by_day",
      • "fz_loading_mode": "auto-period"

      },
    • "file_path_destination": "path/to/file",
    • "additional_settings": {

      • "key": "value"

      },
    • "database_name": "Database 1",
    • "schema_name": "Schema 1"

    },
  • "schemas": [ ]

  },
• "schedulers": [ ],
• "cross_id": "string",
• "deployment_definition": { }

}

Response samples

• 200
• 422

Content type

application/json

{

• "cross_id": "62e7f4352c13160013dc39be",
• "account_id": "62e7f4352c13160013dc39be",
• "kind": "main_river",
• "type": "source_to_target",
• "name": "my_river",
• "environment_id": "62e7f4352c13160013dc39be",
• "environment_name": "my_environment",
• "group_id": "62e7f4352c13160013dc39be",
• "group_name": "my_group",
• "metadata": {

  • "description": "River 1 description",
  • "river_status": "active",
  • "current_version_id": "5f4d3b3d9f9c8b0001f6b0e6",
  • "created_by": "SomeUser",
  • "last_updated_by": "SomeUser",
  • "created_at": "2020-09-01T00:00:00Z",
  • "last_updated_at": "2020-09-01T12:00:00.000Z",
  • "is_deleted": false

  },
• "properties": {

  • "properties_type": "source_to_target",
  • "source": {

    • "name": "mysql",
    • "connection_id": "5f4d3b3d9f9c8b0001f6b0e6",
    • "connection_name": "Connection 1",
    • "run_type": "predefined_report",
    • "cdc_settings": {

      • "default_tables_migration_option": "SKIP_INITIAL_MIGRATION",
      • "include_snapshot_tables": true,
      • "datasource_id": "mysql"

      },
    • "additional_settings": {

      • "extract_method": "all"

      }

    },
  • "target": {

    • "name": "snowflake",
    • "connection_id": "5f4d3b3d9f9c8b0001f6b0e6",
    • "connection_name": "Connection 1",
    • "table_name": "Table 1",
    • "target_prefix": "start_at_",
    • "is_ordered_merge_key": true,
    • "order_expression": "id desc,createDate asc",
    • "loading_method": "merge",
    • "merge_method": "merge",
    • "file_zone_settings": {

      • "path": "my_path",
      • "bucket_name": "my_bucket",
      • "partitioned_kind": "by_day",
      • "fz_loading_mode": "auto-period"

      },
    • "file_path_destination": "path/to/file",
    • "additional_settings": {

      • "key": "value"

      },
    • "database_name": "Database 1",
    • "schema_name": "Schema 1"

    },
  • "schemas": [ ]

  },
• "settings": {

  • "run_timeout_seconds": 43200,
  • "notification": {

    • "warning": {

      • "email": "test@test.com",
      • "is_enabled": true,
      • "execution_time_limit_seconds": 43200

      },
    • "failure": {

      • "email": "test@test.com",
      • "is_enabled": true,
      • "execution_time_limit_seconds": 43200

      },
    • "run_threshold": {

      • "email": "test@test.com",
      • "is_enabled": true,
      • "execution_time_limit_seconds": 43200

      }

    }

  },
• "schedulers": [ ]

}

Add River

Authorization scope: river:write

This endpoint creates a river.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)

Request Body schema: application/json

required

name required	string (Name) The name of the river.
type required	string (RiverTypeEnum) Enum: "source_to_target" "actions" "logic" "connector_executor" The type of river.
required	object (RiverMetadata) An object containing river metadata.
required	object (RiverSettings) An object containing river settings.
required	any (Properties) The properties of a river.
	RiverKindEnum (string) or null Default: "main_river" The kind of the river.
	Group Id (string) or Group Id (null) (Group Id) The id of the group the river belongs to.
	Group Name (string) or Group Name (null) (Group Name) The name of the group the river belongs to.
	Array of objects (Schedulers) [ 0 .. 1 ] items Default: [] An object containing the schedule settings. Currently support only one scheduler
	Cross Id (string) or Cross Id (null) (Cross Id) The cross_id of the river to be deployed.
	Deployment Definition (object) or Deployment Definition (null) (Deployment Definition) The deployment definition of the river to be deployed.

Responses

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers

Request samples

• Payload

Content type

application/json

{

• "name": "river_name",
• "kind": "main_river",
• "type": "source_to_target",
• "group_id": "55fr7d4270fdca16cac18261",
• "group_name": "river_group_1",
• "metadata": {

  • "description": "River 1 description",
  • "river_status": "active"

  },
• "settings": {

  • "run_timeout_seconds": 43200,
  • "notification": {

    • "warning": {

      • "email": "test@test.com",
      • "is_enabled": true,
      • "execution_time_limit_seconds": 43200

      },
    • "failure": {

      • "email": "test@test.com",
      • "is_enabled": true,
      • "execution_time_limit_seconds": 43200

      },
    • "run_threshold": {

      • "email": "test@test.com",
      • "is_enabled": true,
      • "execution_time_limit_seconds": 43200

      }

    }

  },
• "properties": {

  • "properties_type": "source_to_target",
  • "source": {

    • "name": "mysql",
    • "connection_id": "5f4d3b3d9f9c8b0001f6b0e6",
    • "connection_name": "Connection 1",
    • "run_type": "predefined_report",
    • "cdc_settings": {

      • "default_tables_migration_option": "SKIP_INITIAL_MIGRATION",
      • "include_snapshot_tables": true,
      • "datasource_id": "mysql"

      },
    • "additional_settings": {

      • "extract_method": "all"

      }

    },
  • "target": {

    • "name": "snowflake",
    • "connection_id": "5f4d3b3d9f9c8b0001f6b0e6",
    • "connection_name": "Connection 1",
    • "table_name": "Table 1",
    • "target_prefix": "start_at_",
    • "is_ordered_merge_key": true,
    • "order_expression": "id desc,createDate asc",
    • "loading_method": "merge",
    • "merge_method": "merge",
    • "file_zone_settings": {

      • "path": "my_path",
      • "bucket_name": "my_bucket",
      • "partitioned_kind": "by_day",
      • "fz_loading_mode": "auto-period"

      },
    • "file_path_destination": "path/to/file",
    • "additional_settings": {

      • "key": "value"

      },
    • "database_name": "Database 1",
    • "schema_name": "Schema 1"

    },
  • "schemas": [ ]

  },
• "schedulers": [ ],
• "cross_id": "string",
• "deployment_definition": { }

}

Response samples

• 201
• 422

Content type

application/json

{

• "cross_id": "62e7f4352c13160013dc39be",
• "account_id": "62e7f4352c13160013dc39be",
• "kind": "main_river",
• "type": "source_to_target",
• "name": "my_river",
• "environment_id": "62e7f4352c13160013dc39be",
• "environment_name": "my_environment",
• "group_id": "62e7f4352c13160013dc39be",
• "group_name": "my_group",
• "metadata": {

  • "description": "River 1 description",
  • "river_status": "active",
  • "current_version_id": "5f4d3b3d9f9c8b0001f6b0e6",
  • "created_by": "SomeUser",
  • "last_updated_by": "SomeUser",
  • "created_at": "2020-09-01T00:00:00Z",
  • "last_updated_at": "2020-09-01T12:00:00.000Z",
  • "is_deleted": false

  },
• "properties": {

  • "properties_type": "source_to_target",
  • "source": {

    • "name": "mysql",
    • "connection_id": "5f4d3b3d9f9c8b0001f6b0e6",
    • "connection_name": "Connection 1",
    • "run_type": "predefined_report",
    • "cdc_settings": {

      • "default_tables_migration_option": "SKIP_INITIAL_MIGRATION",
      • "include_snapshot_tables": true,
      • "datasource_id": "mysql"

      },
    • "additional_settings": {

      • "extract_method": "all"

      }

    },
  • "target": {

    • "name": "snowflake",
    • "connection_id": "5f4d3b3d9f9c8b0001f6b0e6",
    • "connection_name": "Connection 1",
    • "table_name": "Table 1",
    • "target_prefix": "start_at_",
    • "is_ordered_merge_key": true,
    • "order_expression": "id desc,createDate asc",
    • "loading_method": "merge",
    • "merge_method": "merge",
    • "file_zone_settings": {

      • "path": "my_path",
      • "bucket_name": "my_bucket",
      • "partitioned_kind": "by_day",
      • "fz_loading_mode": "auto-period"

      },
    • "file_path_destination": "path/to/file",
    • "additional_settings": {

      • "key": "value"

      },
    • "database_name": "Database 1",
    • "schema_name": "Schema 1"

    },
  • "schemas": [ ]

  },
• "settings": {

  • "run_timeout_seconds": 43200,
  • "notification": {

    • "warning": {

      • "email": "test@test.com",
      • "is_enabled": true,
      • "execution_time_limit_seconds": 43200

      },
    • "failure": {

      • "email": "test@test.com",
      • "is_enabled": true,
      • "execution_time_limit_seconds": 43200

      },
    • "run_threshold": {

      • "email": "test@test.com",
      • "is_enabled": true,
      • "execution_time_limit_seconds": 43200

      }

    }

  },
• "schedulers": [ ]

}

Copy River

Authorization scope: river:write

This endpoint creates a copy of a river

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)

Responses

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/copy

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/copy

Response samples

• 201
• 422

Content type

application/json

{

• "details": "string",
• "cross_id": "62e7f4352c13160013dc39be"

}

Restore River Version

Authorization scope: river:write

This endpoint restores a river to a specific version

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)

Request Body schema: application/json

required

version_id required

string (Version Id) The id of the version to restore.

Responses

Response Schema: application/json

cross_id required	string (Cross Id) The river cross id.
account_id required	string (Account Id) The account id.
type required	string (RiverTypeEnum) Enum: "source_to_target" "actions" "logic" "connector_executor" The type of the river.
name required	string (Name) The name of the river.
environment_id required	string (Environment Id) The environment cross id.
environment_name required	string (Environment Name) The environment name.
group_id required	string (Group Id) The group id.
group_name required	string (Group Name) The group name.
required	object (RiverMetadataExtended) The river metadata.
required	any (Properties) The river properties, will change according to the river type.
kind	string (RiverKindEnum) Default: "main_river" Enum: "sub_river" "main_river" The kind of the river.
	RiverSettings (object) or null River settings.
	Array of Schedulers (objects) or Schedulers (null) (Schedulers) Default: [] River schedulers.

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/restore

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/restore

Request samples

• Payload

Content type

application/json

{

• "version_id": "5f7d4270fdca16cac18261"

}

Response samples

• 200
• 422

Content type

application/json

{

• "cross_id": "62e7f4352c13160013dc39be",
• "account_id": "62e7f4352c13160013dc39be",
• "kind": "main_river",
• "type": "source_to_target",
• "name": "my_river",
• "environment_id": "62e7f4352c13160013dc39be",
• "environment_name": "my_environment",
• "group_id": "62e7f4352c13160013dc39be",
• "group_name": "my_group",
• "metadata": {

  • "description": "River 1 description",
  • "river_status": "active",
  • "current_version_id": "5f4d3b3d9f9c8b0001f6b0e6",
  • "created_by": "SomeUser",
  • "last_updated_by": "SomeUser",
  • "created_at": "2020-09-01T00:00:00Z",
  • "last_updated_at": "2020-09-01T12:00:00.000Z",
  • "is_deleted": false

  },
• "properties": {

  • "properties_type": "source_to_target",
  • "source": {

    • "name": "mysql",
    • "connection_id": "5f4d3b3d9f9c8b0001f6b0e6",
    • "connection_name": "Connection 1",
    • "run_type": "predefined_report",
    • "cdc_settings": {

      • "default_tables_migration_option": "SKIP_INITIAL_MIGRATION",
      • "include_snapshot_tables": true,
      • "datasource_id": "mysql"

      },
    • "additional_settings": {

      • "extract_method": "all"

      }

    },
  • "target": {

    • "name": "snowflake",
    • "connection_id": "5f4d3b3d9f9c8b0001f6b0e6",
    • "connection_name": "Connection 1",
    • "table_name": "Table 1",
    • "target_prefix": "start_at_",
    • "is_ordered_merge_key": true,
    • "order_expression": "id desc,createDate asc",
    • "loading_method": "merge",
    • "merge_method": "merge",
    • "file_zone_settings": {

      • "path": "my_path",
      • "bucket_name": "my_bucket",
      • "partitioned_kind": "by_day",
      • "fz_loading_mode": "auto-period"

      },
    • "file_path_destination": "path/to/file",
    • "additional_settings": {

      • "key": "value"

      },
    • "database_name": "Database 1",
    • "schema_name": "Schema 1"

    },
  • "schemas": [ ]

  },
• "settings": {

  • "run_timeout_seconds": 43200,
  • "notification": {

    • "warning": {

      • "email": "test@test.com",
      • "is_enabled": true,
      • "execution_time_limit_seconds": 43200

      },
    • "failure": {

      • "email": "test@test.com",
      • "is_enabled": true,
      • "execution_time_limit_seconds": 43200

      },
    • "run_threshold": {

      • "email": "test@test.com",
      • "is_enabled": true,
      • "execution_time_limit_seconds": 43200

      }

    }

  },
• "schedulers": [ ]

}

Enable Cdc

Authorization scope: river:write

This endpoint enables the CDC extraction for a CDC river.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)

Responses

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/enable_cdc

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/enable_cdc

Response samples

• 202
• 422

Content type

application/json

Example

OperationResponseResponse Enable CdcOperationResponse

{

• "operation_id": "62e7f4352c13160013dc39be",
• "operation_type": "dataframe",
• "run_id": "5cbc6bbbc90a4658b00c70a3bb0f3b31",
• "last_update_date": "2022-08-02T13:38:44.054000",
• "status": "D",
• "result": "true",
• "error_message": "[RVR-QBK-003]: Response value error: Missing Rows/Columns"

}

Disable Cdc

Authorization scope: river:write

This endpoint disables the CDC extraction for a CDC river.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)

Responses

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/disable_cdc

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/disable_cdc

Response samples

• 202
• 422

Content type

application/json

Example

OperationResponseResponse Disable CdcOperationResponse

{

• "operation_id": "62e7f4352c13160013dc39be",
• "operation_type": "dataframe",
• "run_id": "5cbc6bbbc90a4658b00c70a3bb0f3b31",
• "last_update_date": "2022-08-02T13:38:44.054000",
• "status": "D",
• "result": "true",
• "error_message": "[RVR-QBK-003]: Response value error: Missing Rows/Columns"

}

Activate River

Authorization scope: river:write

This endpoint activates a river for allowing it to run.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)

Responses

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/activate_river

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/activate_river

Response samples

• 202
• 422

Content type

application/json

Example

OperationResponseResponse Activate RiverOperationResponse

{

• "operation_id": "62e7f4352c13160013dc39be",
• "operation_type": "dataframe",
• "run_id": "5cbc6bbbc90a4658b00c70a3bb0f3b31",
• "last_update_date": "2022-08-02T13:38:44.054000",
• "status": "D",
• "result": "true",
• "error_message": "[RVR-QBK-003]: Response value error: Missing Rows/Columns"

}

Disable River

Authorization scope: river:write

This endpoint disables a river to forbid it from running.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)

Responses

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/disable_river

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/disable_river

Response samples

• 202
• 422

Content type

application/json

Example

OperationResponseResponse Disable RiverOperationResponse

{

• "operation_id": "62e7f4352c13160013dc39be",
• "operation_type": "dataframe",
• "run_id": "5cbc6bbbc90a4658b00c70a3bb0f3b31",
• "last_update_date": "2022-08-02T13:38:44.054000",
• "status": "D",
• "result": "true",
• "error_message": "[RVR-QBK-003]: Response value error: Missing Rows/Columns"

}

Get Predefined Columns

This endpoint gets all predefined columns per datasource id and report_id.

Authorizations:

HTTPBearer

query Parameters

datasource_id required	string (Datasource Id) Enum: "mysql" "postgresql" "oracle" "mongodb" "mssql" "mariadb" "vertica" "elasticsearch" "shopify" "facebook ads" "tiktok" "blueprint" "bigquery" "snowflake" "redshift" "boomi_for_sap" Examples: datasource_id=shopify The datasource of the columns.
report required	string (Report) Examples: report=orders The report id
	Column Name (string) or Column Name (null) (Column Name) Examples: column_name=id Name of the column to filter
items_per_page	integer (Items Per Page) [ 1 .. 500 ] Default: 20 The number of items per page in the paginated list.
page	integer (Page) >= 1 Default: 1 The current page number in the paginated list.

Responses

Response Schema: application/json

current_page_size required	integer (Current Page Size) The current page size
required	Array of objects (Items) A list of predefined columns
	Next Page (string) or Next Page (null) (Next Page) The next page URL
	Previous Page (string) or Previous Page (null) (Previous Page) The previous page URL
page	integer (Page) Default: 1 The page number
total_items	integer (Total Items) Default: 0 The total number of entities fetched

US

https://api.rivery.io/v1/predefined_metadata/columns

EU

https://api.eu-west-1.rivery.io/v1/predefined_metadata/columns

Response samples

• 200
• 422

Content type

application/json

{

• "next_page": "string",
• "previous_page": "string",
• "page": 1,
• "current_page_size": 0,
• "total_items": 0,
• "items": [

  • {

    • "name": "column_name",
    • "type": "STRING",
    • "is_key": true,
    • "alias": "column_alias",
    • "mode": "NULLABLE",
    • "datasource_id": "shopify",
    • "report": "orders",
    • "fields": [

      • "string"

      ]

    }

  ]

}

Get Predefined Tables

This endpoint gets all predefined tables per datasource id.

Authorizations:

HTTPBearer

query Parameters

datasource_id required	string (Datasource Id) Enum: "mysql" "postgresql" "oracle" "mongodb" "mssql" "mariadb" "vertica" "elasticsearch" "shopify" "facebook ads" "tiktok" "blueprint" "bigquery" "snowflake" "redshift" "boomi_for_sap" Examples: datasource_id=shopify The datasource of the columns.
	Report Name (string) or Report Name (null) (Report Name) Examples: report_name=orders Name of the report to filter
items_per_page	integer (Items Per Page) [ 1 .. 500 ] Default: 20 The number of items per page in the paginated list.
page	integer (Page) >= 1 Default: 1 The current page number in the paginated list.

Responses

Response Schema: application/json

current_page_size required	integer (Current Page Size) The current page size
required	Array of objects (Items) A list of predefined tables
	Next Page (string) or Next Page (null) (Next Page) The next page URL
	Previous Page (string) or Previous Page (null) (Previous Page) The previous page URL
page	integer (Page) Default: 1 The page number
total_items	integer (Total Items) Default: 0 The total number of entities fetched

US

https://api.rivery.io/v1/predefined_metadata/tables

EU

https://api.eu-west-1.rivery.io/v1/predefined_metadata/tables

Response samples

• 200
• 422

Content type

application/json

{

• "next_page": "string",
• "previous_page": "string",
• "page": 1,
• "current_page_size": 0,
• "total_items": 0,
• "items": [

  • {

    • "id": "table_id",
    • "increment_columns": [

      • {

        • "incremental_type": "runningnumber",
        • "is_default": false,
        • "name": "days_unsigned__c",
        • "type": "FLOAT"

        }

      ],
    • "datasource_id": "shopify",
    • "report_id": "predefined_orders",
    • "report_name": "orders",
    • "no_increment": true,
    • "increment_required": true,
    • "user_parameters": [

      • "date"

      ],
    • "hide_parameters": [ ]

    }

  ]

}

Get Predefined Metadata

This endpoint gets all predefined metadata datasource id and report id.

Authorizations:

HTTPBearer

query Parameters

datasource_id required	string (Datasource Id) Enum: "mysql" "postgresql" "oracle" "mongodb" "mssql" "mariadb" "vertica" "elasticsearch" "shopify" "facebook ads" "tiktok" "blueprint" "bigquery" "snowflake" "redshift" "boomi_for_sap" Examples: datasource_id=shopify The datasource of the columns.
report_id required	string (Report Id) Examples: report_id=predefined_orders The report id

Responses

Response Schema: application/json

title required	string (Title) The report title.
description required	string (Description) The report description.
properties required	object (Properties) The report fields and metadata.
	Array of Required (strings) or Required (null) (Required) A list of required report fields

US

https://api.rivery.io/v1/predefined_metadata/metadata

EU

https://api.eu-west-1.rivery.io/v1/predefined_metadata/metadata

Response samples

• 200
• 422

Content type

application/json

{

• "title": "my title",
• "description": "report description",
• "properties": { },
• "required": [

  • "id"

  ]

}

Get Source Metadata

This endpoint gets all source metadata.

Authorizations:

HTTPBearer

query Parameters

source_name required

string (Source Name) Enum: "mysql" "postgresql" "oracle" "mongodb" "mssql" "mariadb" "vertica" "elasticsearch" "shopify" "facebook ads" "tiktok" "blueprint" "bigquery" "snowflake" "redshift" "boomi_for_sap" Examples: source_name=shopify The source name

Responses

Response Schema: application/json

title required	string (Title) The datasource title.
description required	string (Description) The datasource description.
properties required	object (Properties) The datasource fields and metadata.
	Array of Required (strings) or Required (null) (Required) A list of required datasource fields

US

https://api.rivery.io/v1/river_source/metadata

EU

https://api.eu-west-1.rivery.io/v1/river_source/metadata

Response samples

• 200
• 422

Content type

application/json

{

• "title": "my title",
• "description": "report description",
• "properties": { },
• "required": [

  • "id"

  ]

}

Get Connections

Authorization scope: connection:list

Get all connection entities as a paginated list

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)

query Parameters

items_per_page	integer (Items Per Page) [ 1 .. 500 ] Default: 20 The number of items per page in the paginated list.
page	integer (Page) >= 1 Default: 1 The current page number in the paginated list.

Responses

Response Schema: application/json

current_page_size required	integer (Current Page Size) The current page size
account_id required	string (Account Id) The account id
environment_id required	string (Environment Id) The environment id
required	Array of objects (Items)
	Next Page (string) or Next Page (null) (Next Page) The next page URL
	Previous Page (string) or Previous Page (null) (Previous Page) The previous page URL
page	integer (Page) Default: 1 The page number
total_items	integer (Total Items) Default: 0 The total number of entities fetched

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/connections

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/connections

Response samples

• 200
• 422

Content type

application/json

{

• "next_page": "string",
• "previous_page": "string",
• "page": 1,
• "current_page_size": 0,
• "total_items": 0,
• "account_id": "string",
• "environment_id": "string",
• "items": [

  • {

    • "account_id": "string",
    • "environment_id": "string",
    • "cross_id": "5f887c764c40e5598f717676",
    • "_id": "5f887c764c40e5598f717676",
    • "connection_name": "test connection",
    • "connection_type": "Oracle",
    • "connection_type_id": "oracle",
    • "is_test_connection": false,
    • "connection_update_by": "5f887c764c40e5598f717676",
    • "connection_update_time": "2019-08-24T14:15:22Z"

    }

  ]

}

Add Connection

Authorization scope: connection:edit

Creates a new connection entity.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)

Request Body schema: application/json

required

object (Connection To Create)

Responses

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/connections

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/connections

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 201
• 422

Content type

application/json

{ }

Update Connection

Authorization scope: connection:edit

This endpoint updates a connection

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
cross_id required	string (Cross Id)

Request Body schema: application/json

required

object (Connection To Update)

Responses

Response Schema: application/json

object (Response Update Connection)

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/connections/{cross_id}

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/connections/{cross_id}

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 200
• 422

Content type

application/json

{ }

Add File

Authorization scope: connection:edit

Uploads a connection file. e.g. a pem file.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
connection_type required	string (Connection Type)

Request Body schema: multipart/form-data

required

file required

string <binary> (File)

Responses

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/connections/{connection_type}/files

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/connections/{connection_type}/files

Response samples

• 201
• 422

Content type

application/json

{

• "file_path": "string"

}