{ "openapi": "3.1.0", "info": { "title": "Boomi Data Integration API", "description": "Download OpenAPI Specification: \u003Ca href='/APIs/dataIntegrationOpenAPISpec.json' target='_blank' download='dataIntegration.json'\u003EDownload\u003C/a\u003E \n\n# Introduction\n\nWelcome to the Data Integration API Documentation. \n\nUsing the Data Integration API, you can automate any single or group operations you perform in the Data Integration console.\nYou can create, execute, and delete Rivers, create DataFrames, automate processes, and more.\nThe Data Integration API is structured around REST. It accepts JSON request bodies, returns JSON responses,\nand employs conventional HTTP response codes, authentication, and verbs to access and use data through HTTP requests. \n\n Refer the [Legacy API](/api/dataintegrationlegacyapi) documentation. \n\n# Authorization\n## Data Integration API Token\nTo generate a Bearer token, please check out [Data Integration on Help Docs](https://help.boomi.com/docs/Atomsphere/Data_Integration/RESTAPI/dataintegration-api-overview).\n\nEvery bearer token is a combination of account, environment, and scopes attached. Every time the token is provided,\nthe API compares its scopes with the request required scope.\nIf the scope is not valid, an insufficient permissions (403) response code returned.\n\n## Scopes\nA scope is defined as a combination of the entity in Data Integration, and the operation allowed to perform on the entity.\n\nThe entity can be any entity available via the API, for example - connection.\nAn operation can be one of specific operations allowed for each scope. For example: list or edit.\nTherefore, listing connections scope will be set as `connection:list`.\nPlease make sure the Bearer token is has the right scopes attached for all of the needed requests.\n", "contact": { "name": "Customer Support", "url": "https://community.boomi.com/s/support", "email": "support@boomi.com" }, "version": "1.0.0", "x-logo": { "url": "https://rivery.io/wp-content/uploads/2021/08/logo.png" } }, "servers": [ { "url": "https://api.rivery.io", "description": "US" }, { "url": "https://api.eu-west-1.rivery.io", "description": "EU" } ], "paths": { "/v1/accounts/{account_id}/environments/{environment_id}/operations/{operation_id}": { "get": { "tags": [ "Operations" ], "summary": "Get Operation Status", "description": "**Authorization scope:** `operations:list` \n \n **For a given asynchronous operation ID, the endpoint returns its status.**", "operationId": "get_operation_status", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "operation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Operation Id" } }, { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/pull_requests/{pull_request_id}/cancel_run": { "post": { "tags": [ "Operations" ], "summary": "Cancel Running Pull Request", "description": "**Authorization scope:** `river:write` \n \n **This endpoint cancels a specific run if run_id is provided or multiple runs if run_group_id is provided.**", "operationId": "cancel_pull_request_run", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "pull_request_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Pull Request Id" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OperationResponse" }, { "type": "null" } ], "title": "Response Cancel Pull Request Run" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/dataframes": { "get": { "tags": [ "Dataframes" ], "summary": "Get Dataframes", "description": "**Authorization scope:** `dataframe:list` \n \n **Get all dataframe entities from the DB**", "operationId": "list_dataframes", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "items_per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "description": "The number of items per page in the paginated list.", "default": 20, "title": "Items Per Page" }, "description": "The number of items per page in the paginated list." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "The current page number in the paginated list.", "default": 1, "title": "Page" }, "description": "The current page number in the paginated list." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataframePaginationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Dataframes" ], "summary": "Add Dataframe", "description": "**Authorization scope:** `dataframe:write` \n \n **Creates a new dataframe entity.**\n****\n**Please note that the Dataframe's name has to be unique**", "operationId": "add_dataframe", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataframeAddInput" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataframeResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/dataframes/{dataframe_name}": { "get": { "tags": [ "Dataframes" ], "summary": "Get Dataframe", "description": "**Authorization scope:** `dataframe:list` \n \n **Get a specific dataframe by name.**", "operationId": "get_dataframe", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "dataframe_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Dataframe Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataframeResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Dataframes" ], "summary": "Delete Dataframe", "description": "**Authorization scope:** `dataframe:write` \n \n **Delete a dataframe.**", "operationId": "delete_dataframe", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "dataframe_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Dataframe Name" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Dataframes" ], "summary": "Update Dataframe", "description": "**Authorization scope:** `dataframe:write` \n \n **Updates an existing dataframe entity. Please note that only the connecting_settings field can be modified**", "operationId": "update_dataframe", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "dataframe_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Dataframe Name" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataframeUpdateInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataframeResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/dataframes/{dataframe_name}/download": { "get": { "tags": [ "Dataframes" ], "summary": "Download Dataframe", "description": "**Authorization scope:** `dataframe:list` \n \n **This endpoint creates a new task for downloading a dataframe.**\n****\n****\n**Be advised: the task is an async operation, which means that**\n**after creating the task, the client must call the endpoint GET**\n**operation in order to get the result.**", "operationId": "download_dataframe", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "dataframe_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Dataframe Name" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/dataframes/{dataframe_name}/clear": { "post": { "tags": [ "Dataframes" ], "summary": "Clear Dataframe Values", "description": "**Authorization scope:** `dataframe:write` \n \n **This endpoint creates an asynchronous operation for clearing the**\n**Dataframe's data.**\n**.**\n****\n**Please note - this is different from deleting the Dataframe,**\n**which deletes both the Dataframe's data and configuration.**", "operationId": "clear_dataframe_values", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "dataframe_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Dataframe Name" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/activities_statistics": { "get": { "tags": [ "Activities" ], "summary": "Get Activities Statistic", "description": "**Authorization scope:** `activity:list` \n \n **Get environment's activity statistics.**\n****\n**The statistics include how many units(RPU) were consumed, and how**\n**many runs ended with each status.**", "operationId": "get_activities_statistic", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "start_time", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "description": "The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm", "examples": [ "2020-01-01T12:00:00" ], "title": "Start Time" }, "description": "The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm" }, { "name": "end_time", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "description": "The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm", "examples": [ "2020-01-01T12:00:00" ], "title": "End Time" }, "description": "The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm" }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ActivityStatusEnum" } }, { "type": "null" } ], "description": "A list of statuses to filter", "title": "Status" }, "description": "A list of statuses to filter" }, { "name": "group_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The ID of the group to filter", "title": "Group Id" }, "description": "The ID of the group to filter" }, { "name": "is_scheduled", "in": "query", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/ScheduleEnum" } ], "description": "A flag that indicates whether the river is scheduled. If not set then activities of all rivers will be returned", "title": "Is Scheduled" }, "description": "A flag that indicates whether the river is scheduled. If not set then activities of all rivers will be returned" }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "description": "Get statistics for rivers that has the search query in their name", "title": "Search" }, "description": "Get statistics for rivers that has the search query in their name" }, { "name": "river_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/RiverTypeInternalEnum" }, { "$ref": "#/components/schemas/RiverTypeEnum" } ] } }, { "type": "null" } ], "description": "The river type", "title": "River Type" }, "description": "The river type" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityStatisticResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/activities_statistics": { "get": { "tags": [ "Activities" ], "summary": "Get River Activities Statistic", "description": "**Authorization scope:** `activity:list` \n \n **Get river's activity statistics (summary).**\n****\n**The statistics include how many units(RPU) were consumed, and how**\n**many runs ended with each status**", "operationId": "get_river_activities_statistic", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } }, { "name": "start_time", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "description": "The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm", "examples": [ "2020-01-01T12:00:00" ], "title": "Start Time" }, "description": "The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm" }, { "name": "end_time", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "description": "The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm", "examples": [ "2020-01-01T12:00:00" ], "title": "End Time" }, "description": "The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm" }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ActivityStatusEnum" } }, { "type": "null" } ], "title": "Status" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiverActivityStatisticResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/activities_targets": { "get": { "tags": [ "Activities" ], "summary": "Get River Activities Targets", "description": "**Authorization scope:** `activity:list` \n \n **Get river's activity targets (table names) in a specific time frame for**\n**specific river and their status.**\n****\n**This endpoint should be used for multi table rivers.**", "operationId": "get_river_activities_targets", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } }, { "name": "start_time", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "description": "The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm", "examples": [ "2020-01-01T12:00:00" ], "title": "Start Time" }, "description": "The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm" }, { "name": "end_time", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "description": "The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm", "examples": [ "2020-01-01T12:00:00" ], "title": "End Time" }, "description": "The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm" }, { "name": "run_group_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by the run group ID", "title": "Run Group Id" }, "description": "Filter by the run group ID" }, { "name": "sub_river_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by the sub river ID", "title": "Sub River Id" }, "description": "Filter by the sub river ID" }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ActivityStatusEnum" } }, { "type": "null" } ], "description": "A list of statuses. Only targets with those statuses will be returned", "title": "Status" }, "description": "A list of statuses. Only targets with those statuses will be returned" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/TargetsSortByEnum" } ], "description": "Indicates by which parameter to sort the targets", "default": "last_run", "title": "Sort By" }, "description": "Indicates by which parameter to sort the targets" }, { "name": "sort_order", "in": "query", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/SortOrderEnum" } ], "default": "desc", "title": "Sort Order" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiverActivityTargetResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/activities_run_groups": { "get": { "tags": [ "Activities" ], "summary": "List River Activities Run Groups", "description": "**Authorization scope:** `activity:list` \n \n **Get list of run groups that occurred in a specific time**\n**frame for specific river and their status.**", "operationId": "list_river_activities_run_groups", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } }, { "name": "start_time", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "description": "The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm", "examples": [ "2020-01-01T12:00:00" ], "title": "Start Time" }, "description": "The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm" }, { "name": "end_time", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "description": "The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm", "examples": [ "2020-01-01T12:00:00" ], "title": "End Time" }, "description": "The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm" }, { "name": "target_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by the target table name", "title": "Target Name" }, "description": "Filter by the target table name" }, { "name": "sub_river_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by the sub river ID", "title": "Sub River Id" }, "description": "Filter by the sub river ID" }, { "name": "status", "in": "query", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RunGroupStatusEnum" }, "description": "A list of statuses. Only run groups with this statuses will be returned.", "title": "Status" }, "description": "A list of statuses. Only run groups with this statuses will be returned." }, { "name": "cache_context_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Cache context id is an internal query parameter for cache purposes", "title": "Cache Context Id" }, "description": "Cache context id is an internal query parameter for cache purposes" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/RunGroupSortByEnum" } ], "default": "last_run", "title": "Sort By" } }, { "name": "sort_order", "in": "query", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/SortOrderEnum" } ], "default": "desc", "title": "Sort Order" } }, { "name": "items_per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Items Per Page" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiverActivityRunGroupResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/activities_run_groups/{run_group_id}": { "get": { "tags": [ "Activities" ], "summary": "Get River Activities Run Groups", "description": "Get a specific run group id", "operationId": "get_river_activities_run_groups", "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } }, { "name": "run_group_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Group Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiverActivityRunGroupWithStatistics" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/activities_sub_rivers": { "get": { "tags": [ "Activities" ], "summary": "Get River Activities Sub Rivers", "description": "**Authorization scope:** `activity:list` \n \n **Get list of sub rivers that ran in a specific time frame.**\n****\n**Additional filters can be added such as target name or run group id.**", "operationId": "get_river_activities_sub_rivers", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } }, { "name": "start_time", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "description": "The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm", "examples": [ "2020-01-01T12:00:00" ], "title": "Start Time" }, "description": "The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm" }, { "name": "end_time", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "description": "The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm", "examples": [ "2020-01-01T12:00:00" ], "title": "End Time" }, "description": "The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm" }, { "name": "target_name", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter by the target table name", "title": "Target Name" }, "description": "Filter by the target table name" }, { "name": "run_group_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Filter by the run group ID", "title": "Run Group Id" }, "description": "Filter by the run group ID" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiverActivitySubRiverResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs": { "get": { "tags": [ "Activities" ], "summary": "Get River Activities Runs", "description": "**Authorization scope:** `activity:list` \n \n **Get list of runs for a specific river in a specific time frame.**\n****\n**This endpoint return information about the runs.**", "operationId": "list_river_activities_runs", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } }, { "name": "start_time", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "description": "The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm", "examples": [ "2020-01-01T12:00:00" ], "title": "Start Time" }, "description": "The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm" }, { "name": "end_time", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "description": "The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm", "examples": [ "2020-01-01T12:00:00" ], "title": "End Time" }, "description": "The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm" }, { "name": "target_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by the target table name", "title": "Target Name" }, "description": "Filter by the target table name" }, { "name": "run_group_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by the run group ID", "title": "Run Group Id" }, "description": "Filter by the run group ID" }, { "name": "sub_river_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Filter by the sub river ID", "title": "Sub River Id" }, "description": "Filter by the sub river ID" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "items_per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 20, "title": "Items Per Page" } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/RunsSortByEnum" } ], "description": "Indicates by which parameter to sort the runs", "default": "start_time", "title": "Sort By" }, "description": "Indicates by which parameter to sort the runs" }, { "name": "sort_order", "in": "query", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/SortOrderEnum" } ], "default": "desc", "title": "Sort Order" } }, { "name": "cache_context_id", "in": "query", "required": false, "schema": { "type": "string", "description": "Cache context id is an internal query parameter for cache purposes", "title": "Cache Context Id" }, "description": "Cache context id is an internal query parameter for cache purposes" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiverActivityRunsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs/{run_id}": { "get": { "tags": [ "Activities" ], "summary": "Get River Activities Run", "description": "**Authorization scope:** `activity:list` \n \n **Get a specific run details.**", "operationId": "get_river_activities_run", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } }, { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiverActivityRun" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs/{run_id}/tasks": { "get": { "tags": [ "Activities" ], "summary": "Get River Activities Run Tasks", "description": "**Authorization scope:** `activity:list` \n \n **Get river's activity specific run tasks.**\n****\n**Each run may have multiple tasks. This endpoint returns those tasks**\n**details.**", "operationId": "get_river_activities_run_tasks", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } }, { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiverActivityRunTasksResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs/{run_id}/logic_steps": { "get": { "tags": [ "Activities" ], "summary": "Get River Activities Run Logic Steps", "description": "**Authorization scope:** `activity:list` \n \n **Get the status of each logic step for a specific run.**", "operationId": "get_river_activities_run_logic_steps", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } }, { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiverActivityRunLogicStepsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs/{run_id}/variables": { "get": { "tags": [ "Activities" ], "summary": "Get Activities Logic Variables", "description": "**Authorization scope:** `activity:list` \n \n **This endpoint retrieves the values of the logic variables in a specific run.**\n**The values are stored for a short period of time and will expire after that time.**\n**If the values have expired, an error message will be returned.**", "operationId": "get_activities_logic_variables", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } }, { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityLogicVariableResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs/{run_id}/logic_steps/{step_id}/logs": { "get": { "tags": [ "Activities" ], "summary": "Get Activities Logic Step Log", "description": "**Authorization scope:** `activity:list` \n \n **Get the logs of a python logic step.**", "operationId": "get_activities_logic_step_log", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } }, { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "step_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Step Id" } }, { "name": "iteration_number", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "The step iteration number", "default": 0, "title": "Iteration Number" }, "description": "The step iteration number" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiverActivityRunLogicStepsLogsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/activities": { "get": { "tags": [ "Activities" ], "summary": "Get Activities", "description": "**Authorization scope:** `activity:list` \n \n **Get summary of activities for the account and environment summarized by**\n**river.**", "operationId": "get_activities", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "start_time", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "description": "The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm", "examples": [ "2020-01-01T12:00:00" ], "title": "Start Time" }, "description": "The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm" }, { "name": "end_time", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time", "description": "The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm", "examples": [ "2020-01-01T12:00:00" ], "title": "End Time" }, "description": "The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm" }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ActivityStatusEnum" } }, { "type": "null" } ], "title": "Status" } }, { "name": "group_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The ID of the group to filter", "title": "Group Id" }, "description": "The ID of the group to filter" }, { "name": "is_scheduled", "in": "query", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/ScheduleEnum" } ], "description": "A flag that indicates whether the river is scheduled. If not set then activities of all rivers will be returned", "title": "Is Scheduled" }, "description": "A flag that indicates whether the river is scheduled. If not set then activities of all rivers will be returned" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "items_per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 20, "title": "Items Per Page" } }, { "name": "cache_context_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cache context id is an internal query parameter for cache purposes", "title": "Cache Context Id" }, "description": "Cache context id is an internal query parameter for cache purposes" }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "description": "Search for a specific river by river name", "title": "Search" }, "description": "Search for a specific river by river name" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/ActivitySortByEnum" } ], "default": "last_run", "title": "Sort By" } }, { "name": "sort_order", "in": "query", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/SortOrderEnum" } ], "default": "desc", "title": "Sort Order" } }, { "name": "river_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/RiverTypeInternalEnum" }, { "$ref": "#/components/schemas/RiverTypeEnum" } ] } }, { "type": "null" } ], "description": "The river type", "title": "River Type" }, "description": "The river type" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivitiesResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/runs/{run_id}/logs": { "get": { "tags": [ "Activities" ], "summary": "Get Run Logs", "description": "**Authorization scope:** `activity:list` \n \n **This method fetches the logs for a given run id of a river.**", "operationId": "get_run_logs", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } }, { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "additional_services", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/NewRelicServicesEnum" } }, { "type": "null" } ], "description": "Additional services to query", "title": "Additional Services" }, "description": "Additional services to query" } ], "responses": { "200": { "description": "Successful Response", "content": { "text/html": { "schema": { "type": "string" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/versions": { "get": { "tags": [ "Rivers" ], "summary": "List River Versions", "description": "**Authorization scope:** `river:list` \n \n **This endpoint returns all river versions for a given river_cross_id.**", "operationId": "list_river_versions", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } }, { "name": "items_per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "description": "The number of items per page in the paginated list.", "default": 20, "title": "Items Per Page" }, "description": "The number of items per page in the paginated list." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "The current page number in the paginated list.", "default": 1, "title": "Page" }, "description": "The current page number in the paginated list." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiverVersionsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/versions/{version_id}": { "get": { "tags": [ "Rivers" ], "summary": "Get River Version", "description": "**Authorization scope:** `river:list` \n \n **This endpoint returns a given version for a version id and river_cross_id.**", "operationId": "get_river_version", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } }, { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Version Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiverVersions" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/rivers": { "post": { "tags": [ "Rivers" ], "summary": "Add River", "description": "**Authorization scope:** `river:write` \n \n **This endpoint creates a river.**", "operationId": "add_river", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "River Cross Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WriteRiverInput" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiverModel" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Rivers" ], "summary": "List Rivers", "description": "**Authorization scope:** `river:list` \n \n **This endpoint gets a summary of all the rivers in an environment**", "operationId": "list_rivers", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "The current page number in the paginated list.", "default": 1, "title": "Page" }, "description": "The current page number in the paginated list." }, { "name": "items_per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "description": "The number of items per page in the paginated list.", "default": 20, "title": "Items Per Page" }, "description": "The number of items per page in the paginated list." }, { "name": "group_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The river group name", "title": "Group Name" }, "description": "The river group name" }, { "name": "group_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The river group id", "examples": [ [ "5f5b17b0a10e07a4ff4c33" ] ], "title": "Group Id" }, "description": "The river group id" }, { "name": "name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The river name", "title": "Name" }, "description": "The river name" }, { "name": "schedule", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RiverScheduleStatusEnum" }, { "type": "null" } ], "description": "The river schedule status", "title": "Schedule" }, "description": "The river schedule status" }, { "name": "river_status", "in": "query", "required": false, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RiverStatusEnum" }, "description": "The river status", "examples": [ [ "active" ] ], "default": [], "title": "River Status" }, "description": "The river status" }, { "name": "interface_type", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RiverInterfaceEnum" }, { "type": "null" } ], "description": "The rivers interface type", "title": "Interface Type" }, "description": "The rivers interface type" }, { "name": "include_deleted", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Deleted" } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/ListRiversSortByFilterEnum" } ], "description": "The river sort by filter", "default": "last_updated_at", "title": "Sort By" }, "description": "The river sort by filter" }, { "name": "sort_order", "in": "query", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/SortOrderEnum" } ], "description": "The river sort order filter", "default": "desc", "title": "Sort Order" }, "description": "The river sort order filter" }, { "name": "river_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/RiverTypeInternalEnum" }, { "$ref": "#/components/schemas/RiverTypeEnum" } ] } }, { "type": "null" } ], "description": "The river type", "title": "River Type" }, "description": "The river type" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiverListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}": { "put": { "tags": [ "Rivers" ], "summary": "Edit River", "description": "**Authorization scope:** `river:write` \n \n **This endpoint updates a river.**", "operationId": "edit_river", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WriteRiverInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiverModel" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Rivers" ], "summary": "Delete River", "description": "**Authorization scope:** `river:write` \n \n **This endpoint deletes a river**", "operationId": "delete_river", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Rivers" ], "summary": "Get River", "description": "**Authorization scope:** `river:list` \n \n **This endpoint gets a river.**", "operationId": "get_river", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiverModel" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/copy": { "post": { "tags": [ "Rivers" ], "summary": "Copy River", "description": "**Authorization scope:** `river:write` \n \n **This endpoint creates a copy of a river**", "operationId": "copy_river", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } } ], "responses": { "201": { "description": "River was copied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CopyRiverResponse" } } }, "headers": { "Location": { "description": "The location of the created resource", "schema": { "type": "string" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/restore": { "put": { "tags": [ "Rivers" ], "summary": "Restore River Version", "description": "**Authorization scope:** `river:write` \n \n **This endpoint restores a river to a specific version**", "operationId": "restore_river", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestoreRiverVersionInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiverModel" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/enable_cdc": { "post": { "tags": [ "Rivers" ], "summary": "Enable Cdc", "description": "**Authorization scope:** `river:write` \n \n **This endpoint enables the CDC extraction for a CDC river.**", "operationId": "enable_cdc", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OperationResponse" }, { "type": "null" } ], "title": "Response Enable Cdc" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/disable_cdc": { "post": { "tags": [ "Rivers" ], "summary": "Disable Cdc", "description": "**Authorization scope:** `river:write` \n \n **This endpoint disables the CDC extraction for a CDC river.**", "operationId": "disable_cdc", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OperationResponse" }, { "type": "null" } ], "title": "Response Disable Cdc" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/cdc_config": { "get": { "tags": [ "Rivers" ], "summary": "Get Cdc Config", "description": "**Authorization scope:** `river:list` \n \n **This endpoint gets the cdc config:**\n*** Gets cdc offset by provided datasource type to see the last position of the cdc**\n*** For SQL Server LSN offsets, if a dictionary of LSNs is provided, returns the minimum LSN value**\n****\n**Raises:**\n**HTTPException: 400 if no offsets found**\n**INTERNAL_SERVICE_ERROR_EXCEPTION: For all other errors (including invalid LSN format,**\n**Pydantic validation errors, etc.).**\n**Error details will be logged.**", "operationId": "get_cdc_config_limit_scope", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CdcConfig" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Rivers" ], "summary": "Delete Cdc Config", "description": "**Authorization scope:** `river:write` \n \n **This endpoint delete the cdc config:**", "operationId": "delete_cdc_config", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Rivers" ], "summary": "Set Cdc Config", "description": "**Authorization scope:** `river:write` \n \n **This endpoint set the cdc config:**\n****\n*** Set the cdc offset that next run of the river can continue from specific position**", "operationId": "set_cdc_config_limit_scope", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CdcConfig" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/activate_river": { "post": { "tags": [ "Rivers" ], "summary": "Activate River", "description": "**Authorization scope:** `river:write` \n \n **This endpoint activates a river for allowing it to run.**", "operationId": "activate_river", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OperationResponse" }, { "type": "null" } ], "title": "Response Activate River" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/disable_river": { "post": { "tags": [ "Rivers" ], "summary": "Disable River", "description": "**Authorization scope:** `river:write` \n \n **This endpoint disables a river to forbid it from running.**", "operationId": "disable_river", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/OperationResponse" }, { "type": "null" } ], "title": "Response Disable River" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/rivers_search": { "get": { "tags": [ "Rivers" ], "summary": "Rivers Search", "description": "**Authorization scope:** `river:list` \n \n **This endpoint searches for rivers for a specific account_id and environment_id, pagination is supported**", "operationId": "search_river", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "The current page number in the paginated list.", "default": 1, "title": "Page" }, "description": "The current page number in the paginated list." }, { "name": "items_per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "description": "The number of items per page in the paginated list.", "default": 20, "title": "Items Per Page" }, "description": "The number of items per page in the paginated list." }, { "name": "group_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "The river group id", "examples": [ [ "5f5b17b0a10e07a4ff4c33" ] ], "title": "Group Id" }, "description": "The river group id" }, { "name": "schedule", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RiverScheduleStatusEnum" }, { "type": "null" } ], "description": "The river schedule status", "title": "Schedule" }, "description": "The river schedule status" }, { "name": "river_status", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RiverSearchStatusEnum" }, { "type": "null" } ], "description": "The river status", "title": "River Status" }, "description": "The river status" }, { "name": "interface_type", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RiverInterfaceEnum" }, { "type": "null" } ], "description": "Classic or API V2", "title": "Interface Type" }, "description": "Classic or API V2" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/RiverSearchSortByEnum" } ], "description": "The river sort by filter", "default": "river_date_updated", "title": "Sort By" }, "description": "The river sort by filter" }, { "name": "sort_order", "in": "query", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/SortOrderEnum" } ], "description": "The river sort order filter", "default": "desc", "title": "Sort Order" }, "description": "The river sort order filter" }, { "name": "search_query", "in": "query", "required": false, "schema": { "type": "string", "title": "Search Query" } }, { "name": "name", "in": "query", "required": false, "schema": { "type": "string", "title": "Name" } }, { "name": "river_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/RiverTypeInternalEnum" }, { "$ref": "#/components/schemas/RiverTypeEnum" } ] } }, { "type": "null" } ], "description": "The river type", "title": "River Type" }, "description": "The river type" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiverSearchResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/cancel_run": { "post": { "tags": [ "Rivers" ], "summary": "Cancel River Run", "description": "**Authorization scope:** `river:execute` \n \n **This endpoint cancels a specific run if run_id is provided or multiple runs if run_group_id is provided.**", "operationId": "cancel_river_run", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelRiverRunBody" } } } }, "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneralResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/run": { "post": { "tags": [ "Rivers" ], "summary": "Run River", "description": "**Authorization scope:** `river:execute` \n \n **This endpoint runs a river.**\n****\n**Throttling rules:**\n*** River can be executed up to 2 times per minute**\n*** Each user can execute a river up to 15 times per minute**", "operationId": "run_river", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } }, { "name": "run_sub_rivers", "in": "query", "required": false, "schema": { "type": "boolean", "description": "A flag that indicates whether to run all active sub rivers of the master river", "default": false, "title": "Run Sub Rivers" }, "description": "A flag that indicates whether to run all active sub rivers of the master river" } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiversRunResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/sub_rivers/{sub_river_id}/run": { "post": { "tags": [ "Rivers" ], "summary": "Run Sub River", "description": "**Authorization scope:** `river:execute` \n \n **This endpoint runs a sub_river.**", "operationId": "run_sub_river", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } }, { "name": "sub_river_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Sub River Id" } } ], "responses": { "202": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiversRunResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/variables": { "put": { "tags": [ "Rivers" ], "summary": "Update River Variable", "description": "**Authorization scope:** `river:write` \n \n **This endpoint updates a variable for a river.**\n**Given a list of variables, it will replace all existing variables for the logic river with the provided list.**", "operationId": "update_river_variable", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } }, { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "items_per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "description": "The number of items per page in the paginated list.", "default": 20, "title": "Items Per Page" }, "description": "The number of items per page in the paginated list." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "The current page number in the paginated list.", "default": 1, "title": "Page" }, "description": "The current page number in the paginated list." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRiverVariableInputList" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiverVariablesPaginatedResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Rivers" ], "summary": "Get River Variables", "description": "**Authorization scope:** `river:list` \n \n **Get all river variables**", "operationId": "get_river_variables", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "river_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "River Cross Id" } }, { "name": "items_per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "description": "The number of items per page in the paginated list.", "default": 20, "title": "Items Per Page" }, "description": "The number of items per page in the paginated list." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "The current page number in the paginated list.", "default": 1, "title": "Page" }, "description": "The current page number in the paginated list." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiverVariablesPaginatedResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments": { "get": { "tags": [ "Environments" ], "summary": "List Environments", "description": "**Authorization scope:** `environment:list` \n \n **Get list of environments entities for an account**", "operationId": "list_environments", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "include_deleted", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Deleted" } }, { "name": "is_deployable_environments", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Is Deployable Environments" } }, { "name": "items_per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "description": "The number of items per page in the paginated list.", "default": 20, "title": "Items Per Page" }, "description": "The number of items per page in the paginated list." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "The current page number in the paginated list.", "default": 1, "title": "Page" }, "description": "The current page number in the paginated list." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListEnvironmentsPaginationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Environments" ], "summary": "Add Environment", "description": "**Authorization scope:** `environment:edit` \n \n **Creates a new environment entity**", "operationId": "add_environment", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentInput" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsFields" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}": { "get": { "tags": [ "Environments" ], "summary": "Get Environment", "description": "**Authorization scope:** `environment:list` \n \n **Get a specific environment**", "operationId": "get_environment", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsFields" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Environments" ], "summary": "Patch Environment", "description": "**Authorization scope:** `environment:edit` \n \n **Updates an existing environment entity**", "operationId": "patch_environment", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchEnvironmentInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvironmentsFields" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Environments" ], "summary": "Delete Environment", "description": "**Authorization scope:** `environment:delete` \n \n **Delete Environment**", "operationId": "delete_environment", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OperationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/scim_provisioning": { "put": { "tags": [ "Accounts" ], "summary": "Add Or Update Scim Provisioning", "description": "**Authorization scope:** `account:write` \n \n **Add or update SCIM provisioning.**\n**This endpoint returns the connection string used to communicate with your SCIM app and the authentication token**", "operationId": "create_or_update_scim_provisioning", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrUpdateScimTokenResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Accounts" ], "summary": "Delete Scim Provisioning", "description": "**Authorization scope:** `account:write` \n \n **Deletes the scim provisioning. This endpoint won't delete any existing resource that were already sync by the SCIM.**", "operationId": "delete_scim_provisioning", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Accounts" ], "summary": "Get Scim Provisioning Status", "description": "**Authorization scope:** `account:write` \n \n **Get SCIM provisioning status**", "operationId": "get_scim_provisioning_status", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetScimTokenStatusResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/users": { "get": { "tags": [ "Users" ], "summary": "List Users", "description": "**Authorization scope:** `user:list` \n \n **List users**", "operationId": "list_users", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "email", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Query parameter for filtering by email", "title": "Email" }, "description": "Query parameter for filtering by email" }, { "name": "name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Query parameter for filtering name in email or user name", "title": "Name" }, "description": "Query parameter for filtering name in email or user name" }, { "name": "team_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Query parameter for filtering by team id", "title": "Team Id" }, "description": "Query parameter for filtering by team id" }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "items_per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "default": 20, "title": "Items Per Page" } }, { "name": "sort_by", "in": "query", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/UsersSortByEnum" } ], "default": "created_at", "title": "Sort By" } }, { "name": "sort_order", "in": "query", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/SortOrderEnum" } ], "default": "desc", "title": "Sort Order" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListUsersResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/users/{user_id}": { "get": { "tags": [ "Users" ], "summary": "Get User", "description": "**Authorization scope:** `user:list` \n \n **Get user by id**", "operationId": "get_user", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserModel" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "Users" ], "summary": "Patch User", "description": "**Authorization scope:** `user:edit` \n \n **Update user source**", "operationId": "patch_user", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchUserInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserModel" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/users/{user_id}/permissions": { "get": { "tags": [ "Users" ], "summary": "Get User Permissions", "description": "Get user permissions", "operationId": "get_user_permissions", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPermissionsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/users/{user_id}/source": { "post": { "tags": [ "Users" ], "summary": "Update User Source", "description": "**Authorization scope:** `user:edit` \n \n **Update user source**", "operationId": "update_user_source", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" } }, { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserUpdateSourceInput" } } } }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/users/{user_id}/active_user": { "patch": { "tags": [ "Users" ], "summary": "Patch Active User", "description": "**Authorization scope:** `user:list` \n \n **Patch user active**", "operationId": "patch_active_user", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchActiveUserInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserModel" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/users/invite_user": { "post": { "tags": [ "Users" ], "summary": "Invite User", "description": "**Authorization scope:** `user:edit` \n \n **Invite new user**\n**1. Create new user with temp password**\n**2. Send email with redirect url that includes the password inside the token**", "operationId": "invite_user", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InviteUserInput" } } } }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/users/re_invite_user": { "post": { "tags": [ "Users" ], "summary": "Re Invite User", "description": "**Authorization scope:** `user:edit` \n \n **Re Invite user**", "operationId": "re_invite_user", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReInviteUserInput" } } } }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/users/{user_id}/delete_user": { "delete": { "tags": [ "Users" ], "summary": "Delete User From Account", "description": "**Authorization scope:** `user:list` \n \n **Delete user from specific account**", "operationId": "delete_user_from_account", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string", "title": "User Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/audit_events": { "get": { "tags": [ "Audit Events" ], "summary": "List Audit Events", "description": "**Authorization scope:** `audit:list` \n \n **List audit events**", "operationId": "list_audit_events", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "start_time", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm", "examples": [ "2020-01-01T12:00:00" ], "title": "Start Time" }, "description": "The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm" }, { "name": "end_time", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm If end_time is supplied without start_time the start_time will be the previous day of the end_time", "examples": [ "2020-01-01T12:00:00" ], "title": "End Time" }, "description": "The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm If end_time is supplied without start_time the start_time will be the previous day of the end_time" }, { "name": "user_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "A list of users id's who initiated the event", "examples": [ "5eda28ee6b028e1ce7a2b5ed" ], "title": "User Id" }, "description": "A list of users id's who initiated the event" }, { "name": "event_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/AuditEventTypeEnum" } }, { "type": "null" } ], "description": "A list of entity types", "examples": [ "connections", "rivers", "river_groups" ], "title": "Event Type" }, "description": "A list of entity types" }, { "name": "entity_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/AuditEntityTypeEnum" } }, { "type": "null" } ], "description": "A list of event types", "examples": [ "delete", "create", "update" ], "title": "Entity Type" }, "description": "A list of event types" }, { "name": "entity_logical_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A unique logical identifier of an entity, usually the cross_id", "examples": [ "5eda28ee6b028e1ce7a2b5ec" ], "title": "Entity Logical Key" }, "description": "A unique logical identifier of an entity, usually the cross_id" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditEventsPaginationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/audit_events/{event_id}": { "get": { "tags": [ "Audit Events" ], "summary": "Get Audit Event", "description": "**Authorization scope:** `audit:list` \n \n **Get a specific audit event by event_id.**", "operationId": "get_audit_event", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "event_id", "in": "path", "required": true, "schema": { "type": "string", "description": "The id of the audit event", "examples": [ "eac285a5a9ae4ada9ccd49889a651e16" ], "title": "Event Id" }, "description": "The id of the audit event" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditEventsResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/connections": { "get": { "tags": [ "Connections" ], "summary": "Get Connections", "description": "**Authorization scope:** `connection:list` \n \n **Get all connection entities as a paginated list**", "operationId": "list_connections", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "items_per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "description": "The number of items per page in the paginated list.", "default": 20, "title": "Items Per Page" }, "description": "The number of items per page in the paginated list." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "The current page number in the paginated list.", "default": 1, "title": "Page" }, "description": "The current page number in the paginated list." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionPaginationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Connections" ], "summary": "Add Connection", "description": "**Authorization scope:** `connection:edit` \n \n **Creates a new connection entity.**", "operationId": "add_connection", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "title": "Connection To Create" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "title": "Response Add Connection" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/connections/{cross_id}": { "put": { "tags": [ "Connections" ], "summary": "Update Connection", "description": "**Authorization scope:** `connection:edit` \n \n **This endpoint updates a connection**", "operationId": "update_connection", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Cross Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "title": "Connection To Update" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "type": "object", "title": "Response Update Connection" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/connections/{connection_cross_id}": { "delete": { "tags": [ "Connections" ], "summary": "Delete Connection", "description": "**Authorization scope:** `connection:delete` \n \n **This endpoint deletes a connection**", "operationId": "delete_connection", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "connection_cross_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Connection Cross Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/connections/{connection_type}/files": { "post": { "tags": [ "Connections" ], "summary": "Add File", "description": "**Authorization scope:** `connection:edit` \n \n **Uploads a connection file. e.g. a pem file.**", "operationId": "add_file", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "connection_type", "in": "path", "required": true, "schema": { "type": "string", "title": "Connection Type" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_add_file" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddConnectionFileResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/connections_types": { "get": { "tags": [ "Connections" ], "summary": "Get Connections Types", "description": "**Authorization scope:** `connection:list` \n \n **Get all connection types entities as a paginated list**", "operationId": "list_connections_types", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "items_per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 500, "minimum": 1, "description": "The number of items per page in the paginated list.", "default": 20, "title": "Items Per Page" }, "description": "The number of items per page in the paginated list." }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "description": "The current page number in the paginated list.", "default": 1, "title": "Page" }, "description": "The current page number in the paginated list." } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionTypesPaginationResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/connections_types/{connection_type}": { "get": { "tags": [ "Connections" ], "summary": "Get Connection Type", "description": "**Authorization scope:** `connection:list` \n \n **Get a specific connection type entity**", "operationId": "get_connection_type", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "connection_type", "in": "path", "required": true, "schema": { "type": "string", "title": "Connection Type" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionTypeModel" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/environments/{environment_id}/variables": { "get": { "tags": [ "Variables" ], "summary": "List Variables", "description": "**Authorization scope:** `variables:list` \n \n **List variables**", "operationId": "list_variables", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariablesResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Variables" ], "summary": "Add Or Update Variables", "description": "**Authorization scope:** `variables:edit` \n \n **Add new variable or update existing one for environment**", "operationId": "add_or_update_variables", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddOrPatchVariablesInput" } } } }, "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariablesResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Variables" ], "summary": "Delete Variable", "description": "**Authorization scope:** `variables:edit` \n \n **Delete existing variables by environment**", "operationId": "delete_variable", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "environment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Environment Id" } }, { "name": "variable_key", "in": "query", "required": true, "schema": { "type": "string", "title": "Variable Key" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/teams": { "get": { "tags": [ "Teams" ], "summary": "List Teams", "description": "**Authorization scope:** `team:list` \n \n **Get all user teams**", "operationId": "list_teams", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "default": 1, "title": "Page" } }, { "name": "items_per_page", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "default": 20, "title": "Items Per Page" } }, { "name": "display_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The internal display name of the team", "examples": [ "Marketing team" ], "title": "Display Name" }, "description": "The internal display name of the team" }, { "name": "source", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The team source local (rivery) or external (Active Directory)", "examples": [ "rivery" ], "title": "Source" }, "description": "The team source local (rivery) or external (Active Directory)" }, { "name": "remote_display_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The remote display name of the team", "examples": [ "Core team" ], "title": "Remote Display Name" }, "description": "The remote display name of the team" }, { "name": "sort_by", "in": "query", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/TeamsSortByEnum" } ], "description": "Sorted the results by attributes", "default": "display_name", "title": "Sort By" }, "description": "Sorted the results by attributes" }, { "name": "sort_order", "in": "query", "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/SortOrderEnum" } ], "default": "desc", "title": "Sort Order" } }, { "name": "team_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "List of team ids", "examples": [ [ "65ce173412f5e196b2b9b163" ] ], "title": "Team Id" }, "description": "List of team ids" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserTeamsListResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/accounts/{account_id}/teams/{team_id}": { "get": { "tags": [ "Teams" ], "summary": "Get Team", "description": "**Authorization scope:** `team:list` \n \n **Get user team by id**", "operationId": "get_team", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } }, { "name": "team_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Team Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserTeamsModel" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "Teams" ], "summary": "Patch Team", "description": "**Authorization scope:** `team:write` \n \n **Patch team by id**", "operationId": "patch_team", "security": [ { "HTTPBearer": [] } ], "parameters": [ { "name": "team_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Team Id" } }, { "name": "account_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Account Id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchUserTeamsInput" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserTeamsModel" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "ActionProperties": { "properties": { "properties_type": { "const": "actions", "title": "Properties Type", "default": "actions" } }, "additionalProperties": false, "type": "object", "title": "ActionProperties", "description": "Action properties which define the action river properties" }, "ActionStep": { "properties": { "name": { "type": "string", "title": "Name" }, "is_enabled": { "type": "boolean", "title": "Is Enabled", "description": "A flag that indicates whether the step is enabled or not", "default": true }, "step_id": { "type": "string", "title": "Step Id", "description": "The step id", "examples": [ "76e0f1a623b444338778a189b1386126" ] }, "disable_errors": { "type": "boolean", "title": "Disable Errors", "description": "A flag that indicates whether to disable errors or not", "default": false }, "type": { "const": "action", "title": "Type" }, "action_id": { "type": "string", "title": "Action Id" }, "input_variables": { "type": "object", "title": "Input Variables", "examples": [ { "param1": "value1" } ] }, "output_variables": { "type": "object", "title": "Output Variables", "examples": [ { "param1": "value1" } ] }, "interval_variables": { "type": "object", "title": "Interval Variables", "examples": [ { "start_date": "2021-01-01" } ] }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Id", "description": "The action connection id" } }, "type": "object", "required": [ "name", "type", "action_id" ], "title": "ActionStep", "description": "Action step schema" }, "ActionTaskProperties": { "properties": { "duration": { "type": "integer", "title": "Duration", "description": "The duration of the task in milliseconds", "examples": [2000] }, "error_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Description", "description": "The error description if any", "examples": [ "error" ] }, "start_date_utc": { "type": "string", "format": "date-time", "title": "Start Date Utc", "description": "The start date time in UTC timezone.Time format YYYY-MM-DDThh:mm:ss.ms", "examples": [ "2022-07-25T18:38:55.640Z" ] }, "start_date_in_milliseconds": { "type": "integer", "title": "Start Date In Milliseconds", "description": "The start epoch in milliseconds.", "examples": [1658774335000] }, "end_date_utc": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Date Utc", "description": "The end date time in UTC timezone.Time format YYYY-MM-DDThh:mm:ss.ms", "examples": [ "2022-07-25T18:38:55.640Z" ] }, "end_date_in_milliseconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "End Date In Milliseconds", "description": "The end epoch in milliseconds.", "examples": [1658774335000] }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source", "description": "The name of the source.", "examples": [ "Google Ads" ] }, "task_id": { "type": "string", "title": "Task Id", "description": "The ID of the task", "examples": [ "6a23130732304020886bf5f8bfcecfbc" ] }, "task_name": { "type": "string", "title": "Task Name", "description": "The name of the task", "examples": [ "Google Ads To Amazon S3" ] }, "task_status": { "allOf": [ { "$ref": "#/components/schemas/ActivityStatusEnum" } ], "description": "The status of the task", "examples": [ "succeeded" ] }, "task_type": { "const": "actions", "title": "Task Type" }, "response_details": { "anyOf": [ { "items": { }, "type": "array" }, { "type": "object" }, { "type": "null" } ], "title": "Response Details", "description": "Response details for action/rest rivers" } }, "type": "object", "required": [ "duration", "error_description", "start_date_utc", "start_date_in_milliseconds", "end_date_utc", "end_date_in_milliseconds", "task_id", "task_name", "task_status", "task_type" ], "title": "ActionTaskProperties", "description": "Action river properties" }, "ActivitiesResponse": { "properties": { "next_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Page", "description": "The next page URL" }, "previous_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Page", "description": "The previous page URL" }, "page": { "type": "integer", "title": "Page", "description": "The page number", "default": 1 }, "current_page_size": { "type": "integer", "title": "Current Page Size", "description": "The current page size" }, "total_items": { "type": "integer", "title": "Total Items", "description": "The total number of entities fetched", "default": 0 }, "account_id": { "type": "string", "title": "Account Id", "description": "The account id" }, "environment_id": { "type": "string", "title": "Environment Id", "description": "The environment id" }, "items": { "items": { "$ref": "#/components/schemas/Activity" }, "type": "array", "title": "Items" }, "cache_context_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cache Context Id" } }, "type": "object", "required": [ "current_page_size", "account_id", "environment_id", "items", "cache_context_id" ], "title": "ActivitiesResponse", "description": "General activities response" }, "Activity": { "properties": { "account_id": { "type": "string", "title": "Account Id" }, "environment_id": { "type": "string", "title": "Environment Id" }, "cross_id": { "type": "string", "title": "Cross Id" }, "river_id": { "type": "string", "title": "River Id" }, "master_river_id": { "type": "string", "title": "Master River Id" }, "river_name": { "type": "string", "title": "River Name" }, "is_sub_river": { "type": "boolean", "title": "Is Sub River" }, "is_master_river": { "type": "boolean", "title": "Is Master River" }, "is_multi": { "type": "boolean", "title": "Is Multi" }, "is_deleted": { "type": "boolean", "title": "Is Deleted" }, "group_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Group Id" }, "is_scheduled": { "type": "boolean", "title": "Is Scheduled" }, "total_files": { "type": "integer", "title": "Total Files" }, "units": { "type": "number", "title": "Units", "description": "Total RPU (units)", "examples": [2.1] }, "rpu": { "type": "number", "title": "Rpu", "description": "Total RPU", "examples": [2.1] }, "total_size": { "type": "integer", "title": "Total Size" }, "last_run": { "type": "integer", "title": "Last Run" }, "pending": { "type": "integer", "title": "Pending" }, "failed": { "type": "integer", "title": "Failed" }, "running": { "type": "integer", "title": "Running" }, "succeeded": { "type": "integer", "title": "Succeeded" }, "canceled": { "type": "integer", "title": "Canceled" }, "datasource_id": { "type": "string", "title": "Datasource Id" } }, "type": "object", "required": [ "account_id", "environment_id", "cross_id", "river_id", "master_river_id", "river_name", "is_sub_river", "is_master_river", "is_multi", "is_deleted", "is_scheduled", "total_files", "units", "rpu", "total_size", "last_run", "pending", "failed", "running", "succeeded", "canceled", "datasource_id" ], "title": "Activity", "description": "Activity properties to return." }, "ActivityLogicVariableResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/RiverVariablesFields" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "items" ], "title": "ActivityLogicVariableResponse", "description": "The activities logic variables response" }, "ActivitySortByEnum": { "type": "string", "enum": [ "river_name", "last_run", "units" ], "title": "ActivitySortByEnum", "description": "Activities sort properties in the UI." }, "ActivityStatisticResponse": { "properties": { "account_id": { "type": "string", "title": "Account Id" }, "environment_id": { "type": "string", "title": "Environment Id" }, "total_units": { "type": "number", "title": "Total Units", "description": "Total RPU (units)", "examples": [2.1] }, "total_rpu": { "type": "number", "title": "Total Rpu", "description": "Total RPU", "examples": [2.1] }, "running": { "type": "integer", "title": "Running" }, "canceled": { "type": "integer", "title": "Canceled" }, "pending": { "type": "integer", "title": "Pending" }, "failed": { "type": "integer", "title": "Failed" }, "succeeded": { "type": "integer", "title": "Succeeded" }, "skipped": { "type": "integer", "title": "Skipped" } }, "type": "object", "required": [ "account_id", "environment_id", "total_units", "total_rpu", "running", "canceled", "pending", "failed", "succeeded", "skipped" ], "title": "ActivityStatisticResponse", "description": "Activity statistics response" }, "ActivityStatusEnum": { "type": "string", "enum": [ "pending", "canceled", "succeeded", "failed", "running", "skipped" ], "title": "ActivityStatusEnum", "description": "The external status of a run (being used in the api)" }, "AddConnectionFileResponse": { "properties": { "file_path": { "type": "string", "title": "File Path" } }, "type": "object", "required": [ "file_path" ], "title": "AddConnectionFileResponse", "description": "Add connection file response" }, "AddOrPatchVariablesInput": { "properties": { "variables": { "type": "object", "title": "Variables" } }, "type": "object", "required": [ "variables" ], "title": "AddOrPatchVariablesInput", "description": "Variables input" }, "AthenaModifiedColumn": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the column is selected and should be modified.", "examples": [true] }, "name": { "type": "string", "title": "Name", "description": "The name of the column.", "examples": [ "column_name" ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type", "description": "The type of the column.", "examples": [ "string" ] }, "alias": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Alias", "description": "The alias of the column in the target table.", "examples": [ "column_alias" ] }, "expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expression", "description": "This tells us the column is an expression or not so we know if it suppose to exist in the source / target or is it auto generated.", "examples": [ "select 'test'" ] }, "is_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Key", "description": "If the column is a key.", "examples": [true] }, "cluster_key": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cluster Key", "description": "The sort order of the column (number) in the cluster, used in the merge process to determine the order of the merge keys.", "examples": [1] }, "calculated_column_mode": { "anyOf": [ { "$ref": "#/components/schemas/CalculatedColumnModeEnum" }, { "type": "null" } ], "description": "The mode of the calculated column.Help to identify if the column is source expression or target expression,required if the column is an expression.", "examples": [ "source" ] }, "order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Order", "description": "The order of the column in the expression,required if the column is an expression.", "examples": [1] }, "mode": { "anyOf": [ { "$ref": "#/components/schemas/ColumnModeEnum" }, { "type": "null" } ], "description": "The mode of the column in the target table" }, "is_rivery_metadata": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Rivery Metadata", "description": "Whether the column includes rivery metadata" }, "is_partition": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Partition", "description": "Indication if the column is a partition column", "default": false }, "target_type": { "const": "athena", "title": "Target Type", "description": "Internal field, populated automatically", "default": "athena" }, "bucket": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Bucket", "description": "If the column is a partition column in the target table" } }, "additionalProperties": false, "type": "object", "required": [ "is_selected", "name" ], "title": "AthenaModifiedColumn", "description": "Athena specific columns settings" }, "AthenaNoPartitionProperties": { "properties": { "partition_by": { "const": "none", "title": "Partition By" } }, "type": "object", "required": [ "partition_by" ], "title": "AthenaNoPartitionProperties", "description": "Athena No Partition Properties Schema" }, "AthenaPartitionByDateProperties": { "properties": { "partition_by": { "const": "date", "title": "Partition By" }, "partition_granularity": { "type": "string", "enum": [ "DAY", "MONTH", "YEAR" ], "title": "Partition Granularity" } }, "type": "object", "required": [ "partition_by", "partition_granularity" ], "title": "AthenaPartitionByDateProperties", "description": "Athena Partition By Date Properties Schema" }, "AthenaPartitionByTimestampProperties": { "properties": { "partition_by": { "const": "timestamp", "title": "Partition By" }, "partition_granularity": { "type": "string", "enum": [ "HOUR", "DAY", "MONTH", "YEAR" ], "title": "Partition Granularity" } }, "type": "object", "required": [ "partition_by", "partition_granularity" ], "title": "AthenaPartitionByTimestampProperties", "description": "Athena Partition By Timestamp Properties Schema" }, "AthenaSqlQueryStep": { "properties": { "name": { "type": "string", "title": "Name" }, "is_enabled": { "type": "boolean", "title": "Is Enabled", "description": "A flag that indicates whether the step is enabled or not", "default": true }, "step_id": { "type": "string", "title": "Step Id", "description": "The step id", "examples": [ "76e0f1a623b444338778a189b1386126" ] }, "disable_errors": { "type": "boolean", "title": "Disable Errors", "description": "A flag that indicates whether to disable errors or not", "default": false }, "connection_id": { "type": "string", "title": "Connection Id" }, "sql_query": { "type": "string", "title": "Sql Query" }, "type": { "const": "athena_sql_query", "title": "Type" }, "target_settings": { "oneOf": [ { "$ref": "#/components/schemas/AthenaTargetTableProperties" }, { "$ref": "#/components/schemas/TargetVariableProperties" } ], "title": "Target Settings", "discriminator": { "propertyName": "target_type", "mapping": { "table": "#/components/schemas/AthenaTargetTableProperties", "variable": "#/components/schemas/TargetVariableProperties" } } } }, "type": "object", "required": [ "name", "sql_query", "type", "target_settings", "connection_id" ], "title": "AthenaSqlQueryStep", "description": "Athena SQL Query Step Schema" }, "AthenaSqlScriptStep": { "properties": { "name": { "type": "string", "title": "Name" }, "is_enabled": { "type": "boolean", "title": "Is Enabled", "description": "A flag that indicates whether the step is enabled or not", "default": true }, "step_id": { "type": "string", "title": "Step Id", "description": "The step id", "examples": [ "76e0f1a623b444338778a189b1386126" ] }, "disable_errors": { "type": "boolean", "title": "Disable Errors", "description": "A flag that indicates whether to disable errors or not", "default": false }, "connection_id": { "type": "string", "title": "Connection Id" }, "sql_query": { "type": "string", "title": "Sql Query" }, "type": { "const": "athena_sql_script", "title": "Type" } }, "type": "object", "required": [ "name", "sql_query", "type", "connection_id" ], "title": "AthenaSqlScriptStep", "description": "Athena SQL Script Step Schema" }, "AthenaTableAdditionalTargetSettings": { "properties": { "is_ordered_merge_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Ordered Merge Key", "description": "If the table got any and should consider filter out duplicates data between source filemerge process(by order).", "default": false, "examples": [true] }, "order_expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Expression", "description": "The order expression of the river entity,to filter duplications from the source data by the provided order expression (for `merge` loading method).", "examples": [ "id desc,createDate asc" ] }, "target_loading": { "anyOf": [ { "$ref": "#/components/schemas/LoadingMode" }, { "type": "null" } ], "description": "The target loading of the table entity,if not specified the default loading mode of the riverwill be used.", "examples": [ "merge" ] }, "target_type": { "const": "athena", "title": "Target Type", "description": "Internal field, populated automatically", "default": "athena" } }, "type": "object", "title": "AthenaTableAdditionalTargetSettings", "description": "Athena specific target settings" }, "AthenaTargetSettings": { "properties": { "name": { "const": "athena", "title": "Name", "description": "The name of the target", "default": "athena" }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Id", "description": "The connection ID of this target", "examples": [ "5f4d3b3d9f9c8b0001f6b0e6" ] }, "connection_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Name", "description": "The connection name of this target", "examples": [ "Connection 1" ] }, "single_table_settings": { "anyOf": [ { "$ref": "#/components/schemas/SingleTableSettings" }, { "type": "null" } ], "description": "Single table specific settings for the target" }, "table_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Table Name", "description": "The table name of this target (only relevant for non multi table source to target rivers)", "default": "", "examples": [ "Table 1" ] }, "target_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Prefix", "description": "The table prefix of this target (only relevant for multi table source to target rivers)", "default": "", "examples": [ "start_at_" ] }, "is_ordered_merge_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Ordered Merge Key", "description": "If the table got any and should consider filter out duplicates data between source filemerge process(by order).", "default": false, "examples": [true] }, "order_expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Expression", "description": "The order expression of the river entity.", "examples": [ "id desc,createDate asc" ] }, "loading_method": { "allOf": [ { "$ref": "#/components/schemas/LoadingMode" } ], "description": "The loading method of this target", "examples": [ "merge" ] }, "merge_method": { "anyOf": [ { "$ref": "#/components/schemas/MergeMethod" }, { "type": "null" } ], "description": "The merge method to preform,only relevant when the loading mode is Merge,if not provided the default merge method will be used.(merge)", "examples": [ "merge" ] }, "file_zone_settings": { "anyOf": [ { "$ref": "#/components/schemas/RiverFileZoneSettings" }, { "type": "null" } ], "description": "The file zone settings of this target" }, "file_path_destination": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Path Destination", "description": "The path to file" }, "additional_settings": { "type": "object", "title": "Additional Settings", "description": "The additional settings of this target", "default": { }, "examples": [ { "key": "value" } ] }, "schema_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Name", "description": "The schema name of this target", "examples": [ "Schema 1" ] }, "bucket_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bucket Name", "description": "The bucket name", "examples": [ "my-bucket" ] }, "replace_invalid_utf_characters": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Replace Invalid Utf Characters", "description": "Replace invalid utf-8 characters with Unicode replacement character" }, "truncate_columns": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Truncate Columns", "description": "Cut varchar values which are longer than the column definition" } }, "type": "object", "required": [ "loading_method" ], "title": "AthenaTargetSettings", "description": "Athena target settings properties to return." }, "AthenaTargetTableMergeSettings": { "properties": { "is_ordered_merge": { "type": "boolean", "title": "Is Ordered Merge", "description": "A flag that indicates whether the merge is ordered or not", "default": false }, "order_expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Expression", "description": "The order expression" } }, "type": "object", "title": "AthenaTargetTableMergeSettings", "description": "Athena Target Table Merge Settings Schema" }, "AthenaTargetTableProperties": { "properties": { "target_type": { "const": "table", "title": "Target Type" }, "table_name": { "type": "string", "title": "Table Name" }, "drop_after": { "type": "boolean", "title": "Drop After", "description": "A flag that indicates whether to drop the table after the run or not", "default": false }, "schema_name": { "type": "string", "title": "Schema Name" }, "bucket_name": { "type": "string", "title": "Bucket Name" }, "file_path": { "type": "string", "title": "File Path" }, "loading_mode": { "type": "string", "enum": [ "append_only", "overwrite", "upsert_merge" ], "title": "Loading Mode", "default": "append_only" }, "merge_settings": { "anyOf": [ { "$ref": "#/components/schemas/AthenaTargetTableMergeSettings" }, { "type": "null" } ], "description": "The merge settings" }, "fields": { "items": { "type": "object" }, "type": "array", "title": "Fields", "description": "The mapping", "default": [] }, "partition_properties": { "oneOf": [ { "$ref": "#/components/schemas/AthenaPartitionByTimestampProperties" }, { "$ref": "#/components/schemas/AthenaPartitionByDateProperties" }, { "$ref": "#/components/schemas/AthenaNoPartitionProperties" } ], "title": "Partition Properties", "discriminator": { "propertyName": "partition_by", "mapping": { "date": "#/components/schemas/AthenaPartitionByDateProperties", "none": "#/components/schemas/AthenaNoPartitionProperties", "timestamp": "#/components/schemas/AthenaPartitionByTimestampProperties" } } }, "number_of_buckets": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Number Of Buckets", "description": "The number of buckets" } }, "type": "object", "required": [ "target_type", "table_name", "schema_name", "bucket_name", "file_path", "partition_properties" ], "title": "AthenaTargetTableProperties", "description": "Athena Target Table Properties Schema" }, "AuditEntityTypeEnum": { "type": "string", "enum": [ "accounts", "connections", "rivers", "river_groups", "users", "teams" ], "title": "AuditEntityTypeEnum", "description": "The audit event entity types" }, "AuditEventTypeEnum": { "type": "string", "enum": [ "create", "recover", "delete", "update", "initiate_activate_river", "initiate_disable_river", "edit_cdc_configuration", "delete_cdc_configuration" ], "title": "AuditEventTypeEnum", "description": "The audit events, events type" }, "AuditEventsPaginationResponse": { "properties": { "next_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Page", "description": "The next page URL" }, "previous_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Page", "description": "The previous page URL" }, "items": { "items": { "$ref": "#/components/schemas/AuditEventsResponse" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "items" ], "title": "AuditEventsPaginationResponse", "description": "Audit events pagination response" }, "AuditEventsResponse": { "properties": { "event_id": { "type": "string", "title": "Event Id", "description": "The id of the audit event", "examples": [ "eac285a5a9ae4ada9ccd49889a651e16" ] }, "event_initiator": { "type": "string", "title": "Event Initiator", "description": "Where the event was initiated", "examples": [ "UI" ] }, "event_datetime": { "type": "string", "title": "Event Datetime", "description": "The event date time in UTC timezone", "examples": [ "2022-08-02T13:38:44.054000" ] }, "event_type": { "allOf": [ { "$ref": "#/components/schemas/AuditEventTypeEnum" } ], "description": "The type of the event", "examples": [ "create" ] }, "event_result_status": { "type": "integer", "title": "Event Result Status", "description": "The status of the API request of the event", "examples": [200] }, "event_name": { "type": "string", "title": "Event Name", "description": "The name of the event in the following format-event_type:entity_type:additional_info", "examples": [ "update:rivers:without_version" ] }, "entity_type": { "allOf": [ { "$ref": "#/components/schemas/AuditEntityTypeEnum" } ], "description": "The type of entity that was recorded", "examples": [ "rivers" ] }, "entity_logical_key": { "type": "string", "title": "Entity Logical Key", "default": "A unique logical identifier of an entity, usually the cross_id", "examples": [ "5eda28ee6b028e1ce7a2b5ec" ] }, "account_id": { "type": "string", "title": "Account Id", "description": "The account id the event originated for", "examples": [ "5ebec4ca6b028e2da4191dde" ] }, "environment_id": { "type": "string", "title": "Environment Id", "description": "The environment id the event originated for", "examples": [ "5ebec4ca6b028e2da4191de1" ] }, "user_id": { "type": "string", "title": "User Id", "description": "The user id the event originated for", "examples": [ "60d08931f5682c0d9fa24890" ] }, "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Name", "description": "The name of the user that originated the event", "examples": [ "Rivi Ee" ] }, "entity_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entity Name", "description": "The name of the event entity, this could be the name of the river, connection etc.", "examples": [ "My First River" ] }, "entity_subtype": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Entity Subtype", "description": "The even subtype, this could be a river classification like logic or s2t rivers", "examples": [ "src_to_trgt", "logic" ] }, "additional_info": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Additional Info", "default": "Additional information saved for the event", "examples": [ "{\"version_id\": \"637582d3c32287000fc1d69f\"}" ] } }, "type": "object", "required": [ "event_id", "event_initiator", "event_datetime", "event_type", "event_result_status", "event_name", "entity_type", "account_id", "environment_id", "user_id" ], "title": "AuditEventsResponse", "description": "Audit events response" }, "AzureBlobModifiedColumn": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the column is selected and should be modified.", "examples": [true] }, "name": { "type": "string", "title": "Name", "description": "The name of the column.", "examples": [ "column_name" ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type", "description": "The type of the column.", "examples": [ "string" ] }, "alias": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Alias", "description": "The alias of the column in the target table.", "examples": [ "column_alias" ] }, "expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expression", "description": "This tells us the column is an expression or not so we know if it suppose to exist in the source / target or is it auto generated.", "examples": [ "select 'test'" ] }, "is_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Key", "description": "If the column is a key.", "examples": [true] }, "cluster_key": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cluster Key", "description": "The sort order of the column (number) in the cluster, used in the merge process to determine the order of the merge keys.", "examples": [1] }, "calculated_column_mode": { "anyOf": [ { "$ref": "#/components/schemas/CalculatedColumnModeEnum" }, { "type": "null" } ], "description": "The mode of the calculated column.Help to identify if the column is source expression or target expression,required if the column is an expression.", "examples": [ "source" ] }, "order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Order", "description": "The order of the column in the expression,required if the column is an expression.", "examples": [1] }, "mode": { "anyOf": [ { "$ref": "#/components/schemas/ColumnModeEnum" }, { "type": "null" } ], "description": "The mode of the column in the target table" }, "is_rivery_metadata": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Rivery Metadata", "description": "Whether the column includes rivery metadata" }, "target_type": { "const": "blob_storage", "title": "Target Type", "description": "Internal field, populated automatically", "default": "blob_storage" } }, "additionalProperties": false, "type": "object", "required": [ "is_selected", "name" ], "title": "AzureBlobModifiedColumn", "description": "Azure Blob specific columns settings" }, "AzureSQLSqlQueryStep": { "properties": { "name": { "type": "string", "title": "Name" }, "is_enabled": { "type": "boolean", "title": "Is Enabled", "description": "A flag that indicates whether the step is enabled or not", "default": true }, "step_id": { "type": "string", "title": "Step Id", "description": "The step id", "examples": [ "76e0f1a623b444338778a189b1386126" ] }, "disable_errors": { "type": "boolean", "title": "Disable Errors", "description": "A flag that indicates whether to disable errors or not", "default": false }, "connection_id": { "type": "string", "title": "Connection Id" }, "sql_query": { "type": "string", "title": "Sql Query" }, "type": { "const": "azure_sql_query", "title": "Type" }, "target_settings": { "oneOf": [ { "$ref": "#/components/schemas/TargetVariableProperties" }, { "$ref": "#/components/schemas/AzureSQLTargetTableProperties" } ], "title": "Target Settings", "discriminator": { "propertyName": "target_type", "mapping": { "table": "#/components/schemas/AzureSQLTargetTableProperties", "variable": "#/components/schemas/TargetVariableProperties" } } } }, "type": "object", "required": [ "name", "sql_query", "type", "target_settings", "connection_id" ], "title": "AzureSQLSqlQueryStep", "description": "Azure SQL SQL Query Step Schema" }, "AzureSQLSqlScriptStep": { "properties": { "name": { "type": "string", "title": "Name" }, "is_enabled": { "type": "boolean", "title": "Is Enabled", "description": "A flag that indicates whether the step is enabled or not", "default": true }, "step_id": { "type": "string", "title": "Step Id", "description": "The step id", "examples": [ "76e0f1a623b444338778a189b1386126" ] }, "disable_errors": { "type": "boolean", "title": "Disable Errors", "description": "A flag that indicates whether to disable errors or not", "default": false }, "connection_id": { "type": "string", "title": "Connection Id" }, "sql_query": { "type": "string", "title": "Sql Query" }, "type": { "const": "azure_sql_script", "title": "Type" } }, "type": "object", "required": [ "name", "sql_query", "type", "connection_id" ], "title": "AzureSQLSqlScriptStep", "description": "Azure SQL SQL Script Step Schema" }, "AzureSQLTargetTableMergeSettings": { "properties": { "is_ordered_merge": { "type": "boolean", "title": "Is Ordered Merge", "description": "A flag that indicates whether the merge is ordered or not", "default": false }, "order_expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Expression", "description": "The order expression" }, "merge_method": { "type": "string", "title": "Merge Method", "description": "The merge method", "default": "merge" } }, "type": "object", "title": "AzureSQLTargetTableMergeSettings", "description": "Azure SQL Target Table Merge Settings Schema" }, "AzureSQLTargetTableProperties": { "properties": { "target_type": { "const": "table", "title": "Target Type" }, "table_name": { "type": "string", "title": "Table Name" }, "drop_after": { "type": "boolean", "title": "Drop After", "description": "A flag that indicates whether to drop the table after the run or not", "default": false }, "schema_name": { "type": "string", "title": "Schema Name", "description": "The schema name" }, "loading_mode": { "type": "string", "enum": [ "append_only", "overwrite", "upsert_merge" ], "title": "Loading Mode", "default": "append_only" }, "merge_settings": { "anyOf": [ { "$ref": "#/components/schemas/AzureSQLTargetTableMergeSettings" }, { "type": "null" } ], "description": "The merge settings" }, "fields": { "items": { "type": "object" }, "type": "array", "title": "Fields", "description": "The mapping", "default": [] } }, "type": "object", "required": [ "target_type", "table_name", "schema_name" ], "title": "AzureSQLTargetTableProperties", "description": "Azure SQL Target Table Properties Schema" }, "AzureSqlModifiedColumn": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the column is selected and should be modified.", "examples": [true] }, "name": { "type": "string", "title": "Name", "description": "The name of the column.", "examples": [ "column_name" ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type", "description": "The type of the column.", "examples": [ "string" ] }, "alias": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Alias", "description": "The alias of the column in the target table.", "examples": [ "column_alias" ] }, "expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expression", "description": "This tells us the column is an expression or not so we know if it suppose to exist in the source / target or is it auto generated.", "examples": [ "select 'test'" ] }, "is_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Key", "description": "If the column is a key.", "examples": [true] }, "cluster_key": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cluster Key", "description": "The sort order of the column (number) in the cluster, used in the merge process to determine the order of the merge keys.", "examples": [1] }, "calculated_column_mode": { "anyOf": [ { "$ref": "#/components/schemas/CalculatedColumnModeEnum" }, { "type": "null" } ], "description": "The mode of the calculated column.Help to identify if the column is source expression or target expression,required if the column is an expression.", "examples": [ "source" ] }, "order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Order", "description": "The order of the column in the expression,required if the column is an expression.", "examples": [1] }, "mode": { "anyOf": [ { "$ref": "#/components/schemas/ColumnModeEnum" }, { "type": "null" } ], "description": "The mode of the column in the target table" }, "is_rivery_metadata": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Rivery Metadata", "description": "Whether the column includes rivery metadata" }, "target_type": { "const": "azure_sql", "title": "Target Type", "description": "Internal field, populated automatically", "default": "azure_sql" } }, "additionalProperties": false, "type": "object", "required": [ "is_selected", "name" ], "title": "AzureSqlModifiedColumn", "description": "AzureSql specific columns settings" }, "AzureSqlTableAdditionalTargetSettings": { "properties": { "is_ordered_merge_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Ordered Merge Key", "description": "If the table got any and should consider filter out duplicates data between source filemerge process(by order).", "default": false, "examples": [true] }, "order_expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Expression", "description": "The order expression of the river entity,to filter duplications from the source data by the provided order expression (for `merge` loading method).", "examples": [ "id desc,createDate asc" ] }, "target_loading": { "anyOf": [ { "$ref": "#/components/schemas/LoadingMode" }, { "type": "null" } ], "description": "The target loading of the table entity,if not specified the default loading mode of the riverwill be used.", "examples": [ "merge" ] }, "target_type": { "const": "azure_sql", "title": "Target Type", "description": "Internal field, populated automatically", "default": "azure_sql" }, "merge_method": { "anyOf": [ { "$ref": "#/components/schemas/MergeMethod" }, { "type": "null" } ], "description": "The merge method of the table, if not specified the default merge method of the riverwill be used.", "examples": [ "merge" ] }, "recreate_keys": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Recreate Keys", "description": "Purge the keys in the table using the mapping keys, when running on overwrite", "default": false } }, "type": "object", "title": "AzureSqlTableAdditionalTargetSettings", "description": "Azure SQL specific target settings" }, "AzureSqlTargetSettings": { "properties": { "name": { "const": "azure_sql", "title": "Name", "description": "The name of the target", "default": "azure_sql" }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Id", "description": "The connection ID of this target", "examples": [ "5f4d3b3d9f9c8b0001f6b0e6" ] }, "connection_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Name", "description": "The connection name of this target", "examples": [ "Connection 1" ] }, "single_table_settings": { "anyOf": [ { "$ref": "#/components/schemas/SingleTableSettings" }, { "type": "null" } ], "description": "Single table specific settings for the target" }, "table_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Table Name", "description": "The table name of this target (only relevant for non multi table source to target rivers)", "default": "", "examples": [ "Table 1" ] }, "target_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Prefix", "description": "The table prefix of this target (only relevant for multi table source to target rivers)", "default": "", "examples": [ "start_at_" ] }, "is_ordered_merge_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Ordered Merge Key", "description": "If the table got any and should consider filter out duplicates data between source filemerge process(by order).", "default": false, "examples": [true] }, "order_expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Expression", "description": "The order expression of the river entity.", "examples": [ "id desc,createDate asc" ] }, "loading_method": { "allOf": [ { "$ref": "#/components/schemas/LoadingMode" } ], "description": "The loading method of this target", "examples": [ "merge" ] }, "merge_method": { "anyOf": [ { "$ref": "#/components/schemas/MergeMethod" }, { "type": "null" } ], "description": "The merge method to preform,only relevant when the loading mode is Merge,if not provided the default merge method will be used.(merge)", "examples": [ "merge" ] }, "file_zone_settings": { "anyOf": [ { "$ref": "#/components/schemas/RiverFileZoneSettings" }, { "type": "null" } ], "description": "The file zone settings of this target" }, "file_path_destination": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Path Destination", "description": "The file name and path", "examples": [ "path/to/file" ] }, "additional_settings": { "type": "object", "title": "Additional Settings", "description": "The additional settings of this target", "default": { }, "examples": [ { "key": "value" } ] }, "schema_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Name", "description": "The schema name of this target", "examples": [ "Schema 1" ] } }, "type": "object", "required": [ "loading_method" ], "title": "AzureSqlTargetSettings", "description": "Azure SQL target settings properties to return." }, "AzureSynapseAnalyticsModifiedColumn": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the column is selected and should be modified.", "examples": [true] }, "name": { "type": "string", "title": "Name", "description": "The name of the column.", "examples": [ "column_name" ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type", "description": "The type of the column.", "examples": [ "string" ] }, "alias": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Alias", "description": "The alias of the column in the target table.", "examples": [ "column_alias" ] }, "expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expression", "description": "This tells us the column is an expression or not so we know if it suppose to exist in the source / target or is it auto generated.", "examples": [ "select 'test'" ] }, "is_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Key", "description": "If the column is a key.", "examples": [true] }, "cluster_key": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cluster Key", "description": "The sort order of the column (number) in the cluster, used in the merge process to determine the order of the merge keys.", "examples": [1] }, "calculated_column_mode": { "anyOf": [ { "$ref": "#/components/schemas/CalculatedColumnModeEnum" }, { "type": "null" } ], "description": "The mode of the calculated column.Help to identify if the column is source expression or target expression,required if the column is an expression.", "examples": [ "source" ] }, "order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Order", "description": "The order of the column in the expression,required if the column is an expression.", "examples": [1] }, "mode": { "anyOf": [ { "$ref": "#/components/schemas/ColumnModeEnum" }, { "type": "null" } ], "description": "The mode of the column in the target table" }, "is_rivery_metadata": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Rivery Metadata", "description": "Whether the column includes rivery metadata" }, "target_type": { "const": "azure_synapse_analytics", "title": "Target Type", "description": "Internal field, populated automatically", "default": "azure_synapse_analytics" }, "is_dist_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Dist Key", "description": "If the column is a unique Distkey column on which the table is distributed to each node", "examples": [true] }, "cluster_index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cluster Index", "description": "Index of the column in the cluster key", "examples": [1] }, "length": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Length", "description": "The length of VARCHAR columns.", "examples": [256] } }, "additionalProperties": false, "type": "object", "required": [ "is_selected", "name" ], "title": "AzureSynapseAnalyticsModifiedColumn", "description": "AzureSynapseAnalytics specific columns settings" }, "AzureSynapseAnalyticsTableAdditionalTargetSettings": { "properties": { "is_ordered_merge_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Ordered Merge Key", "description": "If the table got any and should consider filter out duplicates data between source filemerge process(by order).", "default": false, "examples": [true] }, "order_expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Expression", "description": "The order expression of the river entity,to filter duplications from the source data by the provided order expression (for `merge` loading method).", "examples": [ "id desc,createDate asc" ] }, "target_loading": { "anyOf": [ { "$ref": "#/components/schemas/LoadingMode" }, { "type": "null" } ], "description": "The target loading of the table entity,if not specified the default loading mode of the riverwill be used.", "examples": [ "merge" ] }, "target_type": { "const": "azure_synapse_analytics", "title": "Target Type", "description": "Internal field, populated automatically", "default": "azure_synapse_analytics" }, "distribution_method": { "anyOf": [ { "$ref": "#/components/schemas/AzureSynapseDistributionMethodEnum" }, { "type": "null" } ], "description": "The distribution method of the target." }, "mapping_order": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Mapping Order", "description": "A list of column names which represents the Mapping order of the table.", "examples": [ "id", "first_name", "last_name" ] } }, "type": "object", "title": "AzureSynapseAnalyticsTableAdditionalTargetSettings", "description": "Azure Synapse Analytics specific target settings" }, "AzureSynapseAnalyticsTargetSettings": { "properties": { "name": { "const": "azure_synapse_analytics", "title": "Name", "description": "The name of the target", "default": "azure_synapse_analytics" }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Id", "description": "The connection ID of this target", "examples": [ "5f4d3b3d9f9c8b0001f6b0e6" ] }, "connection_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Name", "description": "The connection name of this target", "examples": [ "Connection 1" ] }, "single_table_settings": { "anyOf": [ { "$ref": "#/components/schemas/SingleTableSettings" }, { "type": "null" } ], "description": "Single table specific settings for the target" }, "table_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Table Name", "description": "The table name of this target (only relevant for non multi table source to target rivers)", "default": "", "examples": [ "Table 1" ] }, "target_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Prefix", "description": "The table prefix of this target (only relevant for multi table source to target rivers)", "default": "", "examples": [ "start_at_" ] }, "is_ordered_merge_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Ordered Merge Key", "description": "If the table got any and should consider filter out duplicates data between source filemerge process(by order).", "default": false, "examples": [true] }, "order_expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Expression", "description": "The order expression of the river entity.", "examples": [ "id desc,createDate asc" ] }, "loading_method": { "allOf": [ { "$ref": "#/components/schemas/LoadingMode" } ], "description": "The loading method of this target", "examples": [ "merge" ] }, "merge_method": { "anyOf": [ { "$ref": "#/components/schemas/MergeMethod" }, { "type": "null" } ], "description": "The merge method to preform,only relevant when the loading mode is Merge,if not provided the default merge method will be used.(merge)", "examples": [ "merge" ] }, "file_zone_settings": { "anyOf": [ { "$ref": "#/components/schemas/RiverFileZoneSettings" }, { "type": "null" } ], "description": "The file zone settings of this target" }, "file_path_destination": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Path Destination", "description": "The file name and path", "examples": [ "path/to/file" ] }, "additional_settings": { "type": "object", "title": "Additional Settings", "description": "The additional settings of this target", "default": { }, "examples": [ { "key": "value" } ] }, "schema_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Name", "description": "The schema name of this target", "examples": [ "Schema 1" ] }, "table_type": { "allOf": [ { "$ref": "#/components/schemas/AzureSynapseTableTypeEnum" } ], "description": "Table type column store or row store", "default": "columnstore" } }, "type": "object", "required": [ "loading_method" ], "title": "AzureSynapseAnalyticsTargetSettings", "description": "Azure Synapse Analytics target settings properties to return." }, "AzureSynapseCsvFileSettings": { "properties": { "file_type": { "const": "csv", "title": "File Type", "default": "csv" }, "file_delimiter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Delimiter" }, "quote_char": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Quote Char" }, "include_header": { "type": "boolean", "title": "Include Header", "default": false }, "compression": { "type": "string", "enum": [ "none", "gzip" ], "title": "Compression", "description": "The compression type", "default": "none" } }, "type": "object", "title": "AzureSynapseCsvFileSettings", "description": "Azure Synapse CSV File Settings Schema" }, "AzureSynapseDistributionMethodEnum": { "type": "string", "enum": [ "hash", "round_robin", "replicate" ], "title": "AzureSynapseDistributionMethodEnum", "description": "Azure Synapse distribution methods" }, "AzureSynapseSqlQueryStep": { "properties": { "name": { "type": "string", "title": "Name" }, "is_enabled": { "type": "boolean", "title": "Is Enabled", "description": "A flag that indicates whether the step is enabled or not", "default": true }, "step_id": { "type": "string", "title": "Step Id", "description": "The step id", "examples": [ "76e0f1a623b444338778a189b1386126" ] }, "disable_errors": { "type": "boolean", "title": "Disable Errors", "description": "A flag that indicates whether to disable errors or not", "default": false }, "connection_id": { "type": "string", "title": "Connection Id" }, "sql_query": { "type": "string", "title": "Sql Query" }, "type": { "const": "azure_synapse_sql_query", "title": "Type" }, "target_settings": { "oneOf": [ { "$ref": "#/components/schemas/TargetVariableProperties" }, { "$ref": "#/components/schemas/AzureSynapseTargetTableProperties" }, { "$ref": "#/components/schemas/AzureSynapseTargetFileProperties" } ], "title": "Target Settings", "discriminator": { "propertyName": "target_type", "mapping": { "files_export": "#/components/schemas/AzureSynapseTargetFileProperties", "table": "#/components/schemas/AzureSynapseTargetTableProperties", "variable": "#/components/schemas/TargetVariableProperties" } } } }, "type": "object", "required": [ "name", "sql_query", "type", "target_settings", "connection_id" ], "title": "AzureSynapseSqlQueryStep", "description": "Azure Synapse SQL Query Step Schema" }, "AzureSynapseSqlScriptStep": { "properties": { "name": { "type": "string", "title": "Name" }, "is_enabled": { "type": "boolean", "title": "Is Enabled", "description": "A flag that indicates whether the step is enabled or not", "default": true }, "step_id": { "type": "string", "title": "Step Id", "description": "The step id", "examples": [ "76e0f1a623b444338778a189b1386126" ] }, "disable_errors": { "type": "boolean", "title": "Disable Errors", "description": "A flag that indicates whether to disable errors or not", "default": false }, "connection_id": { "type": "string", "title": "Connection Id" }, "sql_query": { "type": "string", "title": "Sql Query" }, "type": { "const": "azure_synapse_sql_script", "title": "Type" } }, "type": "object", "required": [ "name", "sql_query", "type", "connection_id" ], "title": "AzureSynapseSqlScriptStep", "description": "Azure Synapse SQL Script Step Schema" }, "AzureSynapseTableTypeEnum": { "type": "string", "enum": [ "columnstore", "rowstore" ], "title": "AzureSynapseTableTypeEnum", "description": "Azure Synapse table types" }, "AzureSynapseTargetFileProperties": { "properties": { "target_type": { "const": "files_export", "title": "Target Type" }, "bucket_name": { "type": "string", "title": "Bucket Name" }, "file_path": { "type": "string", "title": "File Path" }, "connection_id": { "type": "string", "title": "Connection Id" }, "file_format": { "const": "csv", "title": "File Format", "default": "csv" }, "load_into_single_file": { "type": "boolean", "title": "Load Into Single File", "description": "A flag that indicates whether to load into a single file or not", "default": false }, "file_settings": { "$ref": "#/components/schemas/AzureSynapseCsvFileSettings" } }, "type": "object", "required": [ "target_type", "bucket_name", "file_path", "connection_id", "file_settings" ], "title": "AzureSynapseTargetFileProperties", "description": "Azure Synapse Target File Properties Schema" }, "AzureSynapseTargetTableMergeSettings": { "properties": { "is_ordered_merge": { "type": "boolean", "title": "Is Ordered Merge", "description": "A flag that indicates whether the merge is ordered or not", "default": false }, "order_expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Expression", "description": "The order expression" } }, "type": "object", "title": "AzureSynapseTargetTableMergeSettings", "description": "Azure Synapse Target Table Merge Settings Schema" }, "AzureSynapseTargetTableProperties": { "properties": { "target_type": { "const": "table", "title": "Target Type" }, "table_name": { "type": "string", "title": "Table Name" }, "drop_after": { "type": "boolean", "title": "Drop After", "description": "A flag that indicates whether to drop the table after the run or not", "default": false }, "schema_name": { "type": "string", "title": "Schema Name" }, "loading_mode": { "type": "string", "enum": [ "append_only", "overwrite", "upsert_merge" ], "title": "Loading Mode", "default": "append_only" }, "distribution_method": { "type": "string", "enum": [ "round_robin", "hash", "replicate" ], "title": "Distribution Method", "default": "round_robin" }, "table_type": { "type": "string", "enum": [ "columnstore", "rowstore" ], "title": "Table Type", "default": "columnstore" }, "merge_settings": { "anyOf": [ { "$ref": "#/components/schemas/AzureSynapseTargetTableMergeSettings" }, { "type": "null" } ], "description": "The merge settings" }, "mapping_order": { "items": { "type": "string" }, "type": "array", "title": "Mapping Order", "description": "The mapping order", "default": [] }, "fields": { "items": { "type": "object" }, "type": "array", "title": "Fields", "description": "The mapping", "default": [] } }, "type": "object", "required": [ "target_type", "table_name", "schema_name" ], "title": "AzureSynapseTargetTableProperties", "description": "Azure Synapse Target Table Properties Schema" }, "BaseAvroFileSettings": { "properties": { "file_type": { "const": "avro", "title": "File Type" } }, "type": "object", "required": [ "file_type" ], "title": "BaseAvroFileSettings", "description": "Base Avro File Settings Schema" }, "BigQueryAdditionalSourceSettings": { "properties": { "source_type": { "const": "bigquery", "title": "Source Type", "description": "Internal field, populated automatically", "default": "bigquery" } }, "type": "object", "title": "BigQueryAdditionalSourceSettings", "description": "BigQuery specific source settings" }, "BigQueryCsvFileSettings": { "properties": { "file_type": { "const": "csv", "title": "File Type", "default": "csv" }, "file_delimiter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Delimiter" }, "quote_char": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Quote Char" }, "include_header": { "type": "boolean", "title": "Include Header", "default": false }, "compression": { "type": "string", "enum": [ "none", "gzip" ], "title": "Compression", "default": "none" } }, "type": "object", "title": "BigQueryCsvFileSettings", "description": "Big Query CSV File Settings Schema" }, "BigQueryFileTargetProperties": { "properties": { "target_type": { "const": "files_export", "title": "Target Type" }, "bucket_name": { "type": "string", "title": "Bucket Name" }, "file_path": { "type": "string", "title": "File Path" }, "file_type": { "type": "string", "enum": [ "json", "csv", "avro" ], "title": "File Type", "default": "csv" }, "load_into_single_file": { "type": "boolean", "title": "Load Into Single File", "description": "A flag that indicates whether to load into a single file or not", "default": false }, "file_settings": { "oneOf": [ { "$ref": "#/components/schemas/BigQueryCsvFileSettings" }, { "$ref": "#/components/schemas/BigQueryJsonFileSettings" }, { "$ref": "#/components/schemas/BaseAvroFileSettings" } ], "title": "File Settings", "discriminator": { "propertyName": "file_type", "mapping": { "avro": "#/components/schemas/BaseAvroFileSettings", "csv": "#/components/schemas/BigQueryCsvFileSettings", "json": "#/components/schemas/BigQueryJsonFileSettings" } } } }, "type": "object", "required": [ "target_type", "bucket_name", "file_path", "file_settings" ], "title": "BigQueryFileTargetProperties", "description": "BigQuery File Target Properties Schema" }, "BigQueryJsonFileSettings": { "properties": { "file_type": { "const": "json", "title": "File Type" }, "compression": { "type": "string", "enum": [ "none", "gzip" ], "title": "Compression", "default": "none" } }, "type": "object", "required": [ "file_type" ], "title": "BigQueryJsonFileSettings", "description": "Big Query JSON File Settings Schema" }, "BigQueryModifiedColumn": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the column is selected and should be modified.", "examples": [true] }, "name": { "type": "string", "title": "Name", "description": "The name of the column.", "examples": [ "column_name" ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type", "description": "The type of the column.", "examples": [ "string" ] }, "alias": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Alias", "description": "The alias of the column in the target table.", "examples": [ "column_alias" ] }, "expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expression", "description": "This tells us the column is an expression or not so we know if it suppose to exist in the source / target or is it auto generated.", "examples": [ "select 'test'" ] }, "is_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Key", "description": "If the column is a key.", "examples": [true] }, "cluster_key": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cluster Key", "description": "The sort order of the column (number) in the cluster, used in the merge process to determine the order of the merge keys.", "examples": [1] }, "calculated_column_mode": { "anyOf": [ { "$ref": "#/components/schemas/CalculatedColumnModeEnum" }, { "type": "null" } ], "description": "The mode of the calculated column.Help to identify if the column is source expression or target expression,required if the column is an expression.", "examples": [ "source" ] }, "order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Order", "description": "The order of the column in the expression,required if the column is an expression.", "examples": [1] }, "mode": { "anyOf": [ { "$ref": "#/components/schemas/ColumnModeEnum" }, { "type": "null" } ], "description": "The mode of the column in the target table" }, "is_rivery_metadata": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Rivery Metadata", "description": "Whether the column includes rivery metadata" }, "is_partition": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Partition", "description": "Indication if the column is a partition column", "default": false }, "target_type": { "const": "bigquery", "title": "Target Type", "description": "Internal field, populated automatically", "default": "bigquery" } }, "additionalProperties": false, "type": "object", "required": [ "is_selected", "name" ], "title": "BigQueryModifiedColumn", "description": "Big Query specific columns settings" }, "BigQueryPartitionTimestampGranularityEnum": { "type": "string", "enum": [ "HOUR", "DAY", "MONTH", "YEAR" ], "title": "BigQueryPartitionTimestampGranularityEnum", "description": "BQ partition by timestamp granularity options, for example a daily partition" }, "BigQueryPartitionTypeEnum": { "type": "string", "enum": [ "TIMESTAMP", "DATE" ], "title": "BigQueryPartitionTypeEnum", "description": "BQ partition types, these are the builtin BQ partitions" }, "BigQueryQueryPriorityEnum": { "type": "string", "enum": [ "interactive", "batch" ], "title": "BigQueryQueryPriorityEnum", "description": "Enum for BigQuery query priority" }, "BigQuerySQLDialectsEnum": { "type": "string", "enum": [ "standard", "legacy" ], "title": "BigQuerySQLDialectsEnum", "description": "BQ SQL dialects in table level" }, "BigQuerySplitTableIntervalEnum": { "type": "string", "enum": [ "hourly", "daily", "monthly", "yearly" ], "title": "BigQuerySplitTableIntervalEnum", "description": "Split BQ tables interval options\nfor example, split by days" }, "BigQuerySplitTablesEnum": { "type": "string", "enum": [ "no_split", "record_insert_timestamp", "expression" ], "title": "BigQuerySplitTablesEnum", "description": "Split BQ tables at target enum.\nexample, split to tables based on the record insert timestamp" }, "BigQuerySqlQueryStep": { "properties": { "name": { "type": "string", "title": "Name" }, "is_enabled": { "type": "boolean", "title": "Is Enabled", "description": "A flag that indicates whether the step is enabled or not", "default": true }, "step_id": { "type": "string", "title": "Step Id", "description": "The step id", "examples": [ "76e0f1a623b444338778a189b1386126" ] }, "disable_errors": { "type": "boolean", "title": "Disable Errors", "description": "A flag that indicates whether to disable errors or not", "default": false }, "connection_id": { "type": "string", "title": "Connection Id" }, "sql_query": { "type": "string", "title": "Sql Query" }, "use_standard_sql": { "type": "boolean", "title": "Use Standard Sql", "description": "A flag that indicates whether to use standard SQL or not", "default": true }, "query_priority": { "allOf": [ { "$ref": "#/components/schemas/BigQueryQueryPriorityEnum" } ], "description": "The priority of the query", "default": "interactive" }, "maximum_billing_tier": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Maximum Billing Tier", "description": "The maximum billing tier" }, "flatten_results": { "type": "boolean", "title": "Flatten Results", "description": "A flag that indicates whether to flatten results or not", "default": false }, "type": { "const": "bigquery_sql_query", "title": "Type" }, "target_settings": { "oneOf": [ { "$ref": "#/components/schemas/BigQueryTableTargetProperties" }, { "$ref": "#/components/schemas/TargetVariableProperties" }, { "$ref": "#/components/schemas/BigQueryFileTargetProperties" } ], "title": "Target Settings", "discriminator": { "propertyName": "target_type", "mapping": { "files_export": "#/components/schemas/BigQueryFileTargetProperties", "table": "#/components/schemas/BigQueryTableTargetProperties", "variable": "#/components/schemas/TargetVariableProperties" } } } }, "type": "object", "required": [ "name", "sql_query", "type", "target_settings", "connection_id" ], "title": "BigQuerySqlQueryStep", "description": "BigQuery SQL Query Step Schema" }, "BigQuerySqlScriptStep": { "properties": { "name": { "type": "string", "title": "Name" }, "is_enabled": { "type": "boolean", "title": "Is Enabled", "description": "A flag that indicates whether the step is enabled or not", "default": true }, "step_id": { "type": "string", "title": "Step Id", "description": "The step id", "examples": [ "76e0f1a623b444338778a189b1386126" ] }, "disable_errors": { "type": "boolean", "title": "Disable Errors", "description": "A flag that indicates whether to disable errors or not", "default": false }, "connection_id": { "type": "string", "title": "Connection Id" }, "sql_query": { "type": "string", "title": "Sql Query" }, "use_standard_sql": { "type": "boolean", "title": "Use Standard Sql", "description": "A flag that indicates whether to use standard SQL or not", "default": true }, "query_priority": { "allOf": [ { "$ref": "#/components/schemas/BigQueryQueryPriorityEnum" } ], "description": "The priority of the query", "default": "interactive" }, "maximum_billing_tier": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Maximum Billing Tier", "description": "The maximum billing tier" }, "flatten_results": { "type": "boolean", "title": "Flatten Results", "description": "A flag that indicates whether to flatten results or not", "default": false }, "type": { "const": "bigquery_sql_script", "title": "Type" } }, "type": "object", "required": [ "name", "sql_query", "type", "connection_id" ], "title": "BigQuerySqlScriptStep", "description": "BigQuery SQL Script Step Schema" }, "BigQueryTableAdditionalTargetSettings": { "properties": { "is_ordered_merge_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Ordered Merge Key", "description": "If the table got any and should consider filter out duplicates data between source filemerge process(by order).", "default": false, "examples": [true] }, "order_expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Expression", "description": "The order expression of the river entity,to filter duplications from the source data by the provided order expression (for `merge` loading method).", "examples": [ "id desc,createDate asc" ] }, "target_loading": { "anyOf": [ { "$ref": "#/components/schemas/LoadingMode" }, { "type": "null" } ], "description": "The target loading of the table entity,if not specified the default loading mode of the riverwill be used.", "examples": [ "merge" ] }, "target_type": { "const": "bigquery", "title": "Target Type", "description": "Internal field, populated automatically", "default": "bigquery" }, "merge_method": { "anyOf": [ { "$ref": "#/components/schemas/MergeMethod" }, { "type": "null" } ], "description": "The merge method of the table, if not specified the default merge method of the riverwill be used.", "examples": [ "merge" ] }, "sql_dialect": { "anyOf": [ { "$ref": "#/components/schemas/BigQuerySQLDialectsEnum" }, { "type": "null" } ], "description": "The dialect to use in the BQ target" }, "split_tables": { "anyOf": [ { "$ref": "#/components/schemas/BigQuerySplitTablesEnum" }, { "type": "null" } ], "description": "Split tables at target.", "default": "no_split", "examples": [ "record_insert_timestamp" ] }, "split_interval": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Split Interval", "description": "The interval by which to split the tables if split table is on.", "examples": [ "daily" ] }, "split_data": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Split Data", "description": "The expression by which to split the tables if split tables by expression is chosen.", "examples": [ "a\u003E3" ] }, "partition_type": { "anyOf": [ { "$ref": "#/components/schemas/BigQueryPartitionTypeEnum" }, { "type": "null" } ], "description": "The type of partition to partition that table by.", "examples": [ "TIMESTAMP" ] }, "partition_granularity": { "anyOf": [ { "$ref": "#/components/schemas/BigQueryPartitionTimestampGranularityEnum" }, { "type": "null" } ], "description": "The partition granularity to split the table by.", "examples": [ "DAY" ] } }, "type": "object", "title": "BigQueryTableAdditionalTargetSettings", "description": "BigQuery specific target settings" }, "BigQueryTableTargetProperties": { "properties": { "target_type": { "const": "table", "title": "Target Type" }, "table_name": { "type": "string", "title": "Table Name" }, "drop_after": { "type": "boolean", "title": "Drop After", "description": "A flag that indicates whether to drop the table after the run or not", "default": false }, "dataset_id": { "type": "string", "title": "Dataset Id" }, "loading_mode": { "type": "string", "enum": [ "append_only", "overwrite", "upsert_merge" ], "title": "Loading Mode", "default": "append_only" }, "merge_settings": { "anyOf": [ { "$ref": "#/components/schemas/BigQueryTargetTableMergeSettings" }, { "type": "null" } ], "description": "The merge settings" }, "partition_properties": { "anyOf": [ { "$ref": "#/components/schemas/PartitioningByTimestamp" }, { "type": "null" } ] }, "split_tables_properties": { "anyOf": [ { "$ref": "#/components/schemas/SplitTableByInsertTimeProperties" }, { "$ref": "#/components/schemas/SplitTableByExpressionProperties" }, { "type": "null" } ], "title": "Split Tables Properties" }, "fields": { "items": { "type": "object" }, "type": "array", "title": "Fields", "description": "The mapping", "default": [] }, "mapping_order": { "items": { "type": "string" }, "type": "array", "title": "Mapping Order", "description": "The mapping order", "default": [] } }, "type": "object", "required": [ "target_type", "table_name", "dataset_id" ], "title": "BigQueryTableTargetProperties", "description": "BigQuery Table Target Properties Schema" }, "BigQueryTargetSettings": { "properties": { "name": { "const": "bigquery", "title": "Name", "description": "The name of the target", "default": "bigquery" }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Id", "description": "The connection ID of this target", "examples": [ "5f4d3b3d9f9c8b0001f6b0e6" ] }, "connection_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Name", "description": "The connection name of this target", "examples": [ "Connection 1" ] }, "single_table_settings": { "anyOf": [ { "$ref": "#/components/schemas/SingleTableSettings" }, { "type": "null" } ], "description": "Single table specific settings for the target" }, "table_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Table Name", "description": "The table name of this target (only relevant for non multi table source to target rivers)", "default": "", "examples": [ "Table 1" ] }, "target_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Prefix", "description": "The table prefix of this target (only relevant for multi table source to target rivers)", "default": "", "examples": [ "start_at_" ] }, "is_ordered_merge_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Ordered Merge Key", "description": "If the table got any and should consider filter out duplicates data between source filemerge process(by order).", "default": false, "examples": [true] }, "order_expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Expression", "description": "The order expression of the river entity.", "examples": [ "id desc,createDate asc" ] }, "loading_method": { "allOf": [ { "$ref": "#/components/schemas/LoadingMode" } ], "description": "The loading method of this target", "examples": [ "merge" ] }, "merge_method": { "anyOf": [ { "$ref": "#/components/schemas/MergeMethod" }, { "type": "null" } ], "description": "The merge method to preform,only relevant when the loading mode is Merge,if not provided the default merge method will be used.(merge)", "examples": [ "merge" ] }, "file_zone_settings": { "anyOf": [ { "$ref": "#/components/schemas/RiverFileZoneSettings" }, { "type": "null" } ], "description": "The file zone settings of this target" }, "file_path_destination": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Path Destination", "description": "The file name and path", "examples": [ "path/to/file" ] }, "additional_settings": { "type": "object", "title": "Additional Settings", "description": "The additional settings of this target", "default": { }, "examples": [ { "key": "value" } ] }, "dataset_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dataset Id", "description": "The dataset ID of this target", "examples": [ "dataset_1" ] }, "sql_dialect": { "anyOf": [ { "$ref": "#/components/schemas/BigQuerySQLDialectsEnum" }, { "type": "null" } ], "description": "The dialect to use in the BQ target", "examples": [ "standard" ] }, "auto_detect_datatype_changes": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Auto Detect Datatype Changes", "description": "If the target should auto detect datatype changes" } }, "type": "object", "required": [ "loading_method" ], "title": "BigQueryTargetSettings", "description": "BigQuery target settings properties to return." }, "BigQueryTargetTableMergeSettings": { "properties": { "is_ordered_merge": { "type": "boolean", "title": "Is Ordered Merge", "description": "A flag that indicates whether the merge is ordered or not", "default": false }, "order_expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Expression", "description": "The order expression" } }, "type": "object", "title": "BigQueryTargetTableMergeSettings", "description": "Big Query Target Table Merge Settings Schema" }, "BlobStorageSettings": { "properties": { "name": { "const": "blob_storage", "title": "Name", "description": "The name of the target", "default": "blob_storage" }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Id", "description": "The connection ID of this target", "examples": [ "5f4d3b3d9f9c8b0001f6b0e6" ] }, "connection_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Name", "description": "The connection name of this target", "examples": [ "Connection 1" ] }, "single_table_settings": { "anyOf": [ { "$ref": "#/components/schemas/SingleTableSettings" }, { "type": "null" } ], "description": "Single table specific settings for the target" }, "path": { "type": "string", "title": "Path", "description": "The path of the file zone entity.", "examples": [ "my_path" ] }, "partitioned_kind": { "allOf": [ { "$ref": "#/components/schemas/PartitionedKindEnum" } ], "description": "The partitioned kind of the file zone entity.", "examples": [ "by_day" ] }, "fz_loading_mode": { "type": "string", "enum": [ "auto-period", "custom" ], "title": "Fz Loading Mode", "description": "Controls how the storage path is configured. 'auto-period' uses automatic period-based paths, 'custom' allows user-defined paths.", "default": "auto-period", "examples": [ "auto-period", "custom" ] }, "container_name": { "type": "string", "title": "Container Name", "description": "The container name of the file zone entity.", "examples": [ "my_container" ] }, "convert_file_type": { "anyOf": [ { "$ref": "#/components/schemas/ConvertFileTypeEnum" }, { "type": "null" } ], "description": "The type of file to convert to", "examples": [ "parquet" ] } }, "type": "object", "required": [ "path", "partitioned_kind", "container_name" ], "title": "BlobStorageSettings", "description": "Azure Blob Storage target settings properties to return." }, "Body_add_file": { "properties": { "file": { "type": "string", "format": "binary", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_add_file" }, "BoomiForSapAdditionalSourceSettings": { "properties": { "source_type": { "const": "boomi_for_sap", "title": "Source Type", "description": "Internal field, populated automatically", "default": "boomi_for_sap" }, "table_filters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/TableFilter" }, "type": "array" }, { "type": "null" } ], "title": "Table Filters", "description": "Table filters for Boomi for Sap" } }, "type": "object", "title": "BoomiForSapAdditionalSourceSettings", "description": "Boomi for Sap specific source settings" }, "BoomiForSapCDCSettings": { "properties": { "default_tables_migration_option": { "allOf": [ { "$ref": "#/components/schemas/RiverTablesMigrationDefaultSyncOption" } ], "description": "This option determine the tables migration option. For example. Choosing SKIP_INITIAL_MIGRATIONwill cause all tables to inherit the status from the River level to be used for a one-time process.", "default": "RUN_INITIAL_MIGRATION", "examples": [ "SKIP_INITIAL_MIGRATION" ] }, "include_snapshot_tables": { "type": "boolean", "title": "Include Snapshot Tables", "description": "Indicates whether to take a snapshot of the source table before starting CDC.", "default": true }, "datasource_id": { "const": "boomi_for_sap", "title": "Datasource Id", "description": "The data source id of this source", "default": "boomi_for_sap" } }, "additionalProperties": false, "type": "object", "title": "BoomiForSapCDCSettings", "description": "Boomi for SAP Source CDC settings properties to return." }, "CalculatedColumnModeEnum": { "type": "string", "enum": [ "source", "target" ], "title": "CalculatedColumnModeEnum", "description": "The calculated column mode\nCalculated column mode is used to determine if the calculated column is a new column or an override of an existing\nIt can be used either on the source or the target" }, "CancelRiverRunBody": { "properties": { "run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Run Id", "description": "The run_id to cancel." }, "run_group_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Run Group Id", "description": "The run_group_id to cancel. Use this field when you want to cancel multiple tables or sub rivers" } }, "type": "object", "title": "CancelRiverRunBody", "description": "Cancel River Run body" }, "CdcConfig": { "properties": { "config": { "oneOf": [ { "$ref": "#/components/schemas/CdcMysqlConfig" }, { "$ref": "#/components/schemas/CdcPostgresConfig" }, { "$ref": "#/components/schemas/CdcSqlServerConfig" }, { "$ref": "#/components/schemas/CdcMongodbConfig" }, { "$ref": "#/components/schemas/CdcOracleConfig" } ], "title": "Config", "discriminator": { "propertyName": "datasource_type", "mapping": { "mongodb": "#/components/schemas/CdcMongodbConfig", "mssql": "#/components/schemas/CdcSqlServerConfig", "mysql": "#/components/schemas/CdcMysqlConfig", "oracle": "#/components/schemas/CdcOracleConfig", "postgres": "#/components/schemas/CdcPostgresConfig" } } } }, "type": "object", "required": [ "config" ], "title": "CdcConfig", "description": "Cdc config:\n* config - The cdc config by the source type" }, "CdcMongodbConfig": { "properties": { "last_updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Updated", "default": "2026-05-14T01:57:33.707876Z" }, "datasource_type": { "const": "mongodb", "title": "Datasource Type", "default": "mongodb" }, "resume_token": { "type": "string", "title": "Resume Token", "description": "The resume token offset", "examples": [ "{\"_data\": \"8262C3BE46000000012B022C0100296E5A1004\"}" ] } }, "type": "object", "required": [ "resume_token" ], "title": "CdcMongodbConfig", "description": "Cdc mongodb config:\n* resume token of the mongodb database CDC" }, "CdcMysqlConfig": { "properties": { "last_updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Updated", "default": "2026-05-14T01:57:33.707876Z" }, "datasource_type": { "const": "mysql", "title": "Datasource Type", "default": "mysql" }, "binlog_file": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Binlog File", "description": "The bin log file", "examples": [ "mysql-bin-changelog.000931" ] }, "binlog_position": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Binlog Position", "description": "The binlog position", "examples": [ "515820321" ] }, "gtid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Gtid", "description": "The gtid position offset", "examples": [ "51d431b9-585e-11ed-9222-022d1416c792:1-34,7e0646d8-b3e4-11eb-a15e-0a47d4c912dc:1-21343,8937b67f-3ab2-11ea-9bc9-0ad74248f0fe:1-5182243242,c23585e8-579a-11ed-83e3-0a47d4c912dc:1-12" ] } }, "type": "object", "title": "CdcMysqlConfig", "description": "Cdc mysql config:\n* binlog offset of the MYSQL database CDC" }, "CdcOracleConfig": { "properties": { "last_updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Updated", "default": "2026-05-14T01:57:33.707876Z" }, "datasource_type": { "const": "oracle", "title": "Datasource Type", "default": "oracle" }, "scn_offset": { "type": "integer", "title": "Scn Offset", "description": "The scn offset (System Change Number)", "examples": [1234567890123] } }, "type": "object", "required": [ "scn_offset" ], "title": "CdcOracleConfig", "description": "Cdc oracle config:\n* scn offset of the oracle database CDC" }, "CdcPostgresConfig": { "properties": { "last_updated": { "type": "string", "title": "Last Updated", "description": "The last updated time", "examples": [ "2022-10-30T17:06:24.982442328Z" ] }, "datasource_type": { "const": "postgres", "title": "Datasource Type", "default": "postgres" }, "lsn_offset": { "type": "integer", "title": "Lsn Offset", "description": "The lsn offset", "examples": [43168884936157] } }, "type": "object", "required": [ "last_updated", "lsn_offset" ], "title": "CdcPostgresConfig", "description": "Cdc postgres config:\n* lsn offset of the postgres database CDC" }, "CdcSqlServerConfig": { "properties": { "last_updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Updated", "default": "2026-05-14T01:57:33.707876Z" }, "datasource_type": { "const": "mssql", "title": "Datasource Type", "default": "mssql" }, "lsn_offset_sql_server": { "anyOf": [ { "type": "string" }, { "additionalProperties": { "type": "string" }, "type": "object" } ], "title": "Lsn Offset Sql Server", "description": "The lsn offset sql server position offset. Can be either a single LSN string or a dict mapping capture instance names to LSN values", "examples": [ "0x0000004B000009350003", { "table1": "0x0000004B000009350003", "table2": "0x0000004B000009350004" } ] } }, "type": "object", "required": [ "lsn_offset_sql_server" ], "title": "CdcSqlServerConfig", "description": "Cdc sql server config:\n* lsn offset of the sql server database CDC\n* Can be either a single LSN string for the whole database or a dict mapping capture instance names to LSN values" }, "ChangeTrackingSettings": { "properties": { "initiate_table": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Initiate Table", "description": "Initiate migration process for table", "examples": [true] }, "overwrite_table_in_migration": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Overwrite Table In Migration", "description": "Overwrite target table for migration process", "examples": [true] }, "include_deleted_rows": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Include Deleted Rows", "description": "The tracked information will include also deleted keys", "examples": [true] } }, "type": "object", "title": "ChangeTrackingSettings", "description": "The table change tracking settings" }, "ColumnModeEnum": { "type": "string", "enum": [ "NULLABLE", "REQUIRED", "REPEATED" ], "title": "ColumnModeEnum", "description": "The mode of the column in Athena" }, "Condition": { "properties": { "operator": { "type": "string", "title": "Operator" }, "operand_1": { "type": "string", "title": "Operand 1" }, "operand_2": { "type": "string", "title": "Operand 2" } }, "type": "object", "required": [ "operator", "operand_1", "operand_2" ], "title": "Condition", "description": "Condition Schema" }, "ConditionContainer": { "properties": { "name": { "type": "string", "title": "Name" }, "is_enabled": { "type": "boolean", "title": "Is Enabled", "description": "A flag that indicates whether the container is enabled or not", "default": true }, "container_id": { "type": "string", "title": "Container Id", "description": "The container id" }, "disable_errors": { "type": "boolean", "title": "Disable Errors", "description": "A flag that indicates whether to disable errors or not", "default": false }, "type": { "const": "condition", "title": "Type" }, "steps": { "items": { "$ref": "#/components/schemas/ConditionInnerContainer" }, "type": "array", "minItems": 1, "title": "Steps" } }, "type": "object", "required": [ "name", "type", "steps" ], "title": "ConditionContainer", "description": "Condition Container Schema" }, "ConditionInnerContainer": { "properties": { "condition": { "anyOf": [ { "$ref": "#/components/schemas/Condition" }, { "type": "null" } ], "description": "The condition to check. Needed except for the last else condition", "examples": [ { "operand_1": "{{var1}}", "operand_2": "{{var2}}", "operator": "equal" } ] }, "action": { "$ref": "#/components/schemas/LogicConditionActionEnum" }, "is_else": { "type": "boolean", "title": "Is Else" }, "condition_name": { "type": "string", "title": "Condition Name", "description": "The condition name" }, "step": { "anyOf": [ { "$ref": "#/components/schemas/RunOnceContainer" }, { "$ref": "#/components/schemas/LoopContainer" }, { "$ref": "#/components/schemas/ConditionContainer" }, { "$ref": "#/components/schemas/RunRiverStep" }, { "$ref": "#/components/schemas/ActionStep" }, { "$ref": "#/components/schemas/LogicodeStep" }, { "$ref": "#/components/schemas/AthenaSqlScriptStep" }, { "$ref": "#/components/schemas/AthenaSqlQueryStep" }, { "$ref": "#/components/schemas/AzureSynapseSqlScriptStep" }, { "$ref": "#/components/schemas/AzureSynapseSqlQueryStep" }, { "$ref": "#/components/schemas/AzureSQLSqlScriptStep" }, { "$ref": "#/components/schemas/AzureSQLSqlQueryStep" }, { "$ref": "#/components/schemas/PostgresSqlScriptStep" }, { "$ref": "#/components/schemas/PostgresSqlQueryStep" }, { "$ref": "#/components/schemas/SnowflakeDataframeStep" }, { "$ref": "#/components/schemas/SnowflakeSqlQueryStep" }, { "$ref": "#/components/schemas/SnowflakeSqlScriptStep" }, { "$ref": "#/components/schemas/BigQuerySqlScriptStep" }, { "$ref": "#/components/schemas/BigQuerySqlQueryStep" }, { "$ref": "#/components/schemas/DatabricksSqlScriptStep" }, { "$ref": "#/components/schemas/DatabricksSqlQueryStep" }, { "$ref": "#/components/schemas/RedshiftDataframeStep" }, { "$ref": "#/components/schemas/RedshiftSqlScriptStep" }, { "$ref": "#/components/schemas/RedshiftSqlQueryStep" }, { "type": "null" } ], "title": "Step" } }, "type": "object", "required": [ "action", "is_else", "condition_name" ], "title": "ConditionInnerContainer", "description": "Condition Inner Container Schema" }, "ConnectionPaginationResponse": { "properties": { "next_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Page", "description": "The next page URL" }, "previous_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Page", "description": "The previous page URL" }, "page": { "type": "integer", "title": "Page", "description": "The page number", "default": 1 }, "current_page_size": { "type": "integer", "title": "Current Page Size", "description": "The current page size" }, "total_items": { "type": "integer", "title": "Total Items", "description": "The total number of entities fetched", "default": 0 }, "account_id": { "type": "string", "title": "Account Id", "description": "The account id" }, "environment_id": { "type": "string", "title": "Environment Id", "description": "The environment id" }, "items": { "items": { "$ref": "#/components/schemas/ConnectionResponse" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "current_page_size", "account_id", "environment_id", "items" ], "title": "ConnectionPaginationResponse", "description": "Connection response properties to return as a paginated list\n " }, "ConnectionResponse": { "properties": { "account_id": { "type": "string", "title": "Account Id" }, "environment_id": { "type": "string", "title": "Environment Id" }, "cross_id": { "type": "string", "title": "Cross Id", "description": "The cross id of the connection", "examples": [ "5f887c764c40e5598f717676" ] }, "_id": { "type": "string", "title": " Id", "description": "The connection id", "examples": [ "5f887c764c40e5598f717676" ] }, "connection_name": { "type": "string", "title": "Connection Name", "description": "The name of the connection", "examples": [ "test connection" ] }, "connection_type": { "type": "string", "title": "Connection Type", "description": "The type of the connection", "examples": [ "Oracle" ] }, "connection_type_id": { "type": "string", "title": "Connection Type Id", "description": "The name of the related database", "examples": [ "oracle" ] }, "is_test_connection": { "type": "boolean", "title": "Is Test Connection", "description": "Indicates if the connection is a test connection", "examples": [false] }, "connection_update_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Update By", "description": "The objectID of the user who updated the connection", "examples": [ "5f887c764c40e5598f717676" ] }, "connection_update_time": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Connection Update Time", "description": "The time the connection was last updated" } }, "type": "object", "required": [ "account_id", "environment_id", "cross_id", "_id", "connection_name", "connection_type", "connection_type_id", "is_test_connection" ], "title": "ConnectionResponse", "description": "Connection properties to return" }, "ConnectionTypeModel": { "properties": { "connection_type": { "type": "string", "title": "Connection Type" }, "connection_type_name": { "type": "string", "title": "Connection Type Name" }, "properties": { "items": { "type": "object" }, "type": "array", "title": "Properties" } }, "type": "object", "required": [ "connection_type", "connection_type_name", "properties" ], "title": "ConnectionTypeModel", "description": "Connection type model" }, "ConnectionTypeResponse": { "properties": { "fields": { "type": "object", "title": "Fields", "description": "The fields of the connection type", "examples": [ { "current_page_size": 1, "items": [ { "fields": { "_id": "5643062270ec07e624d4320d", "allowed_file_extensions": [], "connection_type": "spotx", "connection_type_name": "SpotX", "has_key_file": false, "is_test_connection": true, "oauth2": false, "properties": [ { "id": "username", "type": "string", "ui_type": "text", "display_name": "Username", "row": 0 }, { "id": "password", "type": "password", "ui_type": "password", "display_name": "Password", "row": 1 }, { "id": "connection_name", "type": "string" }, { "id": "connection_desc", "type": "string" } ] } } ], "next_page": "https://api.rivery.io/v1/connections_types?items_per_page=1&page=2", "page": 1, "total_items": 189 } ] } }, "type": "object", "required": [ "fields" ], "title": "ConnectionTypeResponse", "description": "Connection properties to return" }, "ConnectionTypesPaginationResponse": { "properties": { "next_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Page", "description": "The next page URL" }, "previous_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Page", "description": "The previous page URL" }, "page": { "type": "integer", "title": "Page", "description": "The page number", "default": 1 }, "current_page_size": { "type": "integer", "title": "Current Page Size", "description": "The current page size" }, "total_items": { "type": "integer", "title": "Total Items", "description": "The total number of entities fetched", "default": 0 }, "items": { "items": { "$ref": "#/components/schemas/ConnectionTypeResponse" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "current_page_size", "items" ], "title": "ConnectionTypesPaginationResponse", "description": "Connection response properties to return as a paginated list\n ", "examples": [ { "current_page_size": 1, "items": [ { "fields": { "_id": "5643062270ec07e624d4320d", "allowed_file_extensions": [], "connection_type": "spotx", "connection_type_name": "SpotX", "has_key_file": false, "is_test_connection": true, "oauth2": false, "properties": [ { "id": "username", "type": "string", "ui_type": "text", "display_name": "Username", "row": 0 }, { "id": "password", "type": "password", "ui_type": "password", "display_name": "Password", "row": 1 }, { "id": "connection_name", "type": "string" }, { "id": "connection_desc", "type": "string" } ] } } ], "next_page": "https://api.rivery.io/v1/connections_types?items_per_page=1&page=2", "page": 1, "total_items": 189 } ] }, "ConvertFileTypeEnum": { "type": "string", "const": "parquet", "title": "ConvertFileTypeEnum", "description": "Conversion service types of file conversions.\nThe conversion service supports multiple conversion including CSV and JSON but the back only support PARQUET for now\nOnce the back adds support for the other file types we can add them here" }, "CopyRiverResponse": { "properties": { "details": { "type": "string", "title": "Details" }, "cross_id": { "type": "string", "title": "Cross Id", "description": "The new river cross id", "examples": [ "62e7f4352c13160013dc39be" ] } }, "type": "object", "required": [ "details", "cross_id" ], "title": "CopyRiverResponse", "description": "Copy river response" }, "CoupaAdditionalSourceSettings": { "properties": { "source_type": { "const": "coupa", "title": "Source Type", "description": "Internal field, populated automatically", "default": "coupa" } }, "additionalProperties": false, "type": "object", "title": "CoupaAdditionalSourceSettings", "description": "Coupa specific source settings." }, "CreateOrUpdateScimTokenResponse": { "properties": { "account_id": { "type": "string", "title": "Account Id", "description": "The account id", "examples": [ "65c2465a76ba59de1a868a4e" ] }, "scim_service_url": { "type": "string", "title": "Scim Service Url", "description": "The connection string (URL) used to communicate with your SCIM app", "examples": [ "https://rivery-scim.rivery.io" ] }, "token": { "type": "string", "title": "Token", "description": "The SCIM authentication token. Keep the token somewhere safe. The token will be shown only once.", "examples": [ "1234" ] } }, "type": "object", "required": [ "account_id", "scim_service_url", "token" ], "title": "CreateOrUpdateScimTokenResponse", "description": "SCIM Token create or update response." }, "CustomLocationProperties": { "properties": { "use_custom_location": { "type": "boolean", "title": "Use Custom Location", "description": "A flag that indicates whether to use custom location or not", "default": false }, "location_type": { "type": "string", "enum": [ "DBFS", "EXTERNAL" ], "title": "Location Type", "description": "The location type", "default": "DBFS" }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location", "description": "The location" } }, "type": "object", "title": "CustomLocationProperties", "description": "Custom Location Properties Schema" }, "CustomQuerySourceSettings": { "properties": { "query": { "type": "string", "minLength": 1, "title": "Query", "description": "The custom SQL query to execute", "examples": [ "SELECT id, name FROM users WHERE active = true" ] }, "array_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Array Size", "description": "Array size for batch fetching", "examples": [1000] }, "exporter_chunk_size": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Exporter Chunk Size", "description": "Chunk size for data export", "examples": [30000] }, "incremental_type": { "anyOf": [ { "$ref": "#/components/schemas/RiverIntervalTypeEnum" }, { "type": "null" } ], "description": "Type of incremental extraction (datetime, runningnumber, epoch)", "examples": [ "datetime" ] }, "incremental_field": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Incremental Field", "description": "Field name to use for incremental extraction", "examples": [ "created_at" ] }, "date_range": { "anyOf": [ { "$ref": "#/components/schemas/DateRange" }, { "type": "null" } ], "description": "Date range settings for incremental extraction" }, "running_number": { "anyOf": [ { "$ref": "#/components/schemas/RunningNumber" }, { "type": "null" } ], "description": "Running number settings for incremental extraction" }, "epoch": { "anyOf": [ { "$ref": "#/components/schemas/Epoch" }, { "type": "null" } ], "description": "Epoch settings for incremental extraction" }, "row_version": { "anyOf": [ { "$ref": "#/components/schemas/RowVersion" }, { "type": "null" } ], "description": "Row version settings for incremental extraction (MSSQL/PostgreSQL only)" }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "Extract method (incremental or full)", "examples": [ "incremental" ] } }, "additionalProperties": false, "type": "object", "required": [ "query" ], "title": "CustomQuerySourceSettings", "description": "Custom query source settings for database sources.\n\nUsed when run_type is 'custom_query' to define the SQL query and extraction settings.\nReuses DateRange, RunningNumber, and Epoch from base_river.py for consistency." }, "DataHubAdditionalSourceSettings": { "properties": { "source_type": { "const": "datahub", "title": "Source Type", "description": "Internal field, populated automatically", "default": "datahub" }, "table_filters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/TableFilter" }, "type": "array" }, { "type": "null" } ], "title": "Table Filters", "description": "Table filters for DataHub" } }, "type": "object", "title": "DataHubAdditionalSourceSettings", "description": "DataHub specific source settings." }, "DatabaseTableInput": { "properties": { "run_type_and_datasource": { "const": "multi_tables", "title": "Run Type And Datasource", "description": "Internal field", "default": "multi_tables" }, "details": { "allOf": [ { "$ref": "#/components/schemas/WriteDatabaseTableDetailsInput" } ], "description": "The database table details" } }, "type": "object", "required": [ "details" ], "title": "DatabaseTableInput", "description": "Table properties which define the db table data\nThis schema is being used for read" }, "DatabricksCustomLocationType": { "type": "string", "enum": [ "DBFS", "EXTERNAL" ], "title": "DatabricksCustomLocationType", "description": "The custom location type for databricks" }, "DatabricksModifiedColumn": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the column is selected and should be modified.", "examples": [true] }, "name": { "type": "string", "title": "Name", "description": "The name of the column.", "examples": [ "column_name" ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type", "description": "The type of the column.", "examples": [ "string" ] }, "alias": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Alias", "description": "The alias of the column in the target table.", "examples": [ "column_alias" ] }, "expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expression", "description": "This tells us the column is an expression or not so we know if it suppose to exist in the source / target or is it auto generated.", "examples": [ "select 'test'" ] }, "is_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Key", "description": "If the column is a key.", "examples": [true] }, "cluster_key": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cluster Key", "description": "The sort order of the column (number) in the cluster, used in the merge process to determine the order of the merge keys.", "examples": [1] }, "calculated_column_mode": { "anyOf": [ { "$ref": "#/components/schemas/CalculatedColumnModeEnum" }, { "type": "null" } ], "description": "The mode of the calculated column.Help to identify if the column is source expression or target expression,required if the column is an expression.", "examples": [ "source" ] }, "order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Order", "description": "The order of the column in the expression,required if the column is an expression.", "examples": [1] }, "mode": { "anyOf": [ { "$ref": "#/components/schemas/ColumnModeEnum" }, { "type": "null" } ], "description": "The mode of the column in the target table" }, "is_rivery_metadata": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Rivery Metadata", "description": "Whether the column includes rivery metadata" }, "target_type": { "const": "databricks", "title": "Target Type", "description": "Internal field, populated automatically", "default": "databricks" } }, "additionalProperties": false, "type": "object", "required": [ "is_selected", "name" ], "title": "DatabricksModifiedColumn", "description": "Databricks specific columns settings" }, "DatabricksSqlQueryStep": { "properties": { "name": { "type": "string", "title": "Name" }, "is_enabled": { "type": "boolean", "title": "Is Enabled", "description": "A flag that indicates whether the step is enabled or not", "default": true }, "step_id": { "type": "string", "title": "Step Id", "description": "The step id", "examples": [ "76e0f1a623b444338778a189b1386126" ] }, "disable_errors": { "type": "boolean", "title": "Disable Errors", "description": "A flag that indicates whether to disable errors or not", "default": false }, "connection_id": { "type": "string", "title": "Connection Id" }, "type": { "const": "databricks_sql_query", "title": "Type" }, "sql_query": { "type": "string", "title": "Sql Query" }, "target_settings": { "oneOf": [ { "$ref": "#/components/schemas/TargetVariableProperties" }, { "$ref": "#/components/schemas/DatabricksTargetTableProperties" } ], "title": "Target Settings", "discriminator": { "propertyName": "target_type", "mapping": { "table": "#/components/schemas/DatabricksTargetTableProperties", "variable": "#/components/schemas/TargetVariableProperties" } } } }, "type": "object", "required": [ "name", "type", "sql_query", "target_settings", "connection_id" ], "title": "DatabricksSqlQueryStep", "description": "Databricks SQL Query Step Schema" }, "DatabricksSqlScriptStep": { "properties": { "name": { "type": "string", "title": "Name" }, "is_enabled": { "type": "boolean", "title": "Is Enabled", "description": "A flag that indicates whether the step is enabled or not", "default": true }, "step_id": { "type": "string", "title": "Step Id", "description": "The step id", "examples": [ "76e0f1a623b444338778a189b1386126" ] }, "disable_errors": { "type": "boolean", "title": "Disable Errors", "description": "A flag that indicates whether to disable errors or not", "default": false }, "connection_id": { "type": "string", "title": "Connection Id" }, "type": { "const": "databricks_sql_script", "title": "Type" }, "sql_query": { "type": "string", "title": "Sql Query" } }, "type": "object", "required": [ "name", "type", "sql_query", "connection_id" ], "title": "DatabricksSqlScriptStep", "description": "Databricks SQL Script Step Schema" }, "DatabricksTableAdditionalTargetSettings": { "properties": { "is_ordered_merge_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Ordered Merge Key", "description": "If the table got any and should consider filter out duplicates data between source filemerge process(by order).", "default": false, "examples": [true] }, "order_expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Expression", "description": "The order expression of the river entity,to filter duplications from the source data by the provided order expression (for `merge` loading method).", "examples": [ "id desc,createDate asc" ] }, "target_loading": { "anyOf": [ { "$ref": "#/components/schemas/LoadingMode" }, { "type": "null" } ], "description": "The target loading of the table entity,if not specified the default loading mode of the riverwill be used.", "examples": [ "merge" ] }, "target_type": { "const": "databricks", "title": "Target Type", "description": "Internal field, populated automatically", "default": "databricks" }, "merge_method": { "anyOf": [ { "$ref": "#/components/schemas/MergeMethod" }, { "type": "null" } ], "description": "The merge method of the table, if not specified the default merge method of the riverwill be used.", "examples": [ "merge" ] } }, "type": "object", "title": "DatabricksTableAdditionalTargetSettings", "description": "Databricks specific target settings" }, "DatabricksTargetSettings": { "properties": { "name": { "const": "databricks", "title": "Name", "description": "The name of the target", "default": "databricks" }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Id", "description": "The connection ID of this target", "examples": [ "5f4d3b3d9f9c8b0001f6b0e6" ] }, "connection_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Name", "description": "The connection name of this target", "examples": [ "Connection 1" ] }, "single_table_settings": { "anyOf": [ { "$ref": "#/components/schemas/SingleTableSettings" }, { "type": "null" } ], "description": "Single table specific settings for the target" }, "table_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Table Name", "description": "The table name of this target (only relevant for non multi table source to target rivers)", "default": "", "examples": [ "Table 1" ] }, "target_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Prefix", "description": "The table prefix of this target (only relevant for multi table source to target rivers)", "default": "", "examples": [ "start_at_" ] }, "is_ordered_merge_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Ordered Merge Key", "description": "If the table got any and should consider filter out duplicates data between source filemerge process(by order).", "default": false, "examples": [true] }, "order_expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Expression", "description": "The order expression of the river entity.", "examples": [ "id desc,createDate asc" ] }, "loading_method": { "allOf": [ { "$ref": "#/components/schemas/LoadingMode" } ], "description": "The loading method of this target", "examples": [ "merge" ] }, "merge_method": { "anyOf": [ { "$ref": "#/components/schemas/MergeMethod" }, { "type": "null" } ], "description": "The merge method to preform,only relevant when the loading mode is Merge,if not provided the default merge method will be used.(merge)", "examples": [ "merge" ] }, "file_zone_settings": { "anyOf": [ { "$ref": "#/components/schemas/RiverFileZoneSettings" }, { "type": "null" } ], "description": "The file zone settings of this target" }, "file_path_destination": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Path Destination", "description": "The file name and path", "examples": [ "path/to/file" ] }, "additional_settings": { "type": "object", "title": "Additional Settings", "description": "The additional settings of this target", "default": { }, "examples": [ { "key": "value" } ] }, "catalog_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog Name", "description": "The catalog name of this target", "examples": [ "catalog_1" ] }, "schema_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Name", "description": "The schema name of this target", "examples": [ "Schema 1" ] }, "store_in_custom_location": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Store In Custom Location", "description": "If the target should store in a custom location" }, "custom_location_type": { "anyOf": [ { "$ref": "#/components/schemas/DatabricksCustomLocationType" }, { "type": "null" } ], "description": "The custom location type. Can be one of :['DBFS', 'EXTERNAL']" }, "custom_location_path": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Location Path", "description": "The table will be stored in Databricks File System (DBFS) or in external location" } }, "type": "object", "required": [ "loading_method" ], "title": "DatabricksTargetSettings", "description": "Databricks target settings properties to return." }, "DatabricksTargetTableMergeSettings": { "properties": { "is_ordered_merge": { "type": "boolean", "title": "Is Ordered Merge", "description": "A flag that indicates whether the merge is ordered or not", "default": false }, "order_expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Expression", "description": "The order expression" } }, "type": "object", "title": "DatabricksTargetTableMergeSettings", "description": "Databricks Target Table Merge Settings Schema" }, "DatabricksTargetTableProperties": { "properties": { "target_type": { "const": "table", "title": "Target Type" }, "table_name": { "type": "string", "title": "Table Name" }, "drop_after": { "type": "boolean", "title": "Drop After", "description": "A flag that indicates whether to drop the table after the run or not", "default": false }, "catalog": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Catalog", "description": "The catalog. If not provided will use the default catalog from the connection" }, "schema_name": { "type": "string", "title": "Schema Name", "description": "The schema name" }, "loading_mode": { "type": "string", "enum": [ "append_only", "overwrite", "upsert_merge" ], "title": "Loading Mode", "default": "append_only" }, "merge_settings": { "anyOf": [ { "$ref": "#/components/schemas/DatabricksTargetTableMergeSettings" }, { "type": "null" } ], "description": "The merge settings" }, "fields": { "items": { "type": "object" }, "type": "array", "title": "Fields", "description": "The mapping", "default": [] }, "custom_location": { "anyOf": [ { "$ref": "#/components/schemas/CustomLocationProperties" }, { "type": "null" } ], "description": "The custom location properties. If not provided will not use custom location" } }, "type": "object", "required": [ "target_type", "table_name", "schema_name" ], "title": "DatabricksTargetTableProperties", "description": "Databricks Target Table Properties Schema" }, "DataframeAddInput": { "properties": { "connection_settings": { "anyOf": [ { "$ref": "#/components/schemas/DataframeConnectionSettingsInput" }, { "type": "null" } ], "description": "The connection settings of the dataframe", "examples": [ "\"connection_settings\":{\n \"connection\" : \"6278159bcfc148000fad5632\",\n \"datasource_id\" : \"s3\",\n \"storage_type\" : \"aws\",\n \"default_bucket\" : \"rivery-dev-tests\"}\n " ] }, "name": { "type": "string", "title": "Name", "description": "The name of the dataframe - must be unique", "examples": [ "unique_name" ] } }, "type": "object", "required": [ "name" ], "title": "DataframeAddInput", "description": "Input for adding Dataframe\n " }, "DataframeConnectionSettingsInput": { "properties": { "connection": { "type": "string", "title": "Connection", "description": "The connection of the connection_settings", "examples": [ "62e7f4352c13160013dc39be" ] }, "datasource_id": { "type": "string", "title": "Datasource Id", "description": "The datasource_id of the connection_settings", "examples": [ "aws" ] }, "default_bucket": { "type": "string", "title": "Default Bucket", "description": "The default bucket of the connection settings", "examples": [ "some_s3_bucket" ] }, "storage_type": { "type": "string", "title": "Storage Type", "description": "The storage type of the connection settings", "examples": [ "s3" ] } }, "type": "object", "required": [ "connection", "datasource_id", "default_bucket", "storage_type" ], "title": "DataframeConnectionSettingsInput", "description": "Input for the Dataframe connection settings\n " }, "DataframePaginationResponse": { "properties": { "next_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Page", "description": "The next page URL" }, "previous_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Page", "description": "The previous page URL" }, "page": { "type": "integer", "title": "Page", "description": "The page number", "default": 1 }, "current_page_size": { "type": "integer", "title": "Current Page Size", "description": "The current page size" }, "total_items": { "type": "integer", "title": "Total Items", "description": "The total number of entities fetched", "default": 0 }, "account_id": { "type": "string", "title": "Account Id", "description": "The account id" }, "environment_id": { "type": "string", "title": "Environment Id", "description": "The environment id" }, "items": { "items": { "$ref": "#/components/schemas/DataframeResponse" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "current_page_size", "account_id", "environment_id", "items" ], "title": "DataframePaginationResponse", "description": "Dataframe response properties to return as a paginated list\n " }, "DataframeResponse": { "properties": { "account_id": { "type": "string", "title": "Account Id", "description": "The account id of the user", "examples": [ "62e7f4352c13160013dc39be" ] }, "environment_id": { "type": "string", "title": "Environment Id", "description": "The environment id of the user", "examples": [ "82e7f4122c13169813dc395g" ] }, "connection_settings": { "type": "object", "title": "Connection Settings", "description": "The connection settings of the dataframe", "default": { }, "examples": [ "\"connection_settings\":{\n \"connection\" : \"6278159bcfc148000fad5632\",\n \"datasource_id\" : \"s3\",\n \"storage_type\" : \"aws\",\n \"default_bucket\" : \"rivery-dev-tests\"}" ] }, "name": { "type": "string", "title": "Name", "description": "The name of the dataframe - must be unique", "examples": [ "unique_name" ] } }, "type": "object", "required": [ "account_id", "environment_id", "name" ], "title": "DataframeResponse", "description": "Dataframe response properties to return\n " }, "DataframeUpdateInput": { "properties": { "connection_settings": { "anyOf": [ { "$ref": "#/components/schemas/DataframeConnectionSettingsInput" }, { "type": "null" } ], "description": "The connection settings of the dataframe", "examples": [ "\"connection_settings\":{\n \"connection\" : \"6278159bcfc148000fad5632\",\n \"datasource_id\" : \"s3\",\n \"storage_type\" : \"aws\",\n \"default_bucket\" : \"rivery-dev-tests\"}\n " ] } }, "type": "object", "title": "DataframeUpdateInput", "description": "Input for updating Dataframe" }, "DateRange": { "properties": { "time_period": { "anyOf": [ { "$ref": "#/components/schemas/RiverTimePeriodEnum" }, { "type": "null" } ], "description": "The time period of the river entity.", "default": "custom", "examples": [ "custom" ] }, "start_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Start Date", "description": "The start date of the river entity.", "examples": [ "2020-12-01T00:00:00.000Z" ] }, "end_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Date", "description": "The end date of the river entity.", "examples": [ "2020-01-01T00:00:00.000Z" ] }, "days_back": { "type": "integer", "title": "Days Back", "description": "The days back of the river entity.", "default": 0, "examples": [1] }, "include_end_value": { "type": "boolean", "title": "Include End Value", "description": "Whether to include or exclude the end_value in the date range", "default": false, "examples": [true], "extra": { "display_name": "Include the End Value of the End Date", "left_label": true, "name": "date_range.include_end_value", "type": "switch" } }, "split_time_intervals": { "allOf": [ { "$ref": "#/components/schemas/SplitTimeIntervals" } ], "description": "The interval time to split by when using date increment.", "examples": [ { "interval_size": 3, "time_interval": "days" } ] }, "update_increment_on_failures": { "type": "boolean", "title": "Update Increment On Failures", "description": "If to update the start date for the next extraction even if the current extraction is unsuccessful.", "default": false, "examples": [true] }, "utc_offset": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Utc Offset", "description": "Whether to appy offset to the end date", "default": 0, "examples": [-3] }, "round_up": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Round Up", "description": "Whether to round up the end date to the next interval", "examples": [true] } }, "type": "object", "title": "DateRange", "description": "Date range when using incremental loading method." }, "DistributionMethodEnum": { "type": "string", "enum": [ "all", "even", "key" ], "title": "DistributionMethodEnum", "description": "Enum for distribution methods in Redshift as a target, example:\nALL - A copy of the entire table is distributed to every node" }, "ElasticSearchAdditionalSourceSettings": { "properties": { "filter_expression": { "type": "string", "title": "Filter Expression", "description": "The filter expression of the river entity.", "default": "", "examples": [ "id \u003E 100" ] }, "source_type": { "const": "elasticsearch", "title": "Source Type", "description": "Internal field, populated automatically", "default": "elasticsearch" } }, "additionalProperties": false, "type": "object", "title": "ElasticSearchAdditionalSourceSettings", "description": "Elasticsearch specific source settings" }, "EmailModifiedColumn": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the column is selected and should be modified.", "examples": [true] }, "name": { "type": "string", "title": "Name", "description": "The name of the column.", "examples": [ "column_name" ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type", "description": "The type of the column.", "examples": [ "string" ] }, "alias": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Alias", "description": "The alias of the column in the target table.", "examples": [ "column_alias" ] }, "expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expression", "description": "This tells us the column is an expression or not so we know if it suppose to exist in the source / target or is it auto generated.", "examples": [ "select 'test'" ] }, "is_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Key", "description": "If the column is a key.", "examples": [true] }, "cluster_key": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cluster Key", "description": "The sort order of the column (number) in the cluster, used in the merge process to determine the order of the merge keys.", "examples": [1] }, "calculated_column_mode": { "anyOf": [ { "$ref": "#/components/schemas/CalculatedColumnModeEnum" }, { "type": "null" } ], "description": "The mode of the calculated column.Help to identify if the column is source expression or target expression,required if the column is an expression.", "examples": [ "source" ] }, "order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Order", "description": "The order of the column in the expression,required if the column is an expression.", "examples": [1] }, "mode": { "anyOf": [ { "$ref": "#/components/schemas/ColumnModeEnum" }, { "type": "null" } ], "description": "The mode of the column in the target table" }, "is_rivery_metadata": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Rivery Metadata", "description": "Whether the column includes rivery metadata" }, "target_type": { "const": "target_email", "title": "Target Type", "description": "Internal field, populated automatically", "default": "target_email" } }, "additionalProperties": false, "type": "object", "required": [ "is_selected", "name" ], "title": "EmailModifiedColumn", "description": "Email specific columns settings" }, "EmailTargetSettings": { "properties": { "name": { "const": "target_email", "title": "Name", "description": "The name of the target", "default": "target_email" }, "email_list": { "items": { "type": "string" }, "type": "array", "maxItems": 15, "minItems": 1, "title": "Email List", "description": "A list of email addresses to send the data to.", "examples": [ [ "example@example.io" ] ] } }, "type": "object", "required": [ "email_list" ], "title": "EmailTargetSettings", "description": "Email target settings properties to return." }, "EnvironmentInput": { "properties": { "name": { "type": "string", "title": "Name", "description": "The environment name", "examples": [ "Dev Environment" ] }, "color": { "allOf": [ { "$ref": "#/components/schemas/EnvironmentsColorEnum" } ], "description": "The environment color as shown in the app", "default": "gray.400", "examples": [ "Gray.400" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "The environment description", "examples": [ "Development environment for new rivers" ] }, "is_default": { "type": "boolean", "title": "Is Default", "description": "A flag that indicates whether the environment is the account's default environment", "default": false, "examples": [true] } }, "type": "object", "required": [ "name" ], "title": "EnvironmentInput", "description": "Add Environment Model" }, "EnvironmentsColorEnum": { "type": "string", "enum": [ "gray.400", "tagGreen", "cBlues", "tagCyan", "tagGeekBlue", "cPurples", "tagPurple", "tagMagenta", "cOranges", "tagOrange", "yellow.200" ], "title": "EnvironmentsColorEnum", "description": "The EnvironmentsColor enum provides all color options for environments" }, "EnvironmentsFields": { "properties": { "_id": { "type": "string", "title": " Id", "description": "The environment id", "examples": [ "633ede20f1fc5500111fd7b3" ] }, "account": { "type": "string", "title": "Account", "description": "The account id of the user", "examples": [ "62e7f4352c13160013dc39be" ] }, "user_created": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Created", "description": "The user id of the user who first created the environment", "examples": [ "62e7f4352c13160013dc39be" ] }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" }, { "type": "null" } ], "title": "Created At", "description": "The environment creation date time in UTC timezone. Time format YYYY-MM-DDThh:mm:ss.ms", "examples": [ "2022-07-25T18:38:55.640Z" ] }, "cross_id": { "type": "string", "title": "Cross Id", "description": "The cross id of the environment", "examples": [ "62e7f4352c13160013dc39be" ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" }, { "type": "null" } ], "title": "Updated At", "description": "The time in which the environment was last updated (UTC time zone)", "examples": [ "2022-08-02T13:38:44.054000" ] }, "environment_name": { "type": "string", "title": "Environment Name", "description": "The environment name", "examples": [ "Dev Environment" ] }, "color": { "allOf": [ { "$ref": "#/components/schemas/EnvironmentsColorEnum" } ], "description": "The environment color as shown in the app", "default": "gray.400", "examples": [ "Gray" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "The environment description", "examples": [ "Development environment for new rivers" ] }, "variables": { "type": "object", "title": "Variables", "description": "Environment's variables", "examples": [ { "aws_file_zone": "Rivery-rivery", "azure_file_zone": "Rivery-rivery", "days_ago": "0", "gcs_file_zone": "Rivery-rivery", "hours_offset": "0" } ] }, "is_deleted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Deleted", "description": "A flag that indicates whether the environment is deleted", "default": false, "examples": [false] }, "deleted_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deleted By", "description": "The user id of the user who deleted the environment (if the environment is deleted)", "examples": [ "62e7f4352c13160013dc39be" ] }, "deleted_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" }, { "type": "null" } ], "title": "Deleted At", "description": "The time in which the environment was deleted (if the environment is deleted). Time format YYYY-MM-DDThh:mm:ss.ms", "examples": [ "2022-07-25T18:38:55.640Z" ] }, "is_default": { "type": "boolean", "title": "Is Default", "description": "A flag that indicates whether the environment is the account's default environment", "default": false, "examples": [true] }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated By", "description": "The user id of the user who last updated the environment", "examples": [ "62e7f4352c13160013dc39be" ] }, "is_delete_lock": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Delete Lock", "description": "A flag that indicates the environment deletion progress", "examples": [true] } }, "type": "object", "required": [ "_id", "account", "cross_id", "environment_name", "variables" ], "title": "EnvironmentsFields", "description": "Environments properties to return.\n " }, "Epoch": { "properties": { "start_value": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Start Value", "description": "The start value of the river entity.", "examples": [1727503847] }, "end_value": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "End Value", "description": "The end value of the river entity.", "examples": [1727590247] }, "include_end_value": { "type": "boolean", "title": "Include End Value", "description": "Whether to include or exclude the end_value in the epoch range", "default": false, "examples": [true] } }, "type": "object", "title": "Epoch", "description": "Epoch dates when using incremental on a epoch dates" }, "ExtractMethodEnum": { "type": "string", "enum": [ "all", "incremental", "log", "change_tracking", "system_versioning" ], "title": "ExtractMethodEnum", "description": "Extract method enum.\nThe supported extract methods are:\n - All - for extracting all the data with no filter\n - Incremental - for extracting the data with an increment filter by a certain field / column\n - LogBased - for CDC extraction using logs" }, "FacebookAdsAdsTypeEnum": { "type": "string", "enum": [ "ads_ids", "ads_names", "ads_filter" ], "title": "FacebookAdsAdsTypeEnum", "description": "Facebook Ads, ads type enum" }, "FacebookAdsCampaignsTypeEnum": { "type": "string", "enum": [ "campaigns_ids", "campaigns_names", "campaigns_filter" ], "title": "FacebookAdsCampaignsTypeEnum", "description": "Facebook Ads campaigns type enum" }, "FacebookAdsSetsTypeEnum": { "type": "string", "enum": [ "adsets_ids", "adsets_names", "adsets_filter" ], "title": "FacebookAdsSetsTypeEnum", "description": "Facebook Ads ad sets type enum" }, "FileSizeUnits": { "type": "string", "enum": [ "B", "KB", "MB", "GB", "TB" ], "title": "FileSizeUnits", "description": "This enum contains all the size units" }, "FinancialStatusEnum": { "type": "string", "enum": [ "any", "paid", "unpaid", "voided", "pending", "refunded", "authorized", "partially_paid", "partially_refunded" ], "title": "FinancialStatusEnum", "description": "Shopify financial order status enum" }, "GCSModifiedColumn": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the column is selected and should be modified.", "examples": [true] }, "name": { "type": "string", "title": "Name", "description": "The name of the column.", "examples": [ "column_name" ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type", "description": "The type of the column.", "examples": [ "string" ] }, "alias": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Alias", "description": "The alias of the column in the target table.", "examples": [ "column_alias" ] }, "expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expression", "description": "This tells us the column is an expression or not so we know if it suppose to exist in the source / target or is it auto generated.", "examples": [ "select 'test'" ] }, "is_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Key", "description": "If the column is a key.", "examples": [true] }, "cluster_key": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cluster Key", "description": "The sort order of the column (number) in the cluster, used in the merge process to determine the order of the merge keys.", "examples": [1] }, "calculated_column_mode": { "anyOf": [ { "$ref": "#/components/schemas/CalculatedColumnModeEnum" }, { "type": "null" } ], "description": "The mode of the calculated column.Help to identify if the column is source expression or target expression,required if the column is an expression.", "examples": [ "source" ] }, "order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Order", "description": "The order of the column in the expression,required if the column is an expression.", "examples": [1] }, "mode": { "anyOf": [ { "$ref": "#/components/schemas/ColumnModeEnum" }, { "type": "null" } ], "description": "The mode of the column in the target table" }, "is_rivery_metadata": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Rivery Metadata", "description": "Whether the column includes rivery metadata" }, "target_type": { "const": "gcs", "title": "Target Type", "description": "Internal field, populated automatically", "default": "gcs" } }, "additionalProperties": false, "type": "object", "required": [ "is_selected", "name" ], "title": "GCSModifiedColumn", "description": "GCS specific columns settings" }, "GcsTargetSettings": { "properties": { "name": { "const": "gcs", "title": "Name", "description": "The name of the target", "default": "gcs" }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Id", "description": "The connection ID of this target", "examples": [ "5f4d3b3d9f9c8b0001f6b0e6" ] }, "connection_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Name", "description": "The connection name of this target", "examples": [ "Connection 1" ] }, "single_table_settings": { "anyOf": [ { "$ref": "#/components/schemas/SingleTableSettings" }, { "type": "null" } ], "description": "Single table specific settings for the target" }, "path": { "type": "string", "title": "Path", "description": "The path of the file zone entity.", "examples": [ "my_path" ] }, "partitioned_kind": { "allOf": [ { "$ref": "#/components/schemas/PartitionedKindEnum" } ], "description": "The partitioned kind of the file zone entity.", "examples": [ "by_day" ] }, "fz_loading_mode": { "type": "string", "enum": [ "auto-period", "custom" ], "title": "Fz Loading Mode", "description": "Controls how the storage path is configured. 'auto-period' uses automatic period-based paths, 'custom' allows user-defined paths.", "default": "auto-period", "examples": [ "auto-period", "custom" ] }, "bucket_name": { "type": "string", "title": "Bucket Name", "description": "The bucket name of the file zone entity.", "examples": [ "my_bucket" ] } }, "type": "object", "required": [ "path", "partitioned_kind", "bucket_name" ], "title": "GcsTargetSettings", "description": "GCS target settings properties to return." }, "GeneralResponse": { "properties": { "details": { "type": "string", "title": "Details" } }, "type": "object", "required": [ "details" ], "title": "GeneralResponse", "description": "General response schema contains only details" }, "GetScimTokenStatusResponse": { "properties": { "account_id": { "type": "string", "title": "Account Id", "description": "The account id", "examples": [ "65c2465a76ba59de1a868a4e" ] }, "is_enabled": { "type": "boolean", "title": "Is Enabled", "description": "A flag that indicates whether SCIM provisioning is enabled", "examples": [true] }, "scim_service_url": { "type": "string", "title": "Scim Service Url", "description": "The connection string (URL) used to communicate with your SCIM app", "examples": [ "https://rivery-scim.rivery.io" ] } }, "type": "object", "required": [ "account_id", "is_enabled", "scim_service_url" ], "title": "GetScimTokenStatusResponse", "description": "SCIM token get status" }, "GroupOrUserSourceEnum": { "type": "string", "enum": [ "rivery", "active_directory" ], "title": "GroupOrUserSourceEnum", "description": "The source group. can be locally from Rivery or imported from external provider" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "HubspotAdditionalSourceSettings": { "properties": { "source_type": { "const": "hubspot", "title": "Source Type", "description": "Internal field, populated automatically", "default": "hubspot" } }, "additionalProperties": true, "type": "object", "title": "HubspotAdditionalSourceSettings", "description": "HubSpot specific source settings.\n\nHubSpot is a generic API source where each table/report may carry\na different set of settings. All fields beyond the discriminator are\naccepted and passed through as-is." }, "IDNameInput": { "properties": { "id": { "type": "string", "title": "Id", "description": "The if of the entity" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "The name of the entity" } }, "type": "object", "required": [ "id" ], "title": "IDNameInput", "description": "Basic ID and Name input" }, "IncrementalFieldEnum": { "type": "string", "enum": [ "updated at", "created at" ], "title": "IncrementalFieldEnum", "description": "Shopify addresses/customers incremental field enum" }, "InputParameters": { "properties": { "name": { "type": "string", "title": "Name" }, "value": { "anyOf": [ { "type": "string" }, { "type": "string", "format": "date-time" }, { "type": "number" }, { "type": "integer" } ], "title": "Value" } }, "type": "object", "required": [ "name", "value" ], "title": "InputParameters", "description": "Input params of activity" }, "InterfaceParameters": { "properties": { "source": { "anyOf": [ { "items": { "$ref": "#/components/schemas/StandardInterfaceParams" }, "type": "array" }, { "type": "null" } ], "title": "Source", "description": "Standard interface parameters" } }, "type": "object", "title": "InterfaceParameters", "description": "Input model containing standard interface parameters." }, "InterfaceParamsBaseTypeEnum": { "type": "string", "enum": [ "string", "integer", "boolean" ], "title": "InterfaceParamsBaseTypeEnum", "description": "Interface params base types" }, "IntervalTimeExternalEnum": { "type": "string", "enum": [ "dont_split", "minutes", "hours", "days", "weeks", "months", "years" ], "title": "IntervalTimeExternalEnum", "description": "Intervals by time options (external enum for IntervalChunkSizeEnum options)" }, "InviteUserInput": { "properties": { "user_name": { "type": "string", "title": "User Name", "description": "The user name" }, "user_email": { "type": "string", "title": "User Email", "description": "The user email" }, "environments": { "type": "object", "title": "Environments", "description": "The environments with roles per env", "examples": [ { "6271166896834700109da341": { "role": "developer" }, "6271166896834700109da342": { "role": "connection_viewer" } } ] }, "allow_login_password": { "type": "boolean", "title": "Allow Login Password", "description": "Indicates if the user is allowed to login with password", "examples": [true] }, "is_admin": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Admin", "description": "Indicates if the user is a admin", "default": false, "examples": [false] }, "allow_login_google": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Allow Login Google", "description": "Indicates if the user is allowed to login with google", "default": false, "examples": [true] }, "allow_login_sso": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Allow Login Sso", "description": "Indicates if the user is allowed to login with sso", "default": false, "examples": [true] }, "is_re_invite": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Re Invite", "description": "Indicates if the invitation is a re invite", "default": false, "examples": [true] } }, "type": "object", "required": [ "user_name", "user_email", "environments", "allow_login_password" ], "title": "InviteUserInput", "description": "Invite user input" }, "LegacyRiverResponse": { "properties": { "river_definition": { "type": "object", "title": "River Definition", "description": "The definition of the river version", "examples": [ { "river": { "id": "55fr7d4270fdca16cac18261", "name": "river_name", "source": { "id": "55fr7d4270fdca16cac18261", "name": "source_name", "type": "source_type" }, "type": "river_type", "version": "river_version" } } ] }, "source_task_config": { "type": "object", "title": "Source Task Config", "description": "The source task config of the river version", "examples": [ { "task": { "name": "task_name" } } ] }, "target_task_config": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Target Task Config", "description": "The target task config of the river version", "examples": [ { "task": { "name": "task_name" } } ] } }, "type": "object", "required": [ "river_definition", "source_task_config" ], "title": "LegacyRiverResponse", "description": "This class is used to return the river version definition in the legacy format." }, "ListEnvironmentsPaginationResponse": { "properties": { "next_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Page", "description": "The next page URL" }, "previous_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Page", "description": "The previous page URL" }, "page": { "type": "integer", "title": "Page", "description": "The page number", "default": 1 }, "current_page_size": { "type": "integer", "title": "Current Page Size", "description": "The current page size" }, "total_items": { "type": "integer", "title": "Total Items", "description": "The total number of entities fetched", "default": 0 }, "account_id": { "type": "string", "title": "Account Id", "description": "The account id" }, "items": { "items": { "$ref": "#/components/schemas/EnvironmentsFields" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "current_page_size", "account_id", "items" ], "title": "ListEnvironmentsPaginationResponse", "description": "The list environments response to return as a paginated list" }, "ListRiverObject": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the river", "examples": [ "river_name" ] }, "river_status": { "allOf": [ { "$ref": "#/components/schemas/RiverStatusEnum" } ], "description": "Status of the river", "examples": [ "active" ] }, "group_name": { "type": "string", "title": "Group Name", "description": "Name of the group associated with the river", "examples": [ "river_group_1" ] }, "group_id": { "type": "string", "title": "Group Id", "description": "the id of the group associated with the river", "examples": [ "62e7f4352c13160013dc39be" ] }, "river_schedulers": { "items": { "type": "string" }, "type": "array", "title": "River Schedulers", "description": "List of schedulers used for the river", "examples": [ [ "0 * * * *", "0 0 1 * *" ] ] }, "datasource_id": { "type": "string", "title": "Datasource Id", "description": "Source ID of the river", "examples": [ "5f7d4270fdca16cac18261" ] }, "last_user_name_modified": { "type": "string", "title": "Last User Name Modified", "description": "User name of the last modifier", "examples": [ "user_name" ] }, "river_cross_id": { "type": "string", "title": "River Cross Id", "description": "River cross ID", "examples": [ "5f7d4270fdca16cac18261" ] }, "last_updated_at": { "type": "string", "format": "date-time", "title": "Last Updated At", "description": "Last time the river was modified", "examples": [ "2021-01-01T00:00:00.000Z" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the river, if available", "examples": [ "river_description" ] }, "is_api_v2": { "type": "boolean", "title": "Is Api V2", "description": "Flag indicating whether the river is using API v2", "examples": [true] }, "river_type": { "allOf": [ { "$ref": "#/components/schemas/RiverTypeEnum" } ], "description": "Type of the river", "examples": [ "source_to_target" ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "Time the river was created", "examples": [ "2021-01-01T00:00:00.000Z" ] } }, "type": "object", "required": [ "name", "river_status", "group_name", "group_id", "river_schedulers", "datasource_id", "last_user_name_modified", "river_cross_id", "last_updated_at", "is_api_v2", "river_type", "created_at" ], "title": "ListRiverObject", "description": "River list object for the list endpoint." }, "ListRiversSortByFilterEnum": { "type": "string", "enum": [ "last_updated_at", "source_name", "river_name", "group_name", "group_id" ], "title": "ListRiversSortByFilterEnum", "description": "The river sort by filter enum provide all the sort by options." }, "ListUserModel": { "properties": { "user_id": { "type": "string", "title": "User Id", "description": "The user id", "examples": [ "5f887c764c40e5598f717676" ] }, "user_email": { "type": "string", "title": "User Email", "description": "The email of the user", "examples": [ "user@rivey.io" ] }, "user_name": { "type": "string", "title": "User Name", "description": "The user name", "examples": [ "John Doe" ] }, "environments": { "type": "object", "title": "Environments", "description": "The user environments and permission", "examples": [ { "5f887c764c40e5598f717676": { "role": "admin" } } ] }, "is_admin": { "type": "boolean", "title": "Is Admin", "description": "A flag that indicates whether the flag is admin", "examples": [true] }, "is_global_operator": { "type": "boolean", "title": "Is Global Operator", "description": "Indicates if the user is a global operator (read-only cross-account)", "default": false, "examples": [false] }, "status": { "type": "string", "title": "Status", "description": "The user status", "examples": [ "active" ] }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At", "description": "The user creation date", "examples": [ "2026-05-14T01:57:17.017979" ] }, "last_login": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Login", "description": "The user's last login date", "examples": [ "2026-05-14T01:57:17.017979" ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "The user last update date", "examples": [ "2026-05-14T01:57:17.017979" ] }, "groups": { "items": { "type": "string" }, "type": "array", "title": "Groups", "description": "The user's groups", "default": [], "examples": [ [ "5f887c764c40e5598f717676" ] ] }, "source": { "type": "string", "title": "Source", "description": "The user source", "examples": [ "rivery" ] }, "invited_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Invited By", "description": "The user who invited this user", "examples": [ "invite@rivey.io" ] }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active", "description": "Indicates if the user is active", "default": true }, "onboarding": { "anyOf": [ { "$ref": "#/components/schemas/UserOnboardingModel" }, { "type": "null" } ] } }, "type": "object", "required": [ "user_id", "user_email", "user_name", "environments", "is_admin", "status", "source" ], "title": "ListUserModel", "description": "List user model" }, "ListUsersResponse": { "properties": { "next_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Page", "description": "The next page URL" }, "previous_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Page", "description": "The previous page URL" }, "page": { "type": "integer", "title": "Page", "description": "The page number", "default": 1 }, "current_page_size": { "type": "integer", "title": "Current Page Size", "description": "The current page size" }, "total_items": { "type": "integer", "title": "Total Items", "description": "The total number of entities fetched", "default": 0 }, "account_id": { "type": "string", "title": "Account Id", "description": "The account id" }, "items": { "items": { "$ref": "#/components/schemas/ListUserModel" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "current_page_size", "account_id", "items" ], "title": "ListUsersResponse", "description": "List users response" }, "LoadingMode": { "type": "string", "enum": [ "overwrite", "append", "merge" ], "title": "LoadingMode", "description": "Enum for loading modes " }, "LogicBlockTypeEnum": { "type": "string", "enum": [ "big_query_sql", "river", "redshift", "action", "azure_datalake", "azure_sql", "azure_datalake_job", "snowflake", "logicode", "azure_sql_dwh", "postgres", "databricks", "firebolt", "athena" ], "title": "LogicBlockTypeEnum", "description": "Logic step can have block types - this enum enumerate the different block types" }, "LogicConditionActionEnum": { "type": "string", "enum": [ "run_step", "skip_container", "stop_river", "fail_river" ], "title": "LogicConditionActionEnum", "description": "The logic condition action enum" }, "LogicContainerTypeEnum": { "type": "string", "enum": [ "run_once", "loop_over", "condition" ], "title": "LogicContainerTypeEnum", "description": "ALl of the logic container options" }, "LogicProperties": { "properties": { "logic_steps": { "items": { "oneOf": [ { "$ref": "#/components/schemas/RunOnceContainer" }, { "$ref": "#/components/schemas/LoopContainer" }, { "$ref": "#/components/schemas/ConditionContainer" }, { "$ref": "#/components/schemas/RunRiverStep" }, { "$ref": "#/components/schemas/ActionStep" }, { "$ref": "#/components/schemas/LogicodeStep" }, { "$ref": "#/components/schemas/AthenaSqlScriptStep" }, { "$ref": "#/components/schemas/AthenaSqlQueryStep" }, { "$ref": "#/components/schemas/AzureSynapseSqlScriptStep" }, { "$ref": "#/components/schemas/AzureSynapseSqlQueryStep" }, { "$ref": "#/components/schemas/AzureSQLSqlScriptStep" }, { "$ref": "#/components/schemas/AzureSQLSqlQueryStep" }, { "$ref": "#/components/schemas/PostgresSqlScriptStep" }, { "$ref": "#/components/schemas/PostgresSqlQueryStep" }, { "$ref": "#/components/schemas/SnowflakeDataframeStep" }, { "$ref": "#/components/schemas/SnowflakeSqlQueryStep" }, { "$ref": "#/components/schemas/SnowflakeSqlScriptStep" }, { "$ref": "#/components/schemas/BigQuerySqlScriptStep" }, { "$ref": "#/components/schemas/BigQuerySqlQueryStep" }, { "$ref": "#/components/schemas/DatabricksSqlScriptStep" }, { "$ref": "#/components/schemas/DatabricksSqlQueryStep" }, { "$ref": "#/components/schemas/RedshiftDataframeStep" }, { "$ref": "#/components/schemas/RedshiftSqlScriptStep" }, { "$ref": "#/components/schemas/RedshiftSqlQueryStep" } ], "discriminator": { "propertyName": "type", "mapping": { "action": "#/components/schemas/ActionStep", "athena_sql_query": "#/components/schemas/AthenaSqlQueryStep", "athena_sql_script": "#/components/schemas/AthenaSqlScriptStep", "azure_sql_query": "#/components/schemas/AzureSQLSqlQueryStep", "azure_sql_script": "#/components/schemas/AzureSQLSqlScriptStep", "azure_synapse_sql_query": "#/components/schemas/AzureSynapseSqlQueryStep", "azure_synapse_sql_script": "#/components/schemas/AzureSynapseSqlScriptStep", "bigquery_sql_query": "#/components/schemas/BigQuerySqlQueryStep", "bigquery_sql_script": "#/components/schemas/BigQuerySqlScriptStep", "condition": "#/components/schemas/ConditionContainer", "databricks_sql_query": "#/components/schemas/DatabricksSqlQueryStep", "databricks_sql_script": "#/components/schemas/DatabricksSqlScriptStep", "logicode": "#/components/schemas/LogicodeStep", "loop": "#/components/schemas/LoopContainer", "postgres_sql_query": "#/components/schemas/PostgresSqlQueryStep", "postgres_sql_script": "#/components/schemas/PostgresSqlScriptStep", "redshift_dataframe": "#/components/schemas/RedshiftDataframeStep", "redshift_sql_query": "#/components/schemas/RedshiftSqlQueryStep", "redshift_sql_script": "#/components/schemas/RedshiftSqlScriptStep", "river": "#/components/schemas/RunRiverStep", "run_once": "#/components/schemas/RunOnceContainer", "snowflake_dataframe": "#/components/schemas/SnowflakeDataframeStep", "snowflake_sql_query": "#/components/schemas/SnowflakeSqlQueryStep", "snowflake_sql_script": "#/components/schemas/SnowflakeSqlScriptStep" } } }, "type": "array", "minItems": 1, "title": "Logic Steps" }, "properties_type": { "const": "logic", "title": "Properties Type", "default": "logic" } }, "type": "object", "required": [ "logic_steps" ], "title": "LogicProperties", "description": "The logic river properties" }, "LogicStep": { "properties": { "is_container": { "type": "boolean", "title": "Is Container", "description": "A flag that indicates whether this step is a container or not", "examples": [true] }, "container_type": { "anyOf": [ { "$ref": "#/components/schemas/LogicContainerTypeEnum" }, { "type": "null" } ], "description": "The container type - if any", "examples": [ "run_once" ] }, "start_date_utc": { "type": "string", "format": "date-time", "title": "Start Date Utc", "description": "The start date time in UTC timezone.Time format YYYY-MM-DDThh:mm:ss.ms", "examples": [ "2022-07-25T18:38:55.640Z" ] }, "start_date_in_milliseconds": { "type": "integer", "title": "Start Date In Milliseconds", "description": "The start epoch in milliseconds.", "examples": [1658774335000] }, "end_date_utc": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Date Utc", "description": "The end date time in UTC timezone.Time format YYYY-MM-DDThh:mm:ss.ms", "examples": [ "2022-07-25T18:38:55.640Z" ] }, "end_date_in_milliseconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "End Date In Milliseconds", "description": "The end epoch in milliseconds.", "examples": [1658774335000] }, "step_status": { "allOf": [ { "$ref": "#/components/schemas/ActivityStatusEnum" } ], "description": "The step status", "examples": [ "succeeded" ] }, "loop_iteration_number": { "type": "integer", "title": "Loop Iteration Number", "description": "If loop exist, it will contain the loop iteration number, otherwise 0" }, "duration": { "type": "string", "title": "Duration", "description": "Step duration. Format h:mm:ss.ms. If step failed or canceled the duration will be 'None'", "examples": [ "0:01:23.275006" ] }, "step_execution_id": { "type": "string", "title": "Step Execution Id" }, "step_id": { "type": "string", "title": "Step Id" }, "step_index": { "type": "string", "title": "Step Index" }, "error_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Description", "description": "The error description if any", "examples": [ "error" ] }, "logicode_statistics": { "anyOf": [ { "$ref": "#/components/schemas/LogicodeStatistics" }, { "type": "null" } ], "description": "The logicode statistics of RPU, duration and network" }, "block_type": { "anyOf": [ { "$ref": "#/components/schemas/LogicBlockTypeEnum" }, { "type": "null" } ], "description": "The logic block type", "examples": [ "action" ] } }, "type": "object", "required": [ "is_container", "start_date_utc", "start_date_in_milliseconds", "end_date_utc", "end_date_in_milliseconds", "step_status", "loop_iteration_number", "duration", "step_execution_id", "step_id", "step_index", "error_description" ], "title": "LogicStep", "description": "Logic step configuration" }, "LogicTaskProperties": { "properties": { "duration": { "type": "integer", "title": "Duration", "description": "The duration of the task in milliseconds", "examples": [2000] }, "error_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Description", "description": "The error description if any", "examples": [ "error" ] }, "start_date_utc": { "type": "string", "format": "date-time", "title": "Start Date Utc", "description": "The start date time in UTC timezone.Time format YYYY-MM-DDThh:mm:ss.ms", "examples": [ "2022-07-25T18:38:55.640Z" ] }, "start_date_in_milliseconds": { "type": "integer", "title": "Start Date In Milliseconds", "description": "The start epoch in milliseconds.", "examples": [1658774335000] }, "end_date_utc": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Date Utc", "description": "The end date time in UTC timezone.Time format YYYY-MM-DDThh:mm:ss.ms", "examples": [ "2022-07-25T18:38:55.640Z" ] }, "end_date_in_milliseconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "End Date In Milliseconds", "description": "The end epoch in milliseconds.", "examples": [1658774335000] }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source", "description": "The name of the source.", "examples": [ "Google Ads" ] }, "task_id": { "type": "string", "title": "Task Id", "description": "The ID of the task", "examples": [ "6a23130732304020886bf5f8bfcecfbc" ] }, "task_name": { "type": "string", "title": "Task Name", "description": "The name of the task", "examples": [ "Google Ads To Amazon S3" ] }, "task_status": { "allOf": [ { "$ref": "#/components/schemas/ActivityStatusEnum" } ], "description": "The status of the task", "examples": [ "succeeded" ] }, "task_type": { "const": "logic", "title": "Task Type" } }, "type": "object", "required": [ "duration", "error_description", "start_date_utc", "start_date_in_milliseconds", "end_date_utc", "end_date_in_milliseconds", "task_id", "task_name", "task_status", "task_type" ], "title": "LogicTaskProperties", "description": "Logic task properties" }, "LogicodeSizeEnum": { "type": "string", "enum": [ "XS", "S", "M", "L", "XL", "XXL" ], "title": "LogicodeSizeEnum", "description": "Enum for logic code size" }, "LogicodeStatistics": { "properties": { "logicode_rpu": { "type": "number", "title": "Logicode Rpu", "description": "The total RPUs that were consumed during this step run" }, "logicode_network_mb": { "type": "number", "title": "Logicode Network Mb", "description": "The total network (in and out) consumption of this step run" }, "logicode_duration_seconds": { "type": "number", "title": "Logicode Duration Seconds", "description": "The duration of this step" } }, "type": "object", "required": [ "logicode_rpu", "logicode_network_mb", "logicode_duration_seconds" ], "title": "LogicodeStatistics", "description": "Logicode (python) statistics" }, "LogicodeStep": { "properties": { "name": { "type": "string", "title": "Name" }, "is_enabled": { "type": "boolean", "title": "Is Enabled", "description": "A flag that indicates whether the step is enabled or not", "default": true }, "step_id": { "type": "string", "title": "Step Id", "description": "The step id", "examples": [ "76e0f1a623b444338778a189b1386126" ] }, "disable_errors": { "type": "boolean", "title": "Disable Errors", "description": "A flag that indicates whether to disable errors or not", "default": false }, "type": { "const": "logicode", "title": "Type" }, "code_type": { "const": "python", "title": "Code Type", "default": "python" }, "file_id": { "type": "string", "title": "File Id" }, "logicode_size": { "allOf": [ { "$ref": "#/components/schemas/LogicodeSizeEnum" } ], "description": "The size of container that will run the logic code" }, "additional_packages": { "items": { "type": "string" }, "type": "array", "title": "Additional Packages", "description": "Additional packages to install" } }, "type": "object", "required": [ "name", "type", "logicode_size", "file_id" ], "title": "LogicodeStep", "description": "logicode step schema" }, "LoopContainer": { "properties": { "name": { "type": "string", "title": "Name" }, "is_enabled": { "type": "boolean", "title": "Is Enabled", "description": "A flag that indicates whether the container is enabled or not", "default": true }, "container_id": { "type": "string", "title": "Container Id", "description": "The container id" }, "disable_errors": { "type": "boolean", "title": "Disable Errors", "description": "A flag that indicates whether to disable errors or not", "default": false }, "type": { "const": "loop", "title": "Type" }, "steps": { "items": { "anyOf": [ { "$ref": "#/components/schemas/RunOnceContainer" }, { "$ref": "#/components/schemas/LoopContainer" }, { "$ref": "#/components/schemas/ConditionContainer" }, { "$ref": "#/components/schemas/RunRiverStep" }, { "$ref": "#/components/schemas/ActionStep" }, { "$ref": "#/components/schemas/LogicodeStep" }, { "$ref": "#/components/schemas/AthenaSqlScriptStep" }, { "$ref": "#/components/schemas/AthenaSqlQueryStep" }, { "$ref": "#/components/schemas/AzureSynapseSqlScriptStep" }, { "$ref": "#/components/schemas/AzureSynapseSqlQueryStep" }, { "$ref": "#/components/schemas/AzureSQLSqlScriptStep" }, { "$ref": "#/components/schemas/AzureSQLSqlQueryStep" }, { "$ref": "#/components/schemas/PostgresSqlScriptStep" }, { "$ref": "#/components/schemas/PostgresSqlQueryStep" }, { "$ref": "#/components/schemas/SnowflakeDataframeStep" }, { "$ref": "#/components/schemas/SnowflakeSqlQueryStep" }, { "$ref": "#/components/schemas/SnowflakeSqlScriptStep" }, { "$ref": "#/components/schemas/BigQuerySqlScriptStep" }, { "$ref": "#/components/schemas/BigQuerySqlQueryStep" }, { "$ref": "#/components/schemas/DatabricksSqlScriptStep" }, { "$ref": "#/components/schemas/DatabricksSqlQueryStep" }, { "$ref": "#/components/schemas/RedshiftDataframeStep" }, { "$ref": "#/components/schemas/RedshiftSqlScriptStep" }, { "$ref": "#/components/schemas/RedshiftSqlQueryStep" } ] }, "type": "array", "minItems": 1, "title": "Steps" }, "loop_over_value": { "type": "string", "title": "Loop Over Value", "description": "The loop over value" }, "loop_over_variable_name": { "items": { "type": "string" }, "type": "array", "title": "Loop Over Variable Name", "description": "The loop over variable name" } }, "type": "object", "required": [ "name", "type", "steps", "loop_over_value", "loop_over_variable_name" ], "title": "LoopContainer", "description": "Loop Container Schema" }, "MSSQLAdditionalSourceSettings": { "properties": { "filter_expression": { "type": "string", "title": "Filter Expression", "description": "The filter expression of the river entity.", "default": "", "examples": [ "id \u003E 100" ] }, "source_type": { "const": "mssql", "title": "Source Type", "description": "Internal field, populated automatically", "default": "mssql" }, "last_sync_version": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Last Sync Version", "description": "Last sync version to be used for the change tracking" }, "include_deleted_rows": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Include Deleted Rows", "description": "Include deleted rows" } }, "additionalProperties": false, "type": "object", "title": "MSSQLAdditionalSourceSettings", "description": "MSSQL specific source settings" }, "MSSQLSourceCDCSettings": { "properties": { "default_tables_migration_option": { "allOf": [ { "$ref": "#/components/schemas/RiverTablesMigrationDefaultSyncOption" } ], "description": "This option determine the tables migration option. For example. Choosing SKIP_INITIAL_MIGRATIONwill cause all tables to inherit the status from the River level to be used for a one-time process.", "default": "RUN_INITIAL_MIGRATION", "examples": [ "SKIP_INITIAL_MIGRATION" ] }, "include_snapshot_tables": { "type": "boolean", "title": "Include Snapshot Tables", "description": "Indicates whether to take a snapshot of the source table before starting CDC.", "default": true }, "datasource_id": { "const": "mssql", "title": "Datasource Id", "description": "The data source id of this source", "default": "mssql" } }, "additionalProperties": false, "type": "object", "title": "MSSQLSourceCDCSettings", "description": "MSSQL Source CDC settings properties to return." }, "MariaDBAdditionalSourceSettings": { "properties": { "filter_expression": { "type": "string", "title": "Filter Expression", "description": "The filter expression of the river entity.", "default": "", "examples": [ "id \u003E 100" ] }, "source_type": { "const": "mariadb", "title": "Source Type", "description": "Internal field, populated automatically", "default": "mariadb" }, "include_end_value": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Include End Value", "description": "Include end value" } }, "additionalProperties": false, "type": "object", "title": "MariaDBAdditionalSourceSettings", "description": "MariaDB specific source settings" }, "MergeMethod": { "type": "string", "enum": [ "switch_tables", "delete_insert", "merge", "insert_on_conflict" ], "title": "MergeMethod", "description": "Enum for merge methods " }, "MergeMethodPostgres": { "type": "string", "enum": [ "delete_insert", "insert_on_conflict" ], "title": "MergeMethodPostgres", "description": "Enum for merge methods for Postgres target" }, "MergeMethodSnowflake": { "type": "string", "enum": [ "switch_tables", "delete_insert", "merge" ], "title": "MergeMethodSnowflake", "description": "Enum for merge methods for Snowflake target" }, "MongoChunkSizeType": { "type": "string", "enum": [ "dynamic", "manual" ], "title": "MongoChunkSizeType", "description": "MongoDb chunk size type" }, "MongoDBAdditionalSourceSettings": { "properties": { "chunk_size_type": { "anyOf": [ { "$ref": "#/components/schemas/MongoChunkSizeType" }, { "type": "null" } ], "description": "The method to choose how many records per chunk", "default": "dynamic" }, "max_results_file": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Results File", "description": "The maximum number of records to write to a file" }, "mapping_settings_type": { "anyOf": [ { "$ref": "#/components/schemas/MongoMappingTypeEnum" }, { "type": "null" } ], "description": "The selected mapping type for mongodb", "default": "mapping_number_of_records" }, "mapping_num_of_records": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Mapping Num Of Records", "description": "The number of records to sample for mapping" }, "mapping_records_order": { "anyOf": [ { "$ref": "#/components/schemas/MongoDBRecordsOrderTypeEnum" }, { "type": "null" } ], "description": "The order of the records to sample for mapping", "default": "Last" }, "mapping_documents_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Mapping Documents Ids", "description": "The specific selected documents id's for mapping" }, "json_example": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Json Example", "description": "JSON example representing data formation for mapping" }, "filter_expression": { "type": "string", "title": "Filter Expression", "description": "The filter expression of the river entity.", "default": "", "examples": [ "id \u003E 100" ] }, "source_type": { "const": "mongodb", "title": "Source Type", "description": "Internal field, populated automatically", "default": "mongodb" }, "concurrent_requests_number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Concurrent Requests Number", "description": "Number of connections to open concurrently to MongoDB", "default": 1, "examples": [1] } }, "additionalProperties": false, "type": "object", "title": "MongoDBAdditionalSourceSettings", "description": "MongoDB specific source settings" }, "MongoDBRecordsOrderTypeEnum": { "type": "string", "enum": [ "Last", "First" ], "title": "MongoDBRecordsOrderTypeEnum", "description": "MongoDB records order type" }, "MongoDBSourceCDCSettings": { "properties": { "default_tables_migration_option": { "allOf": [ { "$ref": "#/components/schemas/RiverTablesMigrationDefaultSyncOption" } ], "description": "This option determine the tables migration option. For example. Choosing SKIP_INITIAL_MIGRATIONwill cause all tables to inherit the status from the River level to be used for a one-time process.", "default": "RUN_INITIAL_MIGRATION", "examples": [ "SKIP_INITIAL_MIGRATION" ] }, "include_snapshot_tables": { "type": "boolean", "title": "Include Snapshot Tables", "description": "Indicates whether to take a snapshot of the source table before starting CDC.", "default": true }, "datasource_id": { "const": "mongodb", "title": "Datasource Id", "description": "The data source id of this source", "default": "mongodb" } }, "additionalProperties": false, "type": "object", "title": "MongoDBSourceCDCSettings", "description": "MongoDB Source CDC settings properties." }, "MongoMappingTypeEnum": { "type": "string", "enum": [ "mapping_number_of_records", "mapping_documents_ids", "mapping_json_example" ], "title": "MongoMappingTypeEnum", "description": "MongoDb mapping type" }, "MySQLAdditionalSourceSettings": { "properties": { "filter_expression": { "type": "string", "title": "Filter Expression", "description": "The filter expression of the river entity.", "default": "", "examples": [ "id \u003E 100" ] }, "source_type": { "const": "mysql", "title": "Source Type", "description": "Internal field, populated automatically", "default": "mysql" } }, "additionalProperties": false, "type": "object", "title": "MySQLAdditionalSourceSettings", "description": "MySQL specific source settings" }, "MysqlSourceCDCSettings": { "properties": { "default_tables_migration_option": { "allOf": [ { "$ref": "#/components/schemas/RiverTablesMigrationDefaultSyncOption" } ], "description": "This option determine the tables migration option. For example. Choosing SKIP_INITIAL_MIGRATIONwill cause all tables to inherit the status from the River level to be used for a one-time process.", "default": "RUN_INITIAL_MIGRATION", "examples": [ "SKIP_INITIAL_MIGRATION" ] }, "include_snapshot_tables": { "type": "boolean", "title": "Include Snapshot Tables", "description": "Indicates whether to take a snapshot of the source table before starting CDC.", "default": true }, "datasource_id": { "const": "mysql", "title": "Datasource Id", "description": "The data source id of this source", "default": "mysql" } }, "additionalProperties": false, "type": "object", "title": "MysqlSourceCDCSettings", "description": "Mysql Source CDC settings properties to return." }, "NetSuiteAnalyticsAdditionalSourceSettings": { "properties": { "filter_expression": { "type": "string", "title": "Filter Expression", "description": "The filter expression of the river entity.", "default": "", "examples": [ "id \u003E 100" ] }, "source_type": { "const": "netsuite_analytics", "title": "Source Type", "description": "Internal field, populated automatically", "default": "netsuite_analytics" }, "auto_detect_new_fields": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Auto Detect New Fields", "description": "Auto-detect new fields in NetSuite Analytics datasets", "default": true, "examples": [true] }, "auto_detect_tables_relations": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Auto Detect Tables Relations", "description": "Auto-detect tables relations in NetSuite Analytics datasets", "default": false, "examples": [false] } }, "additionalProperties": false, "type": "object", "title": "NetSuiteAnalyticsAdditionalSourceSettings", "description": "NetSuite Analytics specific source settings.\n\nTable-level fields: filter_expression (inherited from DatabaseAdditionalSourceSettings)\nSource-level fields: auto_detect_new_fields" }, "NewRelicServicesEnum": { "type": "string", "const": "recipe-service", "title": "NewRelicServicesEnum", "description": "Additional New Relic service subsystems to include when querying run logs.\nValues map to the SUB_SYS attribute in New Relic worker logs." }, "NotificationSettings": { "properties": { "warning": { "anyOf": [ { "$ref": "#/components/schemas/RiverNotificationReport" }, { "type": "null" } ], "description": "Notification report for warning." }, "failure": { "anyOf": [ { "$ref": "#/components/schemas/RiverNotificationReport" }, { "type": "null" } ], "description": "Notification report for failure." }, "run_threshold": { "anyOf": [ { "$ref": "#/components/schemas/RiverNotificationReport" }, { "type": "null" } ], "description": "Notification report for run threshold." } }, "type": "object", "title": "NotificationSettings", "description": "Notification settings properties for the entire river\n(define what to do on warning, error, failure/timeout)" }, "OperationResponse": { "properties": { "operation_id": { "type": "string", "title": "Operation Id", "description": "The ID of the operation", "examples": [ "62e7f4352c13160013dc39be" ] }, "operation_type": { "type": "string", "title": "Operation Type", "description": "The type of the operation", "examples": [ "dataframe" ] }, "run_id": { "type": "string", "title": "Run Id", "description": "The run id of the operation", "examples": [ "5cbc6bbbc90a4658b00c70a3bb0f3b31" ] }, "last_update_date": { "type": "string", "format": "date-time", "title": "Last Update Date", "description": "The date time in UTC timezone of the last update", "examples": [ "2022-08-02T13:38:44.054000" ] }, "status": { "allOf": [ { "$ref": "#/components/schemas/PullRequestStatus" } ], "description": "The current status of the operation id", "examples": [ "D" ] }, "result": { "anyOf": [ { }, { "type": "null" } ], "title": "Result", "description": "The result of the operation", "examples": [ "true" ] }, "error_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Message", "description": "The error message of the operation", "examples": [ "[RVR-QBK-003]: Response value error: Missing Rows/Columns" ] } }, "type": "object", "required": [ "operation_id", "operation_type", "run_id", "last_update_date", "status" ], "title": "OperationResponse", "description": "Operation properties to return." }, "OracleAdditionalSourceSettings": { "properties": { "filter_expression": { "type": "string", "title": "Filter Expression", "description": "The filter expression of the river entity.", "default": "", "examples": [ "id \u003E 100" ] }, "source_type": { "const": "oracle", "title": "Source Type", "description": "Internal field, populated automatically", "default": "oracle" } }, "additionalProperties": false, "type": "object", "title": "OracleAdditionalSourceSettings", "description": "Oracle specific source settings" }, "OracleSourceCDCSettings": { "properties": { "default_tables_migration_option": { "allOf": [ { "$ref": "#/components/schemas/RiverTablesMigrationDefaultSyncOption" } ], "description": "This option determine the tables migration option. For example. Choosing SKIP_INITIAL_MIGRATIONwill cause all tables to inherit the status from the River level to be used for a one-time process.", "default": "RUN_INITIAL_MIGRATION", "examples": [ "SKIP_INITIAL_MIGRATION" ] }, "include_snapshot_tables": { "type": "boolean", "title": "Include Snapshot Tables", "description": "Indicates whether to take a snapshot of the source table before starting CDC.", "default": true }, "datasource_id": { "const": "oracle", "title": "Datasource Id", "description": "The data source id of this source", "default": "oracle" } }, "additionalProperties": false, "type": "object", "title": "OracleSourceCDCSettings", "description": "Oracle Source CDC settings properties to return." }, "PartitionedKindEnum": { "type": "string", "enum": [ "by_day", "by_hour", "by_minute" ], "title": "PartitionedKindEnum", "description": "Partitioned kind for storages" }, "PartitioningByTimestamp": { "properties": { "partition_by": { "const": "timestamp", "title": "Partition By" }, "partition_granularity": { "type": "string", "enum": [ "YEAR", "MONTH", "DAY", "HOUR" ], "title": "Partition Granularity", "default": "DAY" } }, "type": "object", "required": [ "partition_by" ], "title": "PartitioningByTimestamp", "description": "Partitioning by timestamp schema" }, "PatchActiveUserInput": { "properties": { "is_active": { "type": "boolean", "title": "Is Active", "description": "The user is active flag" } }, "type": "object", "required": [ "is_active" ], "title": "PatchActiveUserInput", "description": "Patch is_active user input" }, "PatchEnvironmentInput": { "properties": { "environment_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Environment Name", "description": "The environment name", "examples": [ "Dev Environment" ] }, "color": { "anyOf": [ { "$ref": "#/components/schemas/EnvironmentsColorEnum" }, { "type": "null" } ], "description": "The environment color as shown in the app", "examples": [ "Gray.400" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "The environment description", "examples": [ "Development environment for new rivers" ] }, "is_default": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Default", "description": "A flag that indicates whether the environment is the account's default environment", "examples": [true] } }, "type": "object", "title": "PatchEnvironmentInput", "description": "Patch Environment Model" }, "PatchUserInput": { "properties": { "user_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Name", "description": "The user name" }, "environments": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Environments", "description": "Environment dictionary that includes roles per environment", "examples": [ { "6271166896834700109da341": { "role": "developer" }, "6271166896834700109da342": { "role": "connection_viewer" } } ] }, "is_admin": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Admin", "description": "Indicate if the user admin" }, "allow_login_google": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Allow Login Google", "description": "Indicate if allow to the user login with google" }, "allow_login_password": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Allow Login Password", "description": "Indicate if allow to the user login with password" } }, "type": "object", "title": "PatchUserInput", "description": "Patch user input" }, "PatchUserTeamsInput": { "properties": { "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name", "description": "The display name", "examples": [ "Boomi Data Integration Core Team" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Internal description", "examples": [ "Some description" ] }, "environments": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Environments", "description": "Dictionary of environment id and environment role", "examples": [ { "5f887c764c40e5598f717676": { "role": "viewer" }, "633ede20f1fc5500111fd7b3": { "role": "viewer" } } ] }, "default_environment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Default Environment", "description": "Default Environment ID for this team (Optional)", "examples": [ "633ede20f1fc5500111fd7b3" ] }, "is_all_environment_admin": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is All Environment Admin", "description": "Indicates if group have Admin permission for all environment", "examples": [true] } }, "type": "object", "title": "PatchUserTeamsInput", "description": "Request patch user groups input." }, "PostgreSQLAdditionalSourceSettings": { "properties": { "filter_expression": { "type": "string", "title": "Filter Expression", "description": "The filter expression of the river entity.", "default": "", "examples": [ "id \u003E 100" ] }, "source_type": { "const": "postgresql", "title": "Source Type", "description": "Internal field, populated automatically", "default": "postgresql" }, "include_timezone": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Include Timezone", "description": "Decide if to include timezone in timestamp values" }, "timezone_offset": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Timezone Offset", "description": "timezone offset when adding timezone to timestamp values", "default": 0 } }, "additionalProperties": false, "type": "object", "title": "PostgreSQLAdditionalSourceSettings", "description": "PostgreSQL specific source settings" }, "PostgresModifiedColumn": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the column is selected and should be modified.", "examples": [true] }, "name": { "type": "string", "title": "Name", "description": "The name of the column.", "examples": [ "column_name" ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type", "description": "The type of the column.", "examples": [ "string" ] }, "alias": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Alias", "description": "The alias of the column in the target table.", "examples": [ "column_alias" ] }, "expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expression", "description": "This tells us the column is an expression or not so we know if it suppose to exist in the source / target or is it auto generated.", "examples": [ "select 'test'" ] }, "is_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Key", "description": "If the column is a key.", "examples": [true] }, "cluster_key": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cluster Key", "description": "The sort order of the column (number) in the cluster, used in the merge process to determine the order of the merge keys.", "examples": [1] }, "calculated_column_mode": { "anyOf": [ { "$ref": "#/components/schemas/CalculatedColumnModeEnum" }, { "type": "null" } ], "description": "The mode of the calculated column.Help to identify if the column is source expression or target expression,required if the column is an expression.", "examples": [ "source" ] }, "order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Order", "description": "The order of the column in the expression,required if the column is an expression.", "examples": [1] }, "mode": { "anyOf": [ { "$ref": "#/components/schemas/ColumnModeEnum" }, { "type": "null" } ], "description": "The mode of the column in the target table" }, "is_rivery_metadata": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Rivery Metadata", "description": "Whether the column includes rivery metadata" }, "target_type": { "const": "postgres_rds", "title": "Target Type", "description": "Internal field, populated automatically", "default": "postgres_rds" } }, "additionalProperties": false, "type": "object", "required": [ "is_selected", "name" ], "title": "PostgresModifiedColumn", "description": "Postgres specific columns settings" }, "PostgresSourceCDCSettings": { "properties": { "default_tables_migration_option": { "allOf": [ { "$ref": "#/components/schemas/RiverTablesMigrationDefaultSyncOption" } ], "description": "This option determine the tables migration option. For example. Choosing SKIP_INITIAL_MIGRATIONwill cause all tables to inherit the status from the River level to be used for a one-time process.", "default": "RUN_INITIAL_MIGRATION", "examples": [ "SKIP_INITIAL_MIGRATION" ] }, "include_snapshot_tables": { "type": "boolean", "title": "Include Snapshot Tables", "description": "Indicates whether to take a snapshot of the source table before starting CDC.", "default": true }, "datasource_id": { "const": "postgres", "title": "Datasource Id", "description": "The data source id of this source", "default": "postgres" }, "custom_replication_slot": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Replication Slot", "description": "The custom replication slot of this source", "examples": [ "custom_replication_slot" ] }, "custom_publication": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Publication", "description": "The custom publication of this source", "examples": [ "custom_publication" ] } }, "additionalProperties": false, "type": "object", "title": "PostgresSourceCDCSettings", "description": "Postgres Source CDC settings properties to return." }, "PostgresSqlQueryStep": { "properties": { "name": { "type": "string", "title": "Name" }, "is_enabled": { "type": "boolean", "title": "Is Enabled", "description": "A flag that indicates whether the step is enabled or not", "default": true }, "step_id": { "type": "string", "title": "Step Id", "description": "The step id", "examples": [ "76e0f1a623b444338778a189b1386126" ] }, "disable_errors": { "type": "boolean", "title": "Disable Errors", "description": "A flag that indicates whether to disable errors or not", "default": false }, "connection_id": { "type": "string", "title": "Connection Id" }, "sql_query": { "type": "string", "title": "Sql Query" }, "type": { "const": "postgres_sql_query", "title": "Type" }, "target_settings": { "oneOf": [ { "$ref": "#/components/schemas/TargetVariableProperties" }, { "$ref": "#/components/schemas/PostgresTargetTableProperties" }, { "$ref": "#/components/schemas/PostgresTargetFileProperties" } ], "title": "Target Settings", "discriminator": { "propertyName": "target_type", "mapping": { "files_export": "#/components/schemas/PostgresTargetFileProperties", "table": "#/components/schemas/PostgresTargetTableProperties", "variable": "#/components/schemas/TargetVariableProperties" } } } }, "type": "object", "required": [ "name", "sql_query", "type", "target_settings", "connection_id" ], "title": "PostgresSqlQueryStep", "description": "Postgres SQL Query Step Schema" }, "PostgresSqlScriptStep": { "properties": { "name": { "type": "string", "title": "Name" }, "is_enabled": { "type": "boolean", "title": "Is Enabled", "description": "A flag that indicates whether the step is enabled or not", "default": true }, "step_id": { "type": "string", "title": "Step Id", "description": "The step id", "examples": [ "76e0f1a623b444338778a189b1386126" ] }, "disable_errors": { "type": "boolean", "title": "Disable Errors", "description": "A flag that indicates whether to disable errors or not", "default": false }, "connection_id": { "type": "string", "title": "Connection Id" }, "sql_query": { "type": "string", "title": "Sql Query" }, "type": { "const": "postgres_sql_script", "title": "Type" } }, "type": "object", "required": [ "name", "sql_query", "type", "connection_id" ], "title": "PostgresSqlScriptStep", "description": "Postgres SQL Script Step Schema" }, "PostgresTableAdditionalTargetSettings": { "properties": { "is_ordered_merge_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Ordered Merge Key", "description": "If the table got any and should consider filter out duplicates data between source filemerge process(by order).", "default": false, "examples": [true] }, "order_expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Expression", "description": "The order expression of the river entity,to filter duplications from the source data by the provided order expression (for `merge` loading method).", "examples": [ "id desc,createDate asc" ] }, "target_loading": { "anyOf": [ { "$ref": "#/components/schemas/LoadingMode" }, { "type": "null" } ], "description": "The target loading of the table entity,if not specified the default loading mode of the riverwill be used.", "examples": [ "merge" ] }, "target_type": { "const": "postgres_rds", "title": "Target Type", "description": "Internal field, populated automatically", "default": "postgres_rds" }, "merge_method": { "anyOf": [ { "$ref": "#/components/schemas/MergeMethodPostgres" }, { "type": "null" } ], "description": "The merge method of the table, if not specified the default merge method of the riverwill be used.", "examples": [ "insert_on_conflict" ] }, "analyze_table": { "type": "boolean", "title": "Analyze Table", "description": "Analyze the tables after the load process", "default": true } }, "type": "object", "title": "PostgresTableAdditionalTargetSettings", "description": "Postgres specific target settings" }, "PostgresTargetFileProperties": { "properties": { "target_type": { "const": "files_export", "title": "Target Type" }, "bucket_name": { "type": "string", "title": "Bucket Name" }, "file_path": { "type": "string", "title": "File Path" }, "connection_id": { "type": "string", "title": "Connection Id" } }, "type": "object", "required": [ "target_type", "bucket_name", "file_path", "connection_id" ], "title": "PostgresTargetFileProperties", "description": "Postgres Target File Properties Schema" }, "PostgresTargetSettings": { "properties": { "name": { "const": "postgres_rds", "title": "Name", "description": "The name of the target", "default": "postgres_rds" }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Id", "description": "The connection ID of this target", "examples": [ "5f4d3b3d9f9c8b0001f6b0e6" ] }, "connection_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Name", "description": "The connection name of this target", "examples": [ "Connection 1" ] }, "single_table_settings": { "anyOf": [ { "$ref": "#/components/schemas/SingleTableSettings" }, { "type": "null" } ], "description": "Single table specific settings for the target" }, "table_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Table Name", "description": "The table name of this target (only relevant for non multi table source to target rivers)", "default": "", "examples": [ "Table 1" ] }, "target_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Prefix", "description": "The table prefix of this target (only relevant for multi table source to target rivers)", "default": "", "examples": [ "start_at_" ] }, "is_ordered_merge_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Ordered Merge Key", "description": "If the table got any and should consider filter out duplicates data between source filemerge process(by order).", "default": false, "examples": [true] }, "order_expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Expression", "description": "The order expression of the river entity.", "examples": [ "id desc,createDate asc" ] }, "loading_method": { "allOf": [ { "$ref": "#/components/schemas/LoadingMode" } ], "description": "The loading method of this target", "examples": [ "merge" ] }, "merge_method": { "anyOf": [ { "$ref": "#/components/schemas/MergeMethodPostgres" }, { "type": "null" } ], "description": "The merge method to preform,only relevant when the loading mode is Merge,if not provided the default merge method will be used.(delete - insert)", "examples": [ "insert_on_conflict" ] }, "file_zone_settings": { "anyOf": [ { "$ref": "#/components/schemas/RiverFileZoneSettings" }, { "type": "null" } ], "description": "The file zone settings of this target" }, "file_path_destination": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Path Destination", "description": "The file name and path", "examples": [ "path/to/file" ] }, "additional_settings": { "type": "object", "title": "Additional Settings", "description": "The additional settings of this target", "default": { }, "examples": [ { "key": "value" } ] }, "schema_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Name", "description": "The schema name of this target", "examples": [ "Schema 1" ] }, "analyze_table": { "type": "boolean", "title": "Analyze Table", "description": "Analyze the tables after the load process", "default": true } }, "type": "object", "required": [ "loading_method" ], "title": "PostgresTargetSettings", "description": "Postgres target settings properties to return." }, "PostgresTargetTableMergeSettings": { "properties": { "merge_method": { "type": "string", "title": "Merge Method" }, "is_ordered_merge": { "type": "boolean", "title": "Is Ordered Merge", "description": "A flag that indicates whether the merge is ordered or not", "default": false }, "order_expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Expression", "description": "The order expression" } }, "type": "object", "required": [ "merge_method" ], "title": "PostgresTargetTableMergeSettings", "description": "Postgres Target Table Merge Settings Schema" }, "PostgresTargetTableProperties": { "properties": { "target_type": { "const": "table", "title": "Target Type" }, "table_name": { "type": "string", "title": "Table Name" }, "drop_after": { "type": "boolean", "title": "Drop After", "description": "A flag that indicates whether to drop the table after the run or not", "default": false }, "schema_name": { "type": "string", "title": "Schema Name" }, "loading_mode": { "type": "string", "enum": [ "append_only", "overwrite", "upsert_merge" ], "title": "Loading Mode", "default": "append_only" }, "merge_settings": { "anyOf": [ { "$ref": "#/components/schemas/PostgresTargetTableMergeSettings" }, { "type": "null" } ], "description": "The merge settings" }, "fields": { "items": { "type": "object" }, "type": "array", "title": "Fields", "description": "The mapping", "default": [] }, "analyze_tables": { "type": "boolean", "title": "Analyze Tables", "description": "A flag that indicates whether to analyze the tables or not", "default": true } }, "type": "object", "required": [ "target_type", "table_name", "schema_name" ], "title": "PostgresTargetTableProperties", "description": "Postgres Target Table Properties Schema" }, "PredefinedReportShopifyTableInput": { "properties": { "run_type_and_datasource": { "const": "predefined_report_shopify", "title": "Run Type And Datasource", "description": "Internal field", "default": "predefined_report_shopify" }, "details": { "anyOf": [ { "$ref": "#/components/schemas/WriteShopifyPredefinedOrdersReport" }, { "$ref": "#/components/schemas/WriteShopifyPredefinedShopReport" }, { "$ref": "#/components/schemas/WriteShopifyPredefinedAddressesReport" }, { "$ref": "#/components/schemas/WriteShopifyPredefinedAnalyticReport" }, { "$ref": "#/components/schemas/WriteShopifyPredefinedCustomersReport" }, { "$ref": "#/components/schemas/WriteShopifyPredefinedInventoryLevelsReport" }, { "$ref": "#/components/schemas/WriteShopifyPredefinedMarketingEventsReport" }, { "$ref": "#/components/schemas/WriteShopifyPredefinedOrderTransactionsReport" }, { "$ref": "#/components/schemas/WriteShopifyPredefinedProductsReport" } ], "title": "Details", "description": "The predefined report table details" } }, "additionalProperties": false, "type": "object", "required": [ "details" ], "title": "PredefinedReportShopifyTableInput", "description": "Table properties which define the predefined report table data\nThis schema is being used for read" }, "ProductsIncrementalFieldEnum": { "type": "string", "enum": [ "updated at", "created at", "published at" ], "title": "ProductsIncrementalFieldEnum", "description": "Shopify products incremental field enum" }, "PullRequestStatus": { "type": "string", "enum": [ "W", "E", "R", "D" ], "title": "PullRequestStatus", "description": "The status of the pull request that we use in the back, and expose in the API" }, "ReInviteUserInput": { "properties": { "user_email": { "type": "string", "title": "User Email", "description": "The user email" } }, "type": "object", "required": [ "user_email" ], "title": "ReInviteUserInput", "description": "Re Invite user input" }, "RecipeAdditionalSourceSettings": { "properties": { "filter_expression": { "type": "string", "title": "Filter Expression", "description": "The filter expression of the river entity.", "default": "", "examples": [ "id \u003E 100" ] }, "source_type": { "const": "blueprint", "title": "Source Type", "description": "Internal field, populated automatically", "default": "blueprint" }, "interface_parameters": { "anyOf": [ { "$ref": "#/components/schemas/InterfaceParameters" }, { "type": "null" } ], "description": "The interface parameters" } }, "additionalProperties": false, "type": "object", "title": "RecipeAdditionalSourceSettings", "description": "Recipe specific source settings" }, "RedshiftAdditionalSourceSettings": { "properties": { "filter_expression": { "type": "string", "title": "Filter Expression", "description": "The filter expression of the river entity.", "default": "", "examples": [ "id \u003E 100" ] }, "source_type": { "const": "redshift", "title": "Source Type", "description": "Internal field, populated automatically", "default": "redshift" } }, "additionalProperties": false, "type": "object", "title": "RedshiftAdditionalSourceSettings", "description": "Redshift specific source settings" }, "RedshiftCsvFileSettings": { "properties": { "file_type": { "const": "csv", "title": "File Type", "description": "The file type", "default": "csv" }, "file_delimiter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Delimiter" }, "quote_char": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Quote Char" }, "include_header": { "type": "boolean", "title": "Include Header", "default": false }, "compression": { "type": "string", "enum": [ "none", "gzip", "bz2" ], "title": "Compression", "description": "The compression type", "default": "none" } }, "type": "object", "title": "RedshiftCsvFileSettings", "description": "Redshift CSV File Settings Schema" }, "RedshiftDataframeStep": { "properties": { "name": { "type": "string", "title": "Name" }, "is_enabled": { "type": "boolean", "title": "Is Enabled", "description": "A flag that indicates whether the step is enabled or not", "default": true }, "step_id": { "type": "string", "title": "Step Id", "description": "The step id", "examples": [ "76e0f1a623b444338778a189b1386126" ] }, "disable_errors": { "type": "boolean", "title": "Disable Errors", "description": "A flag that indicates whether to disable errors or not", "default": false }, "connection_id": { "type": "string", "title": "Connection Id" }, "type": { "const": "redshift_dataframe", "title": "Type" }, "dataframe_name": { "type": "string", "title": "Dataframe Name" }, "target_properties": { "$ref": "#/components/schemas/RedshiftTargetTableWithoutMappingProperties" } }, "type": "object", "required": [ "name", "type", "dataframe_name", "target_properties", "connection_id" ], "title": "RedshiftDataframeStep", "description": "Dataframe Redshift Step Schema" }, "RedshiftModifiedColumn": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the column is selected and should be modified.", "examples": [true] }, "name": { "type": "string", "title": "Name", "description": "The name of the column.", "examples": [ "column_name" ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type", "description": "The type of the column.", "examples": [ "string" ] }, "alias": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Alias", "description": "The alias of the column in the target table.", "examples": [ "column_alias" ] }, "expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expression", "description": "This tells us the column is an expression or not so we know if it suppose to exist in the source / target or is it auto generated.", "examples": [ "select 'test'" ] }, "is_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Key", "description": "If the column is a key.", "examples": [true] }, "cluster_key": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cluster Key", "description": "The sort order of the column (number) in the cluster, used in the merge process to determine the order of the merge keys.", "examples": [1] }, "calculated_column_mode": { "anyOf": [ { "$ref": "#/components/schemas/CalculatedColumnModeEnum" }, { "type": "null" } ], "description": "The mode of the calculated column.Help to identify if the column is source expression or target expression,required if the column is an expression.", "examples": [ "source" ] }, "order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Order", "description": "The order of the column in the expression,required if the column is an expression.", "examples": [1] }, "mode": { "anyOf": [ { "$ref": "#/components/schemas/ColumnModeEnum" }, { "type": "null" } ], "description": "The mode of the column in the target table" }, "is_rivery_metadata": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Rivery Metadata", "description": "Whether the column includes rivery metadata" }, "target_type": { "const": "redshift", "title": "Target Type", "description": "Internal field, populated automatically", "default": "redshift" }, "length": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Length", "description": "The length of VARCHAR columns.", "examples": [256] }, "scale": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Scale", "description": "The scale of DECIMAL columns.", "examples": [0] }, "precision": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Precision", "description": "The precision of DECIMAL columns.", "examples": [18] }, "is_dist_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Dist Key", "description": "If the column is a unique Distkey column on which the table is distributed to each node", "examples": [true] }, "sort_order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Sort Order", "description": "The sort order of the column (number), sort order are used in the merge process to determine the order of the merge keys.", "examples": [1] } }, "additionalProperties": false, "type": "object", "required": [ "is_selected", "name" ], "title": "RedshiftModifiedColumn", "description": "Redshift specific columns settings" }, "RedshiftSqlQueryStep": { "properties": { "name": { "type": "string", "title": "Name" }, "is_enabled": { "type": "boolean", "title": "Is Enabled", "description": "A flag that indicates whether the step is enabled or not", "default": true }, "step_id": { "type": "string", "title": "Step Id", "description": "The step id", "examples": [ "76e0f1a623b444338778a189b1386126" ] }, "disable_errors": { "type": "boolean", "title": "Disable Errors", "description": "A flag that indicates whether to disable errors or not", "default": false }, "connection_id": { "type": "string", "title": "Connection Id" }, "type": { "const": "redshift_sql_query", "title": "Type" }, "sql_query": { "type": "string", "title": "Sql Query" }, "keep_schema_binding_view": { "type": "boolean", "title": "Keep Schema Binding View", "default": false }, "target_settings": { "oneOf": [ { "$ref": "#/components/schemas/RedshiftTargetTableWithMappingProperties" }, { "$ref": "#/components/schemas/TargetDataframeProperties" }, { "$ref": "#/components/schemas/TargetVariableProperties" }, { "$ref": "#/components/schemas/RedshiftTargetFileProperties" } ], "title": "Target Settings", "discriminator": { "propertyName": "target_type", "mapping": { "dataframe": "#/components/schemas/TargetDataframeProperties", "files_export": "#/components/schemas/RedshiftTargetFileProperties", "table": "#/components/schemas/RedshiftTargetTableWithMappingProperties", "variable": "#/components/schemas/TargetVariableProperties" } } } }, "type": "object", "required": [ "name", "type", "sql_query", "target_settings", "connection_id" ], "title": "RedshiftSqlQueryStep", "description": "SQL Query Redshift Step Schema" }, "RedshiftSqlScriptStep": { "properties": { "name": { "type": "string", "title": "Name" }, "is_enabled": { "type": "boolean", "title": "Is Enabled", "description": "A flag that indicates whether the step is enabled or not", "default": true }, "step_id": { "type": "string", "title": "Step Id", "description": "The step id", "examples": [ "76e0f1a623b444338778a189b1386126" ] }, "disable_errors": { "type": "boolean", "title": "Disable Errors", "description": "A flag that indicates whether to disable errors or not", "default": false }, "connection_id": { "type": "string", "title": "Connection Id" }, "type": { "const": "redshift_sql_script", "title": "Type" }, "sql_query": { "type": "string", "title": "Sql Query" }, "keep_schema_binding_view": { "type": "boolean", "title": "Keep Schema Binding View", "default": false } }, "type": "object", "required": [ "name", "type", "sql_query", "connection_id" ], "title": "RedshiftSqlScriptStep", "description": "Redshift SQL Script Step Schema" }, "RedshiftTableAdditionalTargetSettings": { "properties": { "is_ordered_merge_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Ordered Merge Key", "description": "If the table got any and should consider filter out duplicates data between source filemerge process(by order).", "default": false, "examples": [true] }, "order_expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Expression", "description": "The order expression of the river entity,to filter duplications from the source data by the provided order expression (for `merge` loading method).", "examples": [ "id desc,createDate asc" ] }, "target_loading": { "anyOf": [ { "$ref": "#/components/schemas/LoadingMode" }, { "type": "null" } ], "description": "The target loading of the table entity,if not specified the default loading mode of the riverwill be used.", "examples": [ "merge" ] }, "target_type": { "const": "redshift", "title": "Target Type", "description": "Internal field, populated automatically", "default": "redshift" }, "distribution_method": { "allOf": [ { "$ref": "#/components/schemas/DistributionMethodEnum" } ], "description": "The distribution method of the target.", "default": "even", "examples": [ "even" ] }, "merge_method": { "anyOf": [ { "$ref": "#/components/schemas/MergeMethod" }, { "type": "null" } ], "description": "The merge method of the table, if not specified the default merge method of the riverwill be used.", "examples": [ "merge" ] } }, "type": "object", "title": "RedshiftTableAdditionalTargetSettings", "description": "Redshift specific target settings" }, "RedshiftTargetFileProperties": { "properties": { "target_type": { "const": "files_export", "title": "Target Type" }, "bucket_name": { "type": "string", "title": "Bucket Name" }, "file_path": { "type": "string", "title": "File Path" }, "connection_id": { "type": "string", "title": "Connection Id" }, "file_type": { "const": "csv", "title": "File Type", "description": "The file type", "default": "csv" }, "load_into_single_file": { "type": "boolean", "title": "Load Into Single File", "description": "A flag that indicates whether to load into a single file or not", "default": false }, "file_settings": { "$ref": "#/components/schemas/RedshiftCsvFileSettings" } }, "type": "object", "required": [ "target_type", "bucket_name", "file_path", "connection_id", "file_settings" ], "title": "RedshiftTargetFileProperties", "description": "Redshift Target File Properties Schema" }, "RedshiftTargetSettings": { "properties": { "name": { "const": "redshift", "title": "Name", "description": "The name of the target", "default": "redshift" }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Id", "description": "The connection ID of this target", "examples": [ "5f4d3b3d9f9c8b0001f6b0e6" ] }, "connection_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Name", "description": "The connection name of this target", "examples": [ "Connection 1" ] }, "single_table_settings": { "anyOf": [ { "$ref": "#/components/schemas/SingleTableSettings" }, { "type": "null" } ], "description": "Single table specific settings for the target" }, "table_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Table Name", "description": "The table name of this target (only relevant for non multi table source to target rivers)", "default": "", "examples": [ "Table 1" ] }, "target_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Prefix", "description": "The table prefix of this target (only relevant for multi table source to target rivers)", "default": "", "examples": [ "start_at_" ] }, "is_ordered_merge_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Ordered Merge Key", "description": "If the table got any and should consider filter out duplicates data between source filemerge process(by order).", "default": false, "examples": [true] }, "order_expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Expression", "description": "The order expression of the river entity.", "examples": [ "id desc,createDate asc" ] }, "loading_method": { "allOf": [ { "$ref": "#/components/schemas/LoadingMode" } ], "description": "The loading method of this target", "examples": [ "merge" ] }, "merge_method": { "anyOf": [ { "$ref": "#/components/schemas/MergeMethod" }, { "type": "null" } ], "description": "The merge method to preform,only relevant when the loading mode is Merge,if not provided the default merge method will be used.(merge)", "examples": [ "merge" ] }, "file_zone_settings": { "anyOf": [ { "$ref": "#/components/schemas/RiverFileZoneSettings" }, { "type": "null" } ], "description": "The file zone settings of this target" }, "file_path_destination": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Path Destination", "description": "The file name and path", "examples": [ "path/to/file" ] }, "additional_settings": { "type": "object", "title": "Additional Settings", "description": "The additional settings of this target", "default": { }, "examples": [ { "key": "value" } ] }, "schema_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Name", "description": "The schema name of this target", "examples": [ "Schema 1" ] } }, "type": "object", "required": [ "loading_method" ], "title": "RedshiftTargetSettings", "description": "Redshift target settings properties to return." }, "RedshiftTargetTableMergeSettings": { "properties": { "merge_method": { "type": "string", "title": "Merge Method" }, "is_ordered_merge": { "type": "boolean", "title": "Is Ordered Merge", "description": "A flag that indicates whether the merge is ordered or not", "default": false }, "order_expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Expression", "description": "The order expression" } }, "type": "object", "required": [ "merge_method" ], "title": "RedshiftTargetTableMergeSettings", "description": "Redshift Target Table Merge Settings Schema" }, "RedshiftTargetTableWithMappingProperties": { "properties": { "target_type": { "const": "table", "title": "Target Type" }, "table_name": { "type": "string", "title": "Table Name" }, "drop_after": { "type": "boolean", "title": "Drop After", "description": "A flag that indicates whether to drop the table after the run or not", "default": false }, "schema_name": { "type": "string", "title": "Schema Name", "description": "The Redshift schema" }, "distribution_method": { "type": "string", "enum": [ "all", "even", "key" ], "title": "Distribution Method", "default": "even" }, "loading_mode": { "type": "string", "enum": [ "append_only", "overwrite", "upsert_merge" ], "title": "Loading Mode", "description": "The loading mode", "default": "append_only" }, "merge_settings": { "anyOf": [ { "$ref": "#/components/schemas/RedshiftTargetTableMergeSettings" }, { "type": "null" } ], "description": "The merge settings" }, "fields": { "items": { "type": "object" }, "type": "array", "title": "Fields", "description": "The mapping" }, "mapping_order": { "items": { "type": "string" }, "type": "array", "title": "Mapping Order", "description": "The mapping order", "default": [] } }, "type": "object", "required": [ "target_type", "table_name", "schema_name" ], "title": "RedshiftTargetTableWithMappingProperties", "description": "Redshift Target Table With Mapping Properties Schema" }, "RedshiftTargetTableWithoutMappingProperties": { "properties": { "target_type": { "const": "table", "title": "Target Type" }, "table_name": { "type": "string", "title": "Table Name" }, "drop_after": { "type": "boolean", "title": "Drop After", "description": "A flag that indicates whether to drop the table after the run or not", "default": false }, "schema_name": { "type": "string", "title": "Schema Name", "description": "The Redshift schema" }, "distribution_method": { "type": "string", "enum": [ "all", "even", "key" ], "title": "Distribution Method", "default": "even" }, "loading_mode": { "type": "string", "enum": [ "append_only", "overwrite" ], "title": "Loading Mode", "default": "append_only" } }, "type": "object", "required": [ "target_type", "table_name", "schema_name" ], "title": "RedshiftTargetTableWithoutMappingProperties", "description": "Redshift Target Table Properties Schema" }, "RestoreRiverVersionInput": { "properties": { "version_id": { "type": "string", "title": "Version Id", "description": "The id of the version to restore.", "examples": [ "5f7d4270fdca16cac18261" ] } }, "additionalProperties": false, "type": "object", "required": [ "version_id" ], "title": "RestoreRiverVersionInput", "description": "Input for restoring a river version" }, "RiverActivityRun": { "properties": { "run_id": { "type": "string", "title": "Run Id", "description": "The run ID", "examples": [ "5658a1c9ea724ee59f048cbb5a6f734a" ] }, "river_cross_id": { "type": "string", "title": "River Cross Id", "description": "The river cross ID", "examples": [ "507f191e810c19729de860ea" ] }, "datasource_id": { "type": "string", "title": "Datasource Id", "description": "The datasource ID", "examples": [ "mysql" ] }, "error_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Description", "description": "The error description if any", "examples": [ "error" ] }, "units": { "type": "number", "title": "Units", "description": "Total RPU (units)", "examples": [2.1] }, "rpu": { "type": "number", "title": "Rpu", "description": "Total RPU", "examples": [2.1] }, "run_group_id": { "type": "string", "title": "Run Group Id", "description": "The run group id", "examples": [ "201dcf8182ad4a59868cb41b957fdc8d" ] }, "status": { "$ref": "#/components/schemas/ActivityStatusEnum" }, "source_name": { "type": "string", "title": "Source Name", "description": "The name of the source", "examples": [ "mysql" ] }, "target_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Name", "description": "The target table name", "examples": [ "table" ] }, "start_date_utc": { "type": "string", "format": "date-time", "title": "Start Date Utc", "description": "The start date time in UTC timezone.Time format YYYY-MM-DDThh:mm:ss.ms", "examples": [ "2022-07-25T18:38:55.640Z" ] }, "start_date_in_milliseconds": { "type": "integer", "title": "Start Date In Milliseconds", "description": "The start epoch in milliseconds.", "examples": [1658774335000] }, "end_date_utc": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Date Utc", "description": "The end date time in UTC timezone.Time format YYYY-MM-DDThh:mm:ss.ms", "examples": [ "2022-07-25T18:38:55.640Z" ] }, "end_date_in_milliseconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "End Date In Milliseconds", "description": "The end epoch in milliseconds.", "examples": [1658774335000] }, "sub_river_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sub River Id", "description": "The sub river id", "examples": [ "507f191e810c19729de860ea" ] }, "is_sub_river_run": { "type": "boolean", "title": "Is Sub River Run", "description": "A flag that indicates whether this run is of a sub river or not", "examples": [false] }, "is_high_frequency": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is High Frequency", "description": "A flag that indicates whether this run is high frequency or not", "default": false, "examples": [false, true] }, "pricing_category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pricing Category", "description": "The RPU policy rule object for calculating an RPU" } }, "type": "object", "required": [ "run_id", "river_cross_id", "datasource_id", "error_description", "units", "rpu", "run_group_id", "status", "source_name", "start_date_utc", "start_date_in_milliseconds", "end_date_utc", "end_date_in_milliseconds", "is_sub_river_run" ], "title": "RiverActivityRun", "description": "A run" }, "RiverActivityRunGroup": { "properties": { "run_group_id": { "type": "string", "title": "Run Group Id", "description": "The run group id", "examples": [ "201dcf8182ad4a59868cb41b957fdc8d" ] }, "status": { "type": "string", "title": "Status" }, "units": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Units", "description": "Total RPU (units)", "examples": [2.1] }, "rpu": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Rpu", "description": "Total RPU", "examples": [2.1] }, "max_duration_in_milliseconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Duration In Milliseconds" }, "run_date_epoch_milliseconds": { "type": "integer", "title": "Run Date Epoch Milliseconds" }, "run_date_utc": { "type": "string", "format": "date-time", "title": "Run Date Utc" }, "run_end_date_epoch_milliseconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Run End Date Epoch Milliseconds", "description": "The end epoch in milliseconds.", "examples": [1658774335000] }, "run_end_date_utc": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Run End Date Utc", "description": "The end date time in UTC timezone.Time format YYYY-MM-DDThh:mm:ss.ms", "examples": [ "2022-07-25T18:38:55.640Z" ] } }, "type": "object", "required": [ "run_group_id", "status", "units", "rpu", "run_date_epoch_milliseconds", "run_date_utc", "run_end_date_epoch_milliseconds", "run_end_date_utc" ], "title": "RiverActivityRunGroup", "description": "The run group details" }, "RiverActivityRunGroupResponse": { "properties": { "next_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Page", "description": "The next page URL" }, "previous_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Page", "description": "The previous page URL" }, "page": { "type": "integer", "title": "Page", "description": "The page number", "default": 1 }, "current_page_size": { "type": "integer", "title": "Current Page Size", "description": "The current page size" }, "total_items": { "type": "integer", "title": "Total Items", "description": "The total number of entities fetched", "default": 0 }, "account_id": { "type": "string", "title": "Account Id", "description": "The account id" }, "environment_id": { "type": "string", "title": "Environment Id", "description": "The environment id" }, "items": { "items": { "$ref": "#/components/schemas/RiverActivityRunGroup" }, "type": "array", "title": "Items" }, "river_cross_id": { "type": "string", "title": "River Cross Id" } }, "type": "object", "required": [ "current_page_size", "account_id", "environment_id", "items", "river_cross_id" ], "title": "RiverActivityRunGroupResponse", "description": "The response for the activity run groups" }, "RiverActivityRunGroupWithStatistics": { "properties": { "run_group_id": { "type": "string", "title": "Run Group Id", "description": "The run group id", "examples": [ "201dcf8182ad4a59868cb41b957fdc8d" ] }, "status": { "type": "string", "title": "Status" }, "units": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Units", "description": "Total RPU (units)", "examples": [2.1] }, "rpu": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Rpu", "description": "Total RPU", "examples": [2.1] }, "max_duration_in_milliseconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Duration In Milliseconds" }, "run_date_epoch_milliseconds": { "type": "integer", "title": "Run Date Epoch Milliseconds" }, "run_date_utc": { "type": "string", "format": "date-time", "title": "Run Date Utc" }, "run_end_date_epoch_milliseconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Run End Date Epoch Milliseconds", "description": "The end epoch in milliseconds.", "examples": [1658774335000] }, "run_end_date_utc": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Run End Date Utc", "description": "The end date time in UTC timezone.Time format YYYY-MM-DDThh:mm:ss.ms", "examples": [ "2022-07-25T18:38:55.640Z" ] }, "running": { "type": "integer", "title": "Running" }, "canceled": { "type": "integer", "title": "Canceled" }, "pending": { "type": "integer", "title": "Pending" }, "failed": { "type": "integer", "title": "Failed" }, "succeeded": { "type": "integer", "title": "Succeeded" }, "skipped": { "type": "integer", "title": "Skipped" } }, "type": "object", "required": [ "run_group_id", "status", "units", "rpu", "run_date_epoch_milliseconds", "run_date_utc", "run_end_date_epoch_milliseconds", "run_end_date_utc", "running", "canceled", "pending", "failed", "succeeded", "skipped" ], "title": "RiverActivityRunGroupWithStatistics", "description": "The run group details with statistics" }, "RiverActivityRunLogicStepsLogsResponse": { "properties": { "logs_url": { "type": "string", "title": "Logs Url" } }, "type": "object", "required": [ "logs_url" ], "title": "RiverActivityRunLogicStepsLogsResponse", "description": "run's logic step logs" }, "RiverActivityRunLogicStepsResponse": { "properties": { "account_id": { "type": "string", "title": "Account Id" }, "environment_id": { "type": "string", "title": "Environment Id" }, "river_cross_id": { "type": "string", "title": "River Cross Id" }, "run_id": { "type": "string", "title": "Run Id" }, "steps": { "additionalProperties": { "$ref": "#/components/schemas/LogicStep" }, "type": "object", "title": "Steps" } }, "type": "object", "required": [ "account_id", "environment_id", "river_cross_id", "run_id", "steps" ], "title": "RiverActivityRunLogicStepsResponse", "description": "run's logic step" }, "RiverActivityRunTasksResponse": { "properties": { "account_id": { "type": "string", "title": "Account Id" }, "environment_id": { "type": "string", "title": "Environment Id" }, "river_cross_id": { "type": "string", "title": "River Cross Id" }, "run_id": { "type": "string", "title": "Run Id" }, "items": { "items": { "oneOf": [ { "$ref": "#/components/schemas/ActionTaskProperties" }, { "$ref": "#/components/schemas/SourceToTargetTaskProperties" }, { "$ref": "#/components/schemas/LogicTaskProperties" } ], "discriminator": { "propertyName": "task_type", "mapping": { "actions": "#/components/schemas/ActionTaskProperties", "logic": "#/components/schemas/LogicTaskProperties", "source_to_target": "#/components/schemas/SourceToTargetTaskProperties" } } }, "type": "array", "title": "Items" }, "pricing_category": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Pricing Category", "description": "The RPU policy rule object for calculating an RPU" }, "units": { "type": "number", "title": "Units", "description": "Total RPU (units)", "examples": [2.1] }, "rpu": { "type": "number", "title": "Rpu", "description": "Total RPU", "examples": [2.1] } }, "type": "object", "required": [ "account_id", "environment_id", "river_cross_id", "run_id", "items", "units", "rpu" ], "title": "RiverActivityRunTasksResponse", "description": "Run's task response" }, "RiverActivityRunsResponse": { "properties": { "next_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Page", "description": "The next page URL" }, "previous_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Page", "description": "The previous page URL" }, "page": { "type": "integer", "title": "Page", "description": "The page number", "default": 1 }, "current_page_size": { "type": "integer", "title": "Current Page Size", "description": "The current page size" }, "total_items": { "type": "integer", "title": "Total Items", "description": "The total number of entities fetched", "default": 0 }, "account_id": { "type": "string", "title": "Account Id", "description": "The account id" }, "environment_id": { "type": "string", "title": "Environment Id", "description": "The environment id" }, "items": { "items": { "$ref": "#/components/schemas/RiverActivityRun" }, "type": "array", "title": "Items" }, "river_cross_id": { "type": "string", "title": "River Cross Id" } }, "type": "object", "required": [ "current_page_size", "account_id", "environment_id", "items", "river_cross_id" ], "title": "RiverActivityRunsResponse", "description": "The activity run response" }, "RiverActivityStatisticResponse": { "properties": { "account_id": { "type": "string", "title": "Account Id" }, "environment_id": { "type": "string", "title": "Environment Id" }, "total_units": { "type": "number", "title": "Total Units", "description": "Total RPU (units)", "examples": [2.1] }, "total_rpu": { "type": "number", "title": "Total Rpu", "description": "Total RPU", "examples": [2.1] }, "running": { "type": "integer", "title": "Running" }, "canceled": { "type": "integer", "title": "Canceled" }, "pending": { "type": "integer", "title": "Pending" }, "failed": { "type": "integer", "title": "Failed" }, "succeeded": { "type": "integer", "title": "Succeeded" }, "skipped": { "type": "integer", "title": "Skipped" }, "river_cross_id": { "type": "string", "title": "River Cross Id" } }, "type": "object", "required": [ "account_id", "environment_id", "total_units", "total_rpu", "running", "canceled", "pending", "failed", "succeeded", "skipped", "river_cross_id" ], "title": "RiverActivityStatisticResponse", "description": "Statistics response" }, "RiverActivitySubRiver": { "properties": { "sub_river_id": { "type": "string", "title": "Sub River Id" }, "sub_river_name": { "type": "string", "title": "Sub River Name" } }, "type": "object", "required": [ "sub_river_id", "sub_river_name" ], "title": "RiverActivitySubRiver", "description": "Activity's sub river" }, "RiverActivitySubRiverResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/RiverActivitySubRiver" }, "type": "array", "title": "Items" }, "account_id": { "type": "string", "title": "Account Id" }, "environment_id": { "type": "string", "title": "Environment Id" }, "river_cross_id": { "type": "string", "title": "River Cross Id" } }, "type": "object", "required": [ "items", "account_id", "environment_id", "river_cross_id" ], "title": "RiverActivitySubRiverResponse", "description": "The response of the sub river" }, "RiverActivityTarget": { "properties": { "target_name": { "type": "string", "title": "Target Name" }, "status": { "$ref": "#/components/schemas/ActivityStatusEnum" }, "units": { "type": "number", "title": "Units", "description": "Total RPU (units)", "examples": [2.1] }, "rpu": { "type": "number", "title": "Rpu", "description": "Total RPU", "examples": [2.1] }, "last_run": { "type": "string", "format": "date-time", "title": "Last Run" } }, "type": "object", "required": [ "target_name", "status", "units", "rpu", "last_run" ], "title": "RiverActivityTarget", "description": "The activity target" }, "RiverActivityTargetResponse": { "properties": { "items": { "items": { "$ref": "#/components/schemas/RiverActivityTarget" }, "type": "array", "title": "Items" }, "account_id": { "type": "string", "title": "Account Id" }, "environment_id": { "type": "string", "title": "Environment Id" }, "river_cross_id": { "type": "string", "title": "River Cross Id" } }, "type": "object", "required": [ "items", "account_id", "environment_id", "river_cross_id" ], "title": "RiverActivityTargetResponse", "description": "Target response" }, "RiverFileZoneSettings": { "properties": { "path": { "type": "string", "title": "Path", "description": "The path of the file zone entity.", "examples": [ "my_path" ] }, "bucket_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bucket Name", "description": "The bucket name of the file zone entity.", "examples": [ "my_bucket" ] }, "partitioned_kind": { "allOf": [ { "$ref": "#/components/schemas/PartitionedKindEnum" } ], "description": "The partitioned kind of the file zone entity.", "examples": [ "by_day" ] }, "fz_loading_mode": { "type": "string", "title": "Fz Loading Mode", "description": "File zone loading mode", "default": "auto-period" } }, "type": "object", "required": [ "path", "partitioned_kind" ], "title": "RiverFileZoneSettings", "description": "River File zone settings properties to return." }, "RiverInterfaceEnum": { "type": "string", "enum": [ "all", "new" ], "title": "RiverInterfaceEnum", "description": "River interface type enum. The 'new' represents v2 rivers" }, "RiverIntervalTypeEnum": { "type": "string", "enum": [ "datetime", "runningnumber", "epoch", "row_version" ], "title": "RiverIntervalTypeEnum", "description": "Interval types options of the incremental field for rivers that are running incrementally" }, "RiverKindEnum": { "type": "string", "enum": [ "sub_river", "main_river" ], "title": "RiverKindEnum", "description": "River kind" }, "RiverListResponse": { "properties": { "next_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Page", "description": "The next page URL" }, "previous_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Page", "description": "The previous page URL" }, "page": { "type": "integer", "title": "Page", "description": "The page number", "default": 1 }, "current_page_size": { "type": "integer", "title": "Current Page Size", "description": "The current page size" }, "total_items": { "type": "integer", "title": "Total Items", "description": "The total number of entities fetched", "default": 0 }, "account_id": { "type": "string", "title": "Account Id", "description": "The account id" }, "environment_id": { "type": "string", "title": "Environment Id", "description": "The environment id" }, "items": { "items": { "$ref": "#/components/schemas/ListRiverObject" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "current_page_size", "account_id", "environment_id", "items" ], "title": "RiverListResponse", "description": "List rivers response object." }, "RiverMetadata": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "The description of the river.", "default": "", "examples": [ "River 1 description" ] }, "river_status": { "allOf": [ { "$ref": "#/components/schemas/RiverStatusEnum" } ], "description": "The status of the river.", "default": "disabled", "examples": [ "active" ] } }, "type": "object", "title": "RiverMetadata", "description": "River metadata properties for the CREATE" }, "RiverMetadataExtended": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "The description of the river.", "default": "", "examples": [ "River 1 description" ] }, "river_status": { "allOf": [ { "$ref": "#/components/schemas/RiverStatusEnum" } ], "description": "The status of the river.", "default": "disabled", "examples": [ "active" ] }, "current_version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Current Version Id", "description": "The current version ID of the river.", "examples": [ "5f4d3b3d9f9c8b0001f6b0e6" ] }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By", "description": "The User that created the river.", "examples": [ "SomeUser" ] }, "last_updated_by": { "type": "string", "title": "Last Updated By", "description": "The User that last updated the river.", "examples": [ "SomeUser" ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "The date the river was created.", "examples": [ "2020-09-01T00:00:00Z" ] }, "last_updated_at": { "type": "string", "format": "date-time", "title": "Last Updated At", "description": "The date the river was last updated.", "examples": [ "2020-09-01T12:00:00.000Z" ] }, "is_deleted": { "type": "boolean", "title": "Is Deleted", "description": "Indication if the river was deleted", "default": false } }, "type": "object", "required": [ "last_updated_by", "created_at", "last_updated_at" ], "title": "RiverMetadataExtended", "description": "Extended RiverMetadata to be returned with the GET" }, "RiverModel": { "properties": { "cross_id": { "type": "string", "title": "Cross Id", "description": "The river cross id.", "examples": [ "62e7f4352c13160013dc39be" ] }, "account_id": { "type": "string", "title": "Account Id", "description": "The account id.", "examples": [ "62e7f4352c13160013dc39be" ] }, "kind": { "allOf": [ { "$ref": "#/components/schemas/RiverKindEnum" } ], "description": "The kind of the river.", "default": "main_river", "examples": [ "main_river" ] }, "type": { "allOf": [ { "$ref": "#/components/schemas/RiverTypeEnum" } ], "description": "The type of the river.", "examples": [ "source_to_target" ] }, "name": { "type": "string", "title": "Name", "description": "The name of the river.", "examples": [ "my_river" ] }, "environment_id": { "type": "string", "title": "Environment Id", "description": "The environment cross id.", "examples": [ "62e7f4352c13160013dc39be" ] }, "environment_name": { "type": "string", "title": "Environment Name", "description": "The environment name.", "examples": [ "my_environment" ] }, "group_id": { "type": "string", "title": "Group Id", "description": "The group id.", "examples": [ "62e7f4352c13160013dc39be" ] }, "group_name": { "type": "string", "title": "Group Name", "description": "The group name.", "examples": [ "my_group" ] }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/RiverMetadataExtended" } ], "description": "The river metadata." }, "properties": { "oneOf": [ { "$ref": "#/components/schemas/SourceToTargetRiverProperties" }, { "$ref": "#/components/schemas/ActionProperties" }, { "$ref": "#/components/schemas/LogicProperties" } ], "title": "Properties", "description": "The river properties, will change according to the river type.", "discriminator": { "propertyName": "properties_type", "mapping": { "actions": "#/components/schemas/ActionProperties", "logic": "#/components/schemas/LogicProperties", "source_to_target": "#/components/schemas/SourceToTargetRiverProperties" } } }, "settings": { "anyOf": [ { "$ref": "#/components/schemas/RiverSettings" }, { "type": "null" } ], "description": "River settings." }, "schedulers": { "anyOf": [ { "items": { "$ref": "#/components/schemas/RiverSchedule" }, "type": "array" }, { "type": "null" } ], "title": "Schedulers", "description": "River schedulers.", "default": [] } }, "type": "object", "required": [ "cross_id", "account_id", "type", "name", "environment_id", "environment_name", "group_id", "group_name", "metadata", "properties" ], "title": "RiverModel", "description": "River properties to return" }, "RiverNotificationReport": { "properties": { "email": { "type": "string", "title": "Email", "description": "Email address to send the report to in case of failure.", "examples": [ "test@test.com" ] }, "is_enabled": { "type": "boolean", "title": "Is Enabled", "description": "A flag that indicates whether the notification is enabled.", "default": false, "examples": [true] }, "execution_time_limit_seconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Execution Time Limit Seconds", "description": "The execution time limit in seconds of the river before reporting, only relevant for on run_threshold.", "examples": [43200] } }, "type": "object", "required": [ "email" ], "title": "RiverNotificationReport", "description": "River Notification Report properties\n " }, "RiverRunResponse": { "properties": { "sub_river_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sub River Id", "description": "The river cross id", "examples": [ "62e7f4352c13160013dc39be" ] }, "run_id": { "type": "string", "title": "Run Id", "description": "The run id of the run process", "examples": [ "1f1468d097754cd8892468c2763ebfe8" ] }, "status": { "allOf": [ { "$ref": "#/components/schemas/ActivityStatusEnum" } ], "description": "the status of the run process", "examples": [ "pending" ] }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message", "description": "the message of the run process", "examples": [ "The river is already in progress." ] } }, "type": "object", "required": [ "run_id", "status" ], "title": "RiverRunResponse", "description": "Run properties to return" }, "RiverSchedule": { "properties": { "cron_expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cron Expression", "description": "The cron expression of the river entity.", "examples": [ "* * * * *" ] }, "is_enabled": { "type": "boolean", "title": "Is Enabled", "description": "The is enabled of the river.", "default": false, "examples": [true] } }, "type": "object", "title": "RiverSchedule", "description": "River schedule properties to return.\n " }, "RiverScheduleStatusEnum": { "type": "string", "enum": [ "all", "scheduled", "unscheduled" ], "title": "RiverScheduleStatusEnum", "description": "River schedule status enum" }, "RiverSearchItem": { "properties": { "name": { "type": "string", "title": "Name", "description": "Name of the river", "examples": [ "river_name" ] }, "river_status": { "allOf": [ { "$ref": "#/components/schemas/RiverStatusEnum" } ], "description": "Status of the river", "examples": [ "active" ] }, "group_name": { "type": "string", "title": "Group Name", "description": "Name of the group associated with the river", "examples": [ "river_group_1" ] }, "group_id": { "type": "string", "title": "Group Id", "description": "the id of the group associated with the river", "examples": [ "62e7f4352c13160013dc39be" ] }, "river_schedulers": { "items": { "type": "string" }, "type": "array", "title": "River Schedulers", "description": "List of schedulers used for the river", "examples": [ [ "0 * * * *", "0 0 1 * *" ] ] }, "datasource_id": { "type": "string", "title": "Datasource Id", "description": "Source ID of the river", "examples": [ "mysql" ] }, "target_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Type", "description": "Target ID of the river", "examples": [ "snowflake" ] }, "last_user_name_modified": { "type": "string", "title": "Last User Name Modified", "description": "User name of the last modifier", "examples": [ "user_name" ] }, "river_cross_id": { "type": "string", "title": "River Cross Id", "description": "River cross ID", "examples": [ "5f7d4270fdca16cac18261" ] }, "last_updated_at": { "type": "string", "format": "date-time", "title": "Last Updated At", "description": "Last time the river was modified", "examples": [ "2021-01-01T00:00:00.000Z" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Description of the river, if available", "examples": [ "CDC River MySql -\u003E Snowflake to be used by the BI team" ] }, "is_api_v2": { "type": "boolean", "title": "Is Api V2", "description": "Flag indicating whether the river is using API v2", "examples": [true] }, "river_type": { "allOf": [ { "$ref": "#/components/schemas/RiverTypeEnum" } ], "description": "Type of the river", "examples": [ "source_to_target" ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "Time the river was created", "examples": [ "2021-01-01T00:00:00.000Z" ] }, "source_task_connection_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Task Connection Name", "description": "Connection name of the source", "examples": [ "connection_name" ] }, "match_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Match Reason", "description": "Search query match - a list of reasons why this river was returned", "default": "", "examples": [ "river_name=river1" ] }, "suspended": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Suspended", "description": "Suspension status tracking for chronically failing rivers", "examples": [ { "notification_date": "2025-01-01T00:00:00", "suspension_date": "2025-01-08T00:00:00" } ] } }, "type": "object", "required": [ "name", "river_status", "group_id", "river_schedulers", "datasource_id", "river_cross_id", "last_updated_at", "is_api_v2", "river_type", "created_at" ], "title": "RiverSearchItem", "description": "Represents a river search result item, returned by the API to the user.\nto be used in tandem with the RiverSearchResponse model." }, "RiverSearchResponse": { "properties": { "next_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Page", "description": "The next page URL" }, "previous_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Page", "description": "The previous page URL" }, "page": { "type": "integer", "title": "Page", "description": "The page number", "default": 1 }, "current_page_size": { "type": "integer", "title": "Current Page Size", "description": "The current page size" }, "total_items": { "type": "integer", "title": "Total Items", "description": "The total number of entities fetched", "default": 0 }, "account_id": { "type": "string", "title": "Account Id", "description": "The account id" }, "environment_id": { "type": "string", "title": "Environment Id", "description": "The environment id" }, "items": { "items": { "$ref": "#/components/schemas/RiverSearchItem" }, "type": "array", "title": "Items", "description": "The list of rivers." }, "items_per_page": { "type": "integer", "title": "Items Per Page", "description": "The number of items per page." }, "request": { "title": "Request", "description": "the original search request" } }, "type": "object", "required": [ "current_page_size", "account_id", "environment_id", "items", "items_per_page", "request" ], "title": "RiverSearchResponse", "description": "List rivers response object." }, "RiverSearchSortByEnum": { "type": "string", "enum": [ "river_date_updated", "group_name", "river_name" ], "title": "RiverSearchSortByEnum", "description": "The river search sort by filter enum provide all the sort by options." }, "RiverSearchStatusEnum": { "type": "string", "enum": [ "active", "disabled", "suspended" ], "title": "RiverSearchStatusEnum", "description": "River status enum for search, includes suspended state.\nUnlike RiverStatusEnum, this enum includes SUSPENDED which is determined\nby the presence of suspended.suspension_date field on the river object." }, "RiverSettings": { "properties": { "run_timeout_seconds": { "type": "integer", "title": "Run Timeout Seconds", "description": "The timeout of the river in seconds.", "default": 43200, "examples": [43200] }, "notification": { "anyOf": [ { "$ref": "#/components/schemas/NotificationSettings" }, { "type": "null" } ], "description": "River notification settings." } }, "type": "object", "title": "RiverSettings", "description": "River settings properties to return.\n " }, "RiverStatusEnum": { "type": "string", "enum": [ "active", "disabled" ], "title": "RiverStatusEnum", "description": "River status enum.\nUsed in the is_enabled field which is part of the river properties.\nDisabled status for a river means the river cannot be executed while active status river can." }, "RiverTablesMigrationDefaultSyncOption": { "type": "string", "enum": [ "SKIP_INITIAL_MIGRATION", "RUN_INITIAL_MIGRATION" ], "title": "RiverTablesMigrationDefaultSyncOption", "description": "Each river can have a few options when it comes to migration of tables\n1. skip_initial_migration: will mean that the tables will inherit the status from the river and skip the migration\n2. run_initial_migration: (default for most cases) will mean that tables will fully migrate in the first run" }, "RiverTimePeriodEnum": { "type": "string", "enum": [ "custom", "yesterday", "today", "last_7_days", "last_365_days", "week_to_date", "previous_week", "previous_week_to_date", "last_week", "month_to_date", "previous_month", "previous_month_to_date", "year_to_date" ], "title": "RiverTimePeriodEnum", "description": "River supported time periods" }, "RiverTypeEnum": { "type": "string", "enum": [ "source_to_target", "actions", "logic", "connector_executor" ], "title": "RiverTypeEnum", "description": "All of the EXTERNAL river types" }, "RiverTypeInternalEnum": { "type": "string", "enum": [ "src_to_trgt", "src_to_fz", "actions", "logic" ], "title": "RiverTypeInternalEnum", "description": "All of the INTERNAL river types\nCustomers only familiar with river_type src_to_trgt, actions and logic. Internally we have another river type\ncalled src_to_fz." }, "RiverVariableSettings": { "properties": { "clear_value_on_start": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Clear Value On Start", "description": "Option for clearing variable on river start", "default": false, "examples": [false] }, "is_multi_value": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Multi Value", "description": "Indicator for variable containing multiple values", "default": false, "examples": [false] }, "is_encrypted": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Encrypted", "description": "Option for encrypting variable value", "default": false, "examples": [true] }, "is_private": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Private", "description": "Option for private variable value in source to target rivers", "default": false, "examples": [false] }, "add_to_results": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Add To Results", "description": "Add variables to results for actions river", "examples": [false] } }, "type": "object", "title": "RiverVariableSettings", "description": "Variable settings fields.\n " }, "RiverVariablesFields": { "properties": { "account": { "type": "string", "title": "Account", "description": "The account of the river", "examples": [ "55fr7d4270fdca16cac18261" ] }, "env_id": { "type": "string", "title": "Env Id", "description": "The environment of the river", "examples": [ "55fr7d4270fdca16cac18261" ] }, "river_id": { "type": "string", "title": "River Id", "description": "The ID of the river", "examples": [ "55fr7d4270fdca16cac18261" ] }, "name": { "type": "string", "title": "Name", "description": "The name of the variable", "examples": [ "credentials" ] }, "settings": { "type": "object", "title": "Settings", "description": "variable settings", "examples": [ { "clear_value_on_start": true, "is_encrypted": false, "is_multi_value": false, "is_private": false } ] }, "value": { "anyOf": [ { "type": "string" }, { "items": { }, "type": "array" }, { "type": "null" } ], "title": "Value", "description": "value of variable", "examples": [ "1234" ] } }, "type": "object", "required": [ "account", "env_id", "river_id", "name", "settings" ], "title": "RiverVariablesFields", "description": "River variable properties to return.\n " }, "RiverVariablesPaginatedResponse": { "properties": { "next_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Page", "description": "The next page URL" }, "previous_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Page", "description": "The previous page URL" }, "page": { "type": "integer", "title": "Page", "description": "The page number", "default": 1 }, "current_page_size": { "type": "integer", "title": "Current Page Size", "description": "The current page size" }, "total_items": { "type": "integer", "title": "Total Items", "description": "The total number of entities fetched", "default": 0 }, "account_id": { "type": "string", "title": "Account Id", "description": "The account id" }, "environment_id": { "type": "string", "title": "Environment Id", "description": "The environment id" }, "items": { "items": { "$ref": "#/components/schemas/RiverVariablesFields" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "current_page_size", "account_id", "environment_id", "items" ], "title": "RiverVariablesPaginatedResponse", "description": "Final river variables paginated response for all variables in a single river.\n " }, "RiverVersionMetadata": { "properties": { "account_id": { "type": "string", "title": "Account Id", "description": "The account id of the river version", "examples": [ "55fr7d4270fdca16cac18261" ] }, "user_info": { "anyOf": [ { "$ref": "#/components/schemas/UserInfo" }, { "type": "null" } ], "description": "Contains user name and user email information" }, "environment_id": { "type": "string", "title": "Environment Id", "description": "The environment id of the river version", "examples": [ "55fr7d4270fdca16cac18261" ] }, "insert_date": { "type": "string", "format": "date-time", "title": "Insert Date", "description": "The insert date time of the river version in UTC timezone", "examples": [ "2022-08-02T13:38:44.054000" ] }, "version_id": { "type": "string", "title": "Version Id", "description": "The version id of the river version", "examples": [ "55fr7d4270fdca16cac18261" ] }, "previous_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Version", "description": "The previous version id of the river version", "examples": [ "55fr7d4270fdca16cac18261" ] }, "created_by": { "type": "string", "title": "Created By", "description": "The creator id of the river version", "examples": [ "55fr7d4270fdca16cac18261" ] }, "river_id": { "type": "string", "title": "River Id", "description": "The river id of the river version", "examples": [ "55fr7d4270fdca16cac18261" ] }, "restored_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Restored By", "description": "The restore id of the river version", "examples": [ "55fr7d4270fdca16cac18261" ] }, "restore_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Restore Date", "description": "The restore date time of the river version in UTC timezone", "examples": [ "2022-08-02T13:38:44.054000" ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of river version", "examples": [ "river_version_name" ] }, "bookmarked": { "type": "boolean", "title": "Bookmarked", "description": "Flag indicating whether the river version is bookmarked or not", "default": false, "examples": [false] } }, "type": "object", "required": [ "account_id", "environment_id", "insert_date", "version_id", "created_by", "river_id" ], "title": "RiverVersionMetadata", "description": "River Versions metadata. This class does not contain the version itself.\n " }, "RiverVersions": { "properties": { "account_id": { "type": "string", "title": "Account Id", "description": "The account id of the river version", "examples": [ "55fr7d4270fdca16cac18261" ] }, "user_info": { "anyOf": [ { "$ref": "#/components/schemas/UserInfo" }, { "type": "null" } ], "description": "Contains user name and user email information" }, "environment_id": { "type": "string", "title": "Environment Id", "description": "The environment id of the river version", "examples": [ "55fr7d4270fdca16cac18261" ] }, "insert_date": { "type": "string", "format": "date-time", "title": "Insert Date", "description": "The insert date time of the river version in UTC timezone", "examples": [ "2022-08-02T13:38:44.054000" ] }, "version_id": { "type": "string", "title": "Version Id", "description": "The version id of the river version", "examples": [ "55fr7d4270fdca16cac18261" ] }, "previous_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Version", "description": "The previous version id of the river version", "examples": [ "55fr7d4270fdca16cac18261" ] }, "created_by": { "type": "string", "title": "Created By", "description": "The creator id of the river version", "examples": [ "55fr7d4270fdca16cac18261" ] }, "river_id": { "type": "string", "title": "River Id", "description": "The river id of the river version", "examples": [ "55fr7d4270fdca16cac18261" ] }, "restored_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Restored By", "description": "The restore id of the river version", "examples": [ "55fr7d4270fdca16cac18261" ] }, "restore_date": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Restore Date", "description": "The restore date time of the river version in UTC timezone", "examples": [ "2022-08-02T13:38:44.054000" ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name", "description": "Name of river version", "examples": [ "river_version_name" ] }, "bookmarked": { "type": "boolean", "title": "Bookmarked", "description": "Flag indicating whether the river version is bookmarked or not", "default": false, "examples": [false] }, "river": { "anyOf": [ { "$ref": "#/components/schemas/LegacyRiverResponse" }, { "$ref": "#/components/schemas/RiverModel" } ], "title": "River", "description": "The definition of the river version", "examples": [ { "river definition": "some definition" } ] } }, "type": "object", "required": [ "account_id", "environment_id", "insert_date", "version_id", "created_by", "river_id", "river" ], "title": "RiverVersions", "description": "River Versions properties to return.\n " }, "RiverVersionsResponse": { "properties": { "next_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Page", "description": "The next page URL" }, "previous_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Page", "description": "The previous page URL" }, "page": { "type": "integer", "title": "Page", "description": "The page number", "default": 1 }, "current_page_size": { "type": "integer", "title": "Current Page Size", "description": "The current page size" }, "total_items": { "type": "integer", "title": "Total Items", "description": "The total number of entities fetched", "default": 0 }, "account_id": { "type": "string", "title": "Account Id", "description": "The account id" }, "environment_id": { "type": "string", "title": "Environment Id", "description": "The environment id" }, "statistics": { "$ref": "#/components/schemas/RiverVersionsStats" }, "items": { "items": { "$ref": "#/components/schemas/RiverVersionMetadata" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "current_page_size", "account_id", "environment_id", "statistics", "items" ], "title": "RiverVersionsResponse", "description": "River Versions response.\n " }, "RiverVersionsStats": { "properties": { "bookmarked_versions": { "type": "integer", "title": "Bookmarked Versions", "description": "Number of bookmarked river versions", "examples": [3] }, "bookmarks_allowed": { "type": "integer", "title": "Bookmarks Allowed", "description": "Maximum number of bookmarked river versions allowed", "examples": [30] }, "total_versions": { "type": "integer", "title": "Total Versions", "description": "Total number of existing river versions", "examples": [3] }, "snapshot_versions": { "type": "integer", "title": "Snapshot Versions", "description": "Number of snapshot river versions", "examples": [2] }, "versions_allowed": { "type": "integer", "title": "Versions Allowed", "description": "Maximum number of non-bookmarked river versions allowed", "examples": [70] } }, "type": "object", "required": [ "bookmarked_versions", "bookmarks_allowed", "total_versions", "snapshot_versions", "versions_allowed" ], "title": "RiverVersionsStats", "description": "River versions stats fields.\n " }, "RiversRunResponse": { "properties": { "runs": { "items": { "$ref": "#/components/schemas/RiverRunResponse" }, "type": "array", "title": "Runs" }, "river_cross_id": { "type": "string", "title": "River Cross Id" }, "run_group_id": { "type": "string", "title": "Run Group Id" } }, "type": "object", "required": [ "runs", "river_cross_id", "run_group_id" ], "title": "RiversRunResponse", "description": "Run response properties to return\nThe response is a list since in the case of sub rivers that are multiple runs,\nand we want to be able to return them all" }, "RowVersion": { "properties": { "include_end_value": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Include End Value", "description": "Whether to include or exclude the end_value in the range", "examples": [true] }, "rows_in_chunk": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Rows In Chunk", "description": "The rows in chunk of the river entity.", "examples": [1000] }, "start_value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Start Value", "description": "The start value of the river entity.", "examples": [ "version" ] }, "end_value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "End Value", "description": "The end value of the river entity.", "examples": [ "version" ] } }, "type": "object", "title": "RowVersion", "description": "Row version settings for incremental extraction.\nOnly available for MSSQL and PostgreSQL sources.\nHas the same structure as RunningNumber but uses ROW_VERSION interval type." }, "RunGroupSortByEnum": { "type": "string", "enum": [ "units", "last_run", "max_duration" ], "title": "RunGroupSortByEnum", "description": "Activities sort properties in the UI." }, "RunGroupStatusEnum": { "type": "string", "enum": [ "partially succeeded", "pending", "canceled", "succeeded", "failed", "running", "skipped" ], "title": "RunGroupStatusEnum", "description": "The run group enum provide all the status that run group can have." }, "RunOnceContainer": { "properties": { "name": { "type": "string", "title": "Name" }, "is_enabled": { "type": "boolean", "title": "Is Enabled", "description": "A flag that indicates whether the container is enabled or not", "default": true }, "container_id": { "type": "string", "title": "Container Id", "description": "The container id" }, "disable_errors": { "type": "boolean", "title": "Disable Errors", "description": "A flag that indicates whether to disable errors or not", "default": false }, "type": { "const": "run_once", "title": "Type" }, "is_parallel": { "type": "boolean", "title": "Is Parallel", "description": "A flag that indicates whether the container is parallel or not", "default": false }, "steps": { "items": { "oneOf": [ { "$ref": "#/components/schemas/RunOnceContainer" }, { "$ref": "#/components/schemas/LoopContainer" }, { "$ref": "#/components/schemas/ConditionContainer" }, { "$ref": "#/components/schemas/RunRiverStep" }, { "$ref": "#/components/schemas/ActionStep" }, { "$ref": "#/components/schemas/LogicodeStep" }, { "$ref": "#/components/schemas/AthenaSqlScriptStep" }, { "$ref": "#/components/schemas/AthenaSqlQueryStep" }, { "$ref": "#/components/schemas/AzureSynapseSqlScriptStep" }, { "$ref": "#/components/schemas/AzureSynapseSqlQueryStep" }, { "$ref": "#/components/schemas/AzureSQLSqlScriptStep" }, { "$ref": "#/components/schemas/AzureSQLSqlQueryStep" }, { "$ref": "#/components/schemas/PostgresSqlScriptStep" }, { "$ref": "#/components/schemas/PostgresSqlQueryStep" }, { "$ref": "#/components/schemas/SnowflakeDataframeStep" }, { "$ref": "#/components/schemas/SnowflakeSqlQueryStep" }, { "$ref": "#/components/schemas/SnowflakeSqlScriptStep" }, { "$ref": "#/components/schemas/BigQuerySqlScriptStep" }, { "$ref": "#/components/schemas/BigQuerySqlQueryStep" }, { "$ref": "#/components/schemas/DatabricksSqlScriptStep" }, { "$ref": "#/components/schemas/DatabricksSqlQueryStep" }, { "$ref": "#/components/schemas/RedshiftDataframeStep" }, { "$ref": "#/components/schemas/RedshiftSqlScriptStep" }, { "$ref": "#/components/schemas/RedshiftSqlQueryStep" } ], "discriminator": { "propertyName": "type", "mapping": { "action": "#/components/schemas/ActionStep", "athena_sql_query": "#/components/schemas/AthenaSqlQueryStep", "athena_sql_script": "#/components/schemas/AthenaSqlScriptStep", "azure_sql_query": "#/components/schemas/AzureSQLSqlQueryStep", "azure_sql_script": "#/components/schemas/AzureSQLSqlScriptStep", "azure_synapse_sql_query": "#/components/schemas/AzureSynapseSqlQueryStep", "azure_synapse_sql_script": "#/components/schemas/AzureSynapseSqlScriptStep", "bigquery_sql_query": "#/components/schemas/BigQuerySqlQueryStep", "bigquery_sql_script": "#/components/schemas/BigQuerySqlScriptStep", "condition": "#/components/schemas/ConditionContainer", "databricks_sql_query": "#/components/schemas/DatabricksSqlQueryStep", "databricks_sql_script": "#/components/schemas/DatabricksSqlScriptStep", "logicode": "#/components/schemas/LogicodeStep", "loop": "#/components/schemas/LoopContainer", "postgres_sql_query": "#/components/schemas/PostgresSqlQueryStep", "postgres_sql_script": "#/components/schemas/PostgresSqlScriptStep", "redshift_dataframe": "#/components/schemas/RedshiftDataframeStep", "redshift_sql_query": "#/components/schemas/RedshiftSqlQueryStep", "redshift_sql_script": "#/components/schemas/RedshiftSqlScriptStep", "river": "#/components/schemas/RunRiverStep", "run_once": "#/components/schemas/RunOnceContainer", "snowflake_dataframe": "#/components/schemas/SnowflakeDataframeStep", "snowflake_sql_query": "#/components/schemas/SnowflakeSqlQueryStep", "snowflake_sql_script": "#/components/schemas/SnowflakeSqlScriptStep" } } }, "type": "array", "minItems": 1, "title": "Steps" } }, "type": "object", "required": [ "name", "type", "steps" ], "title": "RunOnceContainer", "description": "Run Once Container Schema" }, "RunRiverStep": { "properties": { "name": { "type": "string", "title": "Name" }, "is_enabled": { "type": "boolean", "title": "Is Enabled", "description": "A flag that indicates whether the step is enabled or not", "default": true }, "step_id": { "type": "string", "title": "Step Id", "description": "The step id", "examples": [ "76e0f1a623b444338778a189b1386126" ] }, "disable_errors": { "type": "boolean", "title": "Disable Errors", "description": "A flag that indicates whether to disable errors or not", "default": false }, "type": { "const": "river", "title": "Type" }, "river_id": { "type": "string", "title": "River Id" }, "input_variables": { "type": "object", "title": "Input Variables", "examples": [ { "param1": "value1" } ] } }, "type": "object", "required": [ "name", "type", "river_id" ], "title": "RunRiverStep", "description": "Run river step schema" }, "RunTypeEnum": { "type": "string", "enum": [ "custom", "custom_query", "multi_tables", "legacy", "predefined_report", "regular" ], "title": "RunTypeEnum", "description": "River run types" }, "RunningNumber": { "properties": { "include_end_value": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Include End Value", "description": "Whether to include or exclude the end_value in the range", "examples": [true] }, "rows_in_chunk": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Rows In Chunk", "description": "The rows in chunk of the river entity.", "examples": [1000] }, "start_value": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Start Value", "description": "The start value of the river entity.", "examples": [1] }, "end_value": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "End Value", "description": "The end value of the river entity.", "examples": [100] } }, "type": "object", "title": "RunningNumber", "description": "Running number when using incremental on a running number and not date time." }, "RunsSortByEnum": { "type": "string", "enum": [ "units", "start_time", "table_name" ], "title": "RunsSortByEnum", "description": "Activities sort properties in the UI." }, "S3ModifiedColumn": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the column is selected and should be modified.", "examples": [true] }, "name": { "type": "string", "title": "Name", "description": "The name of the column.", "examples": [ "column_name" ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type", "description": "The type of the column.", "examples": [ "string" ] }, "alias": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Alias", "description": "The alias of the column in the target table.", "examples": [ "column_alias" ] }, "expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expression", "description": "This tells us the column is an expression or not so we know if it suppose to exist in the source / target or is it auto generated.", "examples": [ "select 'test'" ] }, "is_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Key", "description": "If the column is a key.", "examples": [true] }, "cluster_key": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cluster Key", "description": "The sort order of the column (number) in the cluster, used in the merge process to determine the order of the merge keys.", "examples": [1] }, "calculated_column_mode": { "anyOf": [ { "$ref": "#/components/schemas/CalculatedColumnModeEnum" }, { "type": "null" } ], "description": "The mode of the calculated column.Help to identify if the column is source expression or target expression,required if the column is an expression.", "examples": [ "source" ] }, "order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Order", "description": "The order of the column in the expression,required if the column is an expression.", "examples": [1] }, "mode": { "anyOf": [ { "$ref": "#/components/schemas/ColumnModeEnum" }, { "type": "null" } ], "description": "The mode of the column in the target table" }, "is_rivery_metadata": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Rivery Metadata", "description": "Whether the column includes rivery metadata" }, "target_type": { "const": "s3", "title": "Target Type", "description": "Internal field, populated automatically", "default": "s3" } }, "additionalProperties": false, "type": "object", "required": [ "is_selected", "name" ], "title": "S3ModifiedColumn", "description": "S3 specific columns settings" }, "S3TargetSettings": { "properties": { "name": { "const": "s3", "title": "Name", "description": "The name of the target", "default": "s3" }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Id", "description": "The connection ID of this target", "examples": [ "5f4d3b3d9f9c8b0001f6b0e6" ] }, "connection_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Name", "description": "The connection name of this target", "examples": [ "Connection 1" ] }, "single_table_settings": { "anyOf": [ { "$ref": "#/components/schemas/SingleTableSettings" }, { "type": "null" } ], "description": "Single table specific settings for the target" }, "path": { "type": "string", "title": "Path", "description": "The path of the file zone entity.", "examples": [ "my_path" ] }, "partitioned_kind": { "allOf": [ { "$ref": "#/components/schemas/PartitionedKindEnum" } ], "description": "The partitioned kind of the file zone entity.", "examples": [ "by_day" ] }, "fz_loading_mode": { "type": "string", "enum": [ "auto-period", "custom" ], "title": "Fz Loading Mode", "description": "Controls how the storage path is configured. 'auto-period' uses automatic period-based paths, 'custom' allows user-defined paths.", "default": "auto-period", "examples": [ "auto-period", "custom" ] }, "convert_file_type": { "anyOf": [ { "$ref": "#/components/schemas/ConvertFileTypeEnum" }, { "type": "null" } ], "description": "The type of file to convert to", "examples": [ "parquet" ] }, "bucket_name": { "type": "string", "title": "Bucket Name", "description": "The bucket name of the file zone entity.", "examples": [ "my_bucket" ] } }, "type": "object", "required": [ "path", "partitioned_kind", "bucket_name" ], "title": "S3TargetSettings", "description": "S3 target settings properties to return." }, "SalesforceAdditionalSourceSettings": { "properties": { "filter_expression": { "type": "string", "title": "Filter Expression", "description": "The filter expression of the river entity.", "default": "", "examples": [ "id \u003E 100" ] }, "source_type": { "const": "salesforce", "title": "Source Type", "description": "Internal field, populated automatically", "default": "salesforce" }, "auto_detect_new_fields": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Auto Detect New Fields", "description": "Auto-detect new fields in Salesforce objects (source level only)", "default": false, "examples": [true] }, "extract_api": { "anyOf": [ { "$ref": "#/components/schemas/SalesforceExtractTypeEnum" }, { "type": "null" } ], "description": "Salesforce extract API type: soap or bulk (source level only)", "default": "bulk", "examples": [ "bulk" ] }, "include_deleted_rows": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Include Deleted Rows", "description": "Include deleted rows in extraction (both source and table level)", "examples": [true] }, "pk_chunking": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Pk Chunking", "description": "PK chunking size for large Salesforce tables (table level only). Auto-populated with 100000 for specific tables if not provided", "examples": [100000, 250000] } }, "additionalProperties": false, "type": "object", "title": "SalesforceAdditionalSourceSettings", "description": "Salesforce specific source settings\n\nSource-level fields: auto_detect_new_fields, extract_api, include_deleted_rows\nTable-level fields: filter_expression, include_deleted_rows, pk_chunking" }, "SalesforceExtractTypeEnum": { "type": "string", "enum": [ "bulk", "soql", "soap" ], "title": "SalesforceExtractTypeEnum", "description": "The API type of the column / table in Salesforce" }, "ScheduleEnum": { "type": "string", "enum": [ "true", "false" ], "title": "ScheduleEnum", "description": "Schedule can be either True or False (enabled or disabled)" }, "Schema": { "properties": { "name": { "type": "string", "title": "Name", "description": "The name of the schema" }, "tables": { "items": { "oneOf": [ { "$ref": "#/components/schemas/DatabaseTableInput" }, { "$ref": "#/components/schemas/PredefinedReportShopifyTableInput" }, { "$ref": "#/components/schemas/WritePredefinedReportTiktokTableInput" } ], "description": "The tables of the schema entity", "discriminator": { "propertyName": "run_type_and_datasource", "mapping": { "multi_tables": "#/components/schemas/DatabaseTableInput", "predefined_report_shopify": "#/components/schemas/PredefinedReportShopifyTableInput", "predefined_report_tiktok": "#/components/schemas/WritePredefinedReportTiktokTableInput" } } }, "type": "array", "title": "Tables", "default": [] } }, "type": "object", "required": [ "name" ], "title": "Schema", "description": "The schema we use for GET operations" }, "SingleTableSettings": { "properties": { "escape_character": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Escape Character", "description": "Escape characters allow special characters in strings to be interpreted as literal characters", "examples": [ "\\t" ] }, "match_keys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Match Keys", "description": "Key columns for merge operations", "examples": [ [ "id", "username" ] ] }, "mapping": { "anyOf": [ { "items": { "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Mapping", "description": "Column definitions for the table", "examples": [ [ { "name": "id", "type": "INTEGER" } ] ] }, "sql_dialect": { "anyOf": [ { "$ref": "#/components/schemas/BigQuerySQLDialectsEnum" }, { "type": "null" } ], "description": "The SQL dialect to use in the BigQuery target", "examples": [ "standard" ] }, "split_tables": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Split Tables", "description": "Split tables configuration", "examples": [ "no" ] }, "split_data": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Split Data", "description": "The expression by which to split the tables if split tables by expression is chosen", "examples": [ "a\u003E3" ] }, "split_interval": { "anyOf": [ { "$ref": "#/components/schemas/BigQuerySplitTableIntervalEnum" }, { "type": "null" } ], "description": "The interval by which to split the tables if split table is on", "examples": [ "daily" ] }, "partition_type": { "anyOf": [ { "$ref": "#/components/schemas/BigQueryPartitionTypeEnum" }, { "type": "null" } ], "description": "Partition type for the table", "examples": [ "TIMESTAMP" ] }, "partition_granularity": { "anyOf": [ { "$ref": "#/components/schemas/BigQueryPartitionTimestampGranularityEnum" }, { "type": "null" } ], "description": "Partition granularity for timestamp partitions", "examples": [ "DAY" ] }, "distribution_method": { "anyOf": [ { "$ref": "#/components/schemas/DistributionMethodEnum" }, { "$ref": "#/components/schemas/AzureSynapseDistributionMethodEnum" }, { "type": "null" } ], "title": "Distribution Method", "description": "The distribution method for the table", "examples": [ "even" ] } }, "additionalProperties": false, "type": "object", "title": "SingleTableSettings", "description": "Single table settings for database targets.\n\nUsed to define table-level configuration including column mappings, match keys,\nand target-specific settings. All fields are optional to support different target types." }, "SizeFormatted": { "properties": { "size": { "type": "number", "title": "Size" }, "units": { "$ref": "#/components/schemas/FileSizeUnits" } }, "type": "object", "required": [ "size", "units" ], "title": "SizeFormatted", "description": "The size formatted as size and units" }, "SnowflakeAdditionalSourceSettings": { "properties": { "source_type": { "const": "snowflake", "title": "Source Type", "description": "Internal field, populated automatically", "default": "snowflake" } }, "type": "object", "title": "SnowflakeAdditionalSourceSettings", "description": "Snowflake specific source settings" }, "SnowflakeCsvFileSettings": { "properties": { "file_type": { "const": "csv", "title": "File Type", "default": "csv" }, "file_delimiter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Delimiter" }, "quote_char": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Quote Char" }, "include_header": { "type": "boolean", "title": "Include Header", "default": false }, "compression": { "type": "string", "enum": [ "none", "gzip" ], "title": "Compression", "description": "The compression type", "default": "none" } }, "type": "object", "title": "SnowflakeCsvFileSettings", "description": "Snowflake CSV File Settings Schema" }, "SnowflakeDataframeStep": { "properties": { "name": { "type": "string", "title": "Name" }, "is_enabled": { "type": "boolean", "title": "Is Enabled", "description": "A flag that indicates whether the step is enabled or not", "default": true }, "step_id": { "type": "string", "title": "Step Id", "description": "The step id", "examples": [ "76e0f1a623b444338778a189b1386126" ] }, "disable_errors": { "type": "boolean", "title": "Disable Errors", "description": "A flag that indicates whether to disable errors or not", "default": false }, "connection_id": { "type": "string", "title": "Connection Id" }, "type": { "const": "snowflake_dataframe", "title": "Type" }, "dataframe_name": { "type": "string", "title": "Dataframe Name" }, "target_properties": { "$ref": "#/components/schemas/SnowflakeTargetTableWithoutMappingProperties" } }, "type": "object", "required": [ "name", "type", "dataframe_name", "target_properties", "connection_id" ], "title": "SnowflakeDataframeStep", "description": "Dataframe Snowflake Step Schema" }, "SnowflakeModifiedColumn": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the column is selected and should be modified.", "examples": [true] }, "name": { "type": "string", "title": "Name", "description": "The name of the column.", "examples": [ "column_name" ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type", "description": "The type of the column.", "examples": [ "string" ] }, "alias": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Alias", "description": "The alias of the column in the target table.", "examples": [ "column_alias" ] }, "expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expression", "description": "This tells us the column is an expression or not so we know if it suppose to exist in the source / target or is it auto generated.", "examples": [ "select 'test'" ] }, "is_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Key", "description": "If the column is a key.", "examples": [true] }, "cluster_key": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cluster Key", "description": "The sort order of the column (number) in the cluster, used in the merge process to determine the order of the merge keys.", "examples": [1] }, "calculated_column_mode": { "anyOf": [ { "$ref": "#/components/schemas/CalculatedColumnModeEnum" }, { "type": "null" } ], "description": "The mode of the calculated column.Help to identify if the column is source expression or target expression,required if the column is an expression.", "examples": [ "source" ] }, "order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Order", "description": "The order of the column in the expression,required if the column is an expression.", "examples": [1] }, "mode": { "anyOf": [ { "$ref": "#/components/schemas/ColumnModeEnum" }, { "type": "null" } ], "description": "The mode of the column in the target table" }, "is_rivery_metadata": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Rivery Metadata", "description": "Whether the column includes rivery metadata" }, "target_type": { "const": "snowflake", "title": "Target Type", "description": "Internal field, populated automatically", "default": "snowflake" } }, "additionalProperties": false, "type": "object", "required": [ "is_selected", "name" ], "title": "SnowflakeModifiedColumn", "description": "Snowflake specific columns settings" }, "SnowflakeSqlQueryStep": { "properties": { "name": { "type": "string", "title": "Name" }, "is_enabled": { "type": "boolean", "title": "Is Enabled", "description": "A flag that indicates whether the step is enabled or not", "default": true }, "step_id": { "type": "string", "title": "Step Id", "description": "The step id", "examples": [ "76e0f1a623b444338778a189b1386126" ] }, "disable_errors": { "type": "boolean", "title": "Disable Errors", "description": "A flag that indicates whether to disable errors or not", "default": false }, "connection_id": { "type": "string", "title": "Connection Id" }, "type": { "const": "snowflake_sql_query", "title": "Type" }, "sql_query": { "type": "string", "title": "Sql Query" }, "target_settings": { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTargetTableWithMappingProperties" }, { "$ref": "#/components/schemas/TargetVariableProperties" }, { "$ref": "#/components/schemas/SnowflakeTargetDataframeProperties" }, { "$ref": "#/components/schemas/SnowflakeTargetFileProperties" } ], "title": "Target Settings", "discriminator": { "propertyName": "target_type", "mapping": { "dataframe": "#/components/schemas/SnowflakeTargetDataframeProperties", "files_export": "#/components/schemas/SnowflakeTargetFileProperties", "table": "#/components/schemas/SnowflakeTargetTableWithMappingProperties", "variable": "#/components/schemas/TargetVariableProperties" } } } }, "type": "object", "required": [ "name", "type", "sql_query", "target_settings", "connection_id" ], "title": "SnowflakeSqlQueryStep", "description": "Snowflake SQL Query Step Schema" }, "SnowflakeSqlScriptStep": { "properties": { "name": { "type": "string", "title": "Name" }, "is_enabled": { "type": "boolean", "title": "Is Enabled", "description": "A flag that indicates whether the step is enabled or not", "default": true }, "step_id": { "type": "string", "title": "Step Id", "description": "The step id", "examples": [ "76e0f1a623b444338778a189b1386126" ] }, "disable_errors": { "type": "boolean", "title": "Disable Errors", "description": "A flag that indicates whether to disable errors or not", "default": false }, "connection_id": { "type": "string", "title": "Connection Id" }, "type": { "const": "snowflake_sql_script", "title": "Type" }, "sql_query": { "type": "string", "title": "Sql Query" }, "auto_commit": { "type": "boolean", "title": "Auto Commit", "description": "A flag that indicates whether to auto commit or not", "default": true } }, "type": "object", "required": [ "name", "type", "sql_query", "connection_id" ], "title": "SnowflakeSqlScriptStep", "description": "Snowflake SQL Script Step Schema" }, "SnowflakeTableAdditionalTargetSettings": { "properties": { "is_ordered_merge_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Ordered Merge Key", "description": "If the table got any and should consider filter out duplicates data between source filemerge process(by order).", "default": false, "examples": [true] }, "order_expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Expression", "description": "The order expression of the river entity,to filter duplications from the source data by the provided order expression (for `merge` loading method).", "examples": [ "id desc,createDate asc" ] }, "target_loading": { "anyOf": [ { "$ref": "#/components/schemas/LoadingMode" }, { "type": "null" } ], "description": "The target loading of the table entity,if not specified the default loading mode of the riverwill be used.", "examples": [ "merge" ] }, "target_type": { "const": "snowflake", "title": "Target Type", "description": "Internal field, populated automatically", "default": "snowflake" }, "merge_method": { "anyOf": [ { "$ref": "#/components/schemas/MergeMethodSnowflake" }, { "type": "null" } ], "description": "The merge method of the table, if not specified the default merge method of the riverwill be used.", "examples": [ "merge" ] }, "enforce_masking_policy": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enforce Masking Policy", "description": "Reserve the data masking policy that is applied on the column level in your target table.", "default": false, "examples": [false] }, "recreate_keys": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Recreate Keys", "description": "Recreate the table keys.", "default": false, "examples": [false] }, "escape_character": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Escape Character", "description": "Escape characters allow special characters in strings to be interpreted as literal characters, rather than as control characters inside the query", "examples": [ "\\t" ] }, "remove_deleted_rows": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Remove Deleted Rows", "description": "remove deleted rows in case of MSSQL source and using change tracking including deleted rows" } }, "type": "object", "title": "SnowflakeTableAdditionalTargetSettings", "description": "Snowflake specific target settings" }, "SnowflakeTargetDataframeProperties": { "properties": { "target_type": { "const": "dataframe", "title": "Target Type" }, "dataframe_name": { "type": "string", "title": "Dataframe Name" }, "database_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Database Name", "description": "By default, the DataFrame location will be set to a PUBLIC Schema", "default": "" }, "schema_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Name", "description": "By default, the DataFrame location will be set to a PUBLIC Schema", "default": "" } }, "type": "object", "required": [ "target_type", "dataframe_name" ], "title": "SnowflakeTargetDataframeProperties", "description": "Snowflake target dataframe properties schema" }, "SnowflakeTargetFileProperties": { "properties": { "target_type": { "const": "files_export", "title": "Target Type" }, "bucket_name": { "type": "string", "title": "Bucket Name" }, "file_path": { "type": "string", "title": "File Path" }, "connection_id": { "type": "string", "title": "Connection Id" }, "load_into_single_file": { "type": "boolean", "title": "Load Into Single File", "description": "A flag that indicates whether to load into a single file or not", "default": false }, "file_settings": { "$ref": "#/components/schemas/SnowflakeCsvFileSettings" } }, "type": "object", "required": [ "target_type", "bucket_name", "file_path", "connection_id", "file_settings" ], "title": "SnowflakeTargetFileProperties", "description": "Snowflake Target File Properties Schema" }, "SnowflakeTargetSettings": { "properties": { "name": { "const": "snowflake", "title": "Name", "description": "The name of the target", "default": "snowflake" }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Id", "description": "The connection ID of this target", "examples": [ "5f4d3b3d9f9c8b0001f6b0e6" ] }, "connection_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Name", "description": "The connection name of this target", "examples": [ "Connection 1" ] }, "single_table_settings": { "anyOf": [ { "$ref": "#/components/schemas/SingleTableSettings" }, { "type": "null" } ], "description": "Single table specific settings for the target" }, "table_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Table Name", "description": "The table name of this target (only relevant for non multi table source to target rivers)", "default": "", "examples": [ "Table 1" ] }, "target_prefix": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Prefix", "description": "The table prefix of this target (only relevant for multi table source to target rivers)", "default": "", "examples": [ "start_at_" ] }, "is_ordered_merge_key": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Ordered Merge Key", "description": "If the table got any and should consider filter out duplicates data between source filemerge process(by order).", "default": false, "examples": [true] }, "order_expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Expression", "description": "The order expression of the river entity.", "examples": [ "id desc,createDate asc" ] }, "loading_method": { "allOf": [ { "$ref": "#/components/schemas/LoadingMode" } ], "description": "The loading method of this target", "examples": [ "merge" ] }, "merge_method": { "anyOf": [ { "$ref": "#/components/schemas/MergeMethodSnowflake" }, { "type": "null" } ], "description": "The merge method to preform,only relevant when the loading mode is Merge,if not provided the default merge method will be used.(merge)", "examples": [ "merge" ] }, "file_zone_settings": { "anyOf": [ { "$ref": "#/components/schemas/RiverFileZoneSettings" }, { "type": "null" } ], "description": "The file zone settings of this target" }, "file_path_destination": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Path Destination", "description": "The file name and path", "examples": [ "path/to/file" ] }, "additional_settings": { "type": "object", "title": "Additional Settings", "description": "The additional settings of this target", "default": { }, "examples": [ { "key": "value" } ] }, "database_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Database Name", "description": "The database name of this target", "examples": [ "Database 1" ] }, "schema_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Name", "description": "The schema name of this target", "examples": [ "Schema 1" ] } }, "type": "object", "required": [ "loading_method" ], "title": "SnowflakeTargetSettings", "description": "Snowflake target settings properties to return." }, "SnowflakeTargetTableMergeSettings": { "properties": { "merge_method": { "type": "string", "title": "Merge Method" }, "is_ordered_merge": { "type": "boolean", "title": "Is Ordered Merge", "description": "A flag that indicates whether the merge is ordered or not", "default": false }, "order_expression": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Order Expression", "description": "The order expression" } }, "type": "object", "required": [ "merge_method" ], "title": "SnowflakeTargetTableMergeSettings", "description": "Snowflake Target Table Merge Settings Schema" }, "SnowflakeTargetTableWithMappingProperties": { "properties": { "target_type": { "const": "table", "title": "Target Type" }, "table_name": { "type": "string", "title": "Table Name" }, "drop_after": { "type": "boolean", "title": "Drop After", "description": "A flag that indicates whether to drop the table after the run or not", "default": false }, "database_name": { "type": "string", "title": "Database Name" }, "schema_name": { "type": "string", "title": "Schema Name" }, "enforce_masking_policy": { "type": "boolean", "title": "Enforce Masking Policy", "description": "A flag that indicates whether to enforce masking policy or not", "default": false }, "loading_mode": { "type": "string", "enum": [ "append_only", "overwrite", "upsert_merge" ], "title": "Loading Mode" }, "fields": { "items": { "type": "object" }, "type": "array", "title": "Fields", "description": "The mapping" }, "mapping_order": { "items": { "type": "string" }, "type": "array", "title": "Mapping Order", "description": "The mapping order", "default": [] }, "merge_settings": { "anyOf": [ { "$ref": "#/components/schemas/SnowflakeTargetTableMergeSettings" }, { "type": "null" } ], "description": "The merge method" } }, "type": "object", "required": [ "target_type", "table_name", "database_name", "schema_name", "loading_mode" ], "title": "SnowflakeTargetTableWithMappingProperties", "description": "Snowflake Target Table With Mapping Properties Schema" }, "SnowflakeTargetTableWithoutMappingProperties": { "properties": { "target_type": { "const": "table", "title": "Target Type" }, "table_name": { "type": "string", "title": "Table Name" }, "drop_after": { "type": "boolean", "title": "Drop After", "description": "A flag that indicates whether to drop the table after the run or not", "default": false }, "database_name": { "type": "string", "title": "Database Name" }, "schema_name": { "type": "string", "title": "Schema Name" }, "enforce_masking_policy": { "type": "boolean", "title": "Enforce Masking Policy", "description": "A flag that indicates whether to enforce masking policy or not", "default": false }, "loading_mode": { "type": "string", "enum": [ "append_only", "overwrite" ], "title": "Loading Mode" } }, "type": "object", "required": [ "target_type", "table_name", "database_name", "schema_name", "loading_mode" ], "title": "SnowflakeTargetTableWithoutMappingProperties", "description": "Snowflake Target Table Without Mapping Properties Schema" }, "SortOrderEnum": { "type": "string", "enum": [ "desc", "asc" ], "title": "SortOrderEnum", "description": "Sorting can be either asc or desc, used in the api-service" }, "SourceSettings": { "properties": { "name": { "type": "string", "enum": [ "mysql", "postgresql", "oracle", "mongodb", "mssql", "mariadb", "vertica", "elasticsearch", "netsuite_analytics", "shopify", "tiktok", "bigquery", "snowflake", "redshift", "boomi_for_sap", "salesforce" ], "title": "Name", "description": "The name of the source (correlate to source type in db)", "examples": [ "mysql" ] }, "connection_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Id", "description": "The connection ID of this source.", "examples": [ "5f4d3b3d9f9c8b0001f6b0e6" ] }, "connection_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Connection Name", "description": "The connection name of this source.", "examples": [ "Connection 1" ] }, "run_type": { "allOf": [ { "$ref": "#/components/schemas/RunTypeEnum" } ], "description": "The run type of this source.", "default": "multi_tables", "examples": [ "predefined_report" ] }, "cdc_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/MysqlSourceCDCSettings" }, { "$ref": "#/components/schemas/PostgresSourceCDCSettings" }, { "$ref": "#/components/schemas/OracleSourceCDCSettings" }, { "$ref": "#/components/schemas/MongoDBSourceCDCSettings" }, { "$ref": "#/components/schemas/MSSQLSourceCDCSettings" }, { "$ref": "#/components/schemas/BoomiForSapCDCSettings" } ], "discriminator": { "propertyName": "datasource_id", "mapping": { "boomi_for_sap": "#/components/schemas/BoomiForSapCDCSettings", "mongodb": "#/components/schemas/MongoDBSourceCDCSettings", "mssql": "#/components/schemas/MSSQLSourceCDCSettings", "mysql": "#/components/schemas/MysqlSourceCDCSettings", "oracle": "#/components/schemas/OracleSourceCDCSettings", "postgres": "#/components/schemas/PostgresSourceCDCSettings" } } }, { "type": "null" } ], "title": "Cdc Settings", "description": "The CDC settings of this source." }, "additional_settings": { "type": "object", "title": "Additional Settings", "description": "The additional settings of this source.", "default": { }, "examples": [ { "extract_method": "all" } ] }, "custom_query_source_settings": { "anyOf": [ { "$ref": "#/components/schemas/CustomQuerySourceSettings" }, { "type": "null" } ], "description": "Custom query source settings for database sources with run_type=custom_query. This field is omitted from serialized output (model_dump / API response) when None." } }, "type": "object", "required": [ "name" ], "title": "SourceSettings", "description": "Source settings properties to return." }, "SourceToTargetRiverProperties": { "properties": { "properties_type": { "const": "source_to_target", "title": "Properties Type", "default": "source_to_target" }, "source": { "allOf": [ { "$ref": "#/components/schemas/SourceSettings" } ], "description": "The source of the river." }, "target": { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTargetSettings" }, { "$ref": "#/components/schemas/S3TargetSettings" }, { "$ref": "#/components/schemas/EmailTargetSettings" }, { "$ref": "#/components/schemas/BlobStorageSettings" }, { "$ref": "#/components/schemas/GcsTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTargetSettings" }, { "$ref": "#/components/schemas/AthenaTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTargetSettings" }, { "$ref": "#/components/schemas/PostgresTargetSettings" } ], "title": "Target", "description": "The target of the river.", "discriminator": { "propertyName": "name", "mapping": { "athena": "#/components/schemas/AthenaTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTargetSettings", "bigquery": "#/components/schemas/BigQueryTargetSettings", "blob_storage": "#/components/schemas/BlobStorageSettings", "databricks": "#/components/schemas/DatabricksTargetSettings", "gcs": "#/components/schemas/GcsTargetSettings", "postgres_rds": "#/components/schemas/PostgresTargetSettings", "redshift": "#/components/schemas/RedshiftTargetSettings", "s3": "#/components/schemas/S3TargetSettings", "snowflake": "#/components/schemas/SnowflakeTargetSettings", "target_email": "#/components/schemas/EmailTargetSettings" } } }, "schemas": { "items": { "$ref": "#/components/schemas/Schema" }, "type": "array", "title": "Schemas", "description": "The schemas of the river entity", "default": [] } }, "additionalProperties": false, "type": "object", "required": [ "source", "target" ], "title": "SourceToTargetRiverProperties", "description": "Source to target River properties that is being used for GET purposes" }, "SourceToTargetTaskProperties": { "properties": { "duration": { "type": "integer", "title": "Duration", "description": "The duration of the task in milliseconds", "examples": [2000] }, "error_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error Description", "description": "The error description if any", "examples": [ "error" ] }, "start_date_utc": { "type": "string", "format": "date-time", "title": "Start Date Utc", "description": "The start date time in UTC timezone.Time format YYYY-MM-DDThh:mm:ss.ms", "examples": [ "2022-07-25T18:38:55.640Z" ] }, "start_date_in_milliseconds": { "type": "integer", "title": "Start Date In Milliseconds", "description": "The start epoch in milliseconds.", "examples": [1658774335000] }, "end_date_utc": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "End Date Utc", "description": "The end date time in UTC timezone.Time format YYYY-MM-DDThh:mm:ss.ms", "examples": [ "2022-07-25T18:38:55.640Z" ] }, "end_date_in_milliseconds": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "End Date In Milliseconds", "description": "The end epoch in milliseconds.", "examples": [1658774335000] }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source", "description": "The name of the source.", "examples": [ "Google Ads" ] }, "task_id": { "type": "string", "title": "Task Id", "description": "The ID of the task", "examples": [ "6a23130732304020886bf5f8bfcecfbc" ] }, "task_name": { "type": "string", "title": "Task Name", "description": "The name of the task", "examples": [ "Google Ads To Amazon S3" ] }, "task_status": { "allOf": [ { "$ref": "#/components/schemas/ActivityStatusEnum" } ], "description": "The status of the task", "examples": [ "succeeded" ] }, "task_type": { "const": "source_to_target", "title": "Task Type" }, "input_parameters": { "anyOf": [ { "items": { "$ref": "#/components/schemas/InputParameters" }, "type": "array" }, { "type": "null" } ], "title": "Input Parameters", "description": "A list of input parameters" }, "target": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target", "description": "The name of the target", "examples": [ "Snowflake" ] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of target table (if exist in the task)", "examples": [ "table" ] }, "size": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Size", "description": "Total transferred size in bytes", "examples": [2048.3] }, "size_formatted": { "anyOf": [ { "$ref": "#/components/schemas/SizeFormatted" }, { "type": "null" } ], "description": "Total transferred size with units" }, "target_records_loaded": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Target Records Loaded", "description": "Target loaded record" } }, "type": "object", "required": [ "duration", "error_description", "start_date_utc", "start_date_in_milliseconds", "end_date_utc", "end_date_in_milliseconds", "task_id", "task_name", "task_status", "task_type" ], "title": "SourceToTargetTaskProperties", "description": "SourceToTarget properties" }, "SplitTableByExpressionProperties": { "properties": { "split_by": { "const": "expression", "title": "Split By" }, "expression": { "type": "string", "title": "Expression" } }, "type": "object", "required": [ "split_by", "expression" ], "title": "SplitTableByExpressionProperties", "description": "Split table by expression properties schema" }, "SplitTableByInsertTimeProperties": { "properties": { "split_by": { "const": "insert_timestamp", "title": "Split By" }, "interval": { "type": "string", "enum": [ "YEAR", "MONTH", "DAY", "HOUR" ], "title": "Interval" } }, "type": "object", "required": [ "split_by", "interval" ], "title": "SplitTableByInsertTimeProperties", "description": "Split table by insert time properties schema" }, "SplitTimeIntervals": { "properties": { "time_interval": { "allOf": [ { "$ref": "#/components/schemas/IntervalTimeExternalEnum" } ], "description": "The interval time unit to split when using date increment.", "default": "dont_split", "examples": [ "days" ], "extra": { "display_name": "Split your loading data into several intervals in case of a large amount of returned data by:", "name": "date_range.split_time_intervals.time_interval", "type": "split_time_intervals" } }, "interval_size": { "type": "integer", "title": "Interval Size", "description": "The number of time units for each interval - for example, when the interval is set to days and the interval size is 3, each interval will extract data for 3 days.", "default": 1, "examples": [3], "extra": { "condition": { "different": "dont_split", "field_name": "date_range.split_time_intervals.time_interval" }, "display_name": "Split Interval Size", "name": "date_range.split_time_intervals.interval_size", "type": "number" } } }, "type": "object", "title": "SplitTimeIntervals", "description": "Settings for splitting to time intervals when using incremental loading method by dates." }, "StandardInterfaceParams": { "properties": { "name": { "type": "string", "title": "Name", "description": "The identifier name for the interface parameter." }, "type": { "allOf": [ { "$ref": "#/components/schemas/InterfaceParamsBaseTypeEnum" } ], "description": "The data type of the parameter. Defaults to STRING.", "default": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "boolean" }, { "type": "null" } ], "title": "Value", "description": "The actual value of the parameter." } }, "type": "object", "required": [ "name" ], "title": "StandardInterfaceParams", "description": "Interface parameters for standard configurations." }, "StatusEnum": { "type": "string", "enum": [ "any", "cancelled", "closed", "open" ], "title": "StatusEnum", "description": "Shopify order status enum" }, "SystemVersioningSettings": { "properties": { "initiate_table": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Initiate Table", "description": "Initiate migration process for table", "examples": [true] }, "overwrite_table_in_migration": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Overwrite Table In Migration", "description": "Overwrite target table for migration process", "examples": [true] }, "include_end_value": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Include End Value" } }, "type": "object", "title": "SystemVersioningSettings", "description": "The table system versioning settings" }, "TableCDCSettings": { "properties": { "initiate_table": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Initiate Table", "description": "Initiate migration process for table", "examples": [true] }, "overwrite_table_in_migration": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Overwrite Table In Migration", "description": "Overwrite target table for migration process", "examples": [true] } }, "type": "object", "title": "TableCDCSettings", "description": "The table CDC settings" }, "TableFilter": { "properties": { "column": { "type": "string", "title": "Column", "description": "The column to filter", "examples": [ "option1" ] }, "operator": { "type": "string", "title": "Operator", "description": "Filter operator", "examples": [ "equals", "not_equals", "greater_than" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" } ], "title": "Value", "description": "Filter value", "examples": [ "5", 9, 10.5] } }, "type": "object", "required": [ "column", "operator", "value" ], "title": "TableFilter", "description": "Table-level filter used by sources to restrict rows." }, "TableStatusEnum": { "type": "string", "enum": [ "waiting_for_migration", "migrating", "tracked", "live" ], "title": "TableStatusEnum", "description": "Table status for rivers in multi table mode" }, "TargetDataframeProperties": { "properties": { "target_type": { "const": "dataframe", "title": "Target Type" }, "dataframe_name": { "type": "string", "title": "Dataframe Name" } }, "type": "object", "required": [ "target_type", "dataframe_name" ], "title": "TargetDataframeProperties", "description": "Target Dataframe Properties Schema" }, "TargetVariableProperties": { "properties": { "target_type": { "const": "variable", "title": "Target Type" }, "variable_name": { "type": "string", "title": "Variable Name" }, "variable_type": { "type": "string", "enum": [ "river", "environment" ], "title": "Variable Type" } }, "type": "object", "required": [ "target_type", "variable_name", "variable_type" ], "title": "TargetVariableProperties", "description": "Target Variable Properties Schema" }, "TargetsSortByEnum": { "type": "string", "enum": [ "units", "last_run", "table_name" ], "title": "TargetsSortByEnum", "description": "Activities sort properties in the UI." }, "TeamsSortByEnum": { "type": "string", "enum": [ "display_name", "created_at", "source", "is_all_environment_admin", "default_environment" ], "title": "TeamsSortByEnum", "description": "User teams sort properties in the UI." }, "UpdateRiverVariableInput": { "properties": { "name": { "type": "string", "title": "Name", "description": "The name of the variable", "examples": [ "credentials" ] }, "settings": { "allOf": [ { "$ref": "#/components/schemas/RiverVariableSettings" } ], "description": "settings class for variable", "examples": [ { "clear_value_on_start": true, "is_encrypted": false, "is_multi_value": false } ] }, "value": { "anyOf": [ { "type": "string" }, { "items": { }, "type": "array" }, { "type": "object" }, { "type": "null" } ], "title": "Value", "description": "value of a variable", "examples": [ "1234" ] } }, "type": "object", "required": [ "name", "settings" ], "title": "UpdateRiverVariableInput", "description": "Logic river variable fields for update.\n " }, "UpdateRiverVariableInputList": { "properties": { "items": { "items": { "$ref": "#/components/schemas/UpdateRiverVariableInput" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "items" ], "title": "UpdateRiverVariableInputList", "description": "List of logic river variable fields for update.\n " }, "UserInfo": { "properties": { "user_name": { "type": "string", "title": "User Name", "description": "river version creator username", "examples": [ "createdby_username" ] }, "user_email": { "type": "string", "title": "User Email", "description": "river version creator email", "examples": [ "createdby@rivery.io" ] } }, "type": "object", "required": [ "user_name", "user_email" ], "title": "UserInfo", "description": "River version creator info.\n " }, "UserModel": { "properties": { "user_id": { "type": "string", "title": "User Id", "description": "The user id", "examples": [ "5f887c764c40e5598f717676" ] }, "user_email": { "type": "string", "title": "User Email", "description": "The email of the user", "examples": [ "user@rivey.io" ] }, "user_name": { "type": "string", "title": "User Name", "description": "The user name", "examples": [ "John Doe" ] }, "environments": { "type": "object", "title": "Environments", "description": "The user environments and permission", "examples": [ { "5f887c764c40e5598f717676": { "role": "admin" } } ] }, "is_admin": { "type": "boolean", "title": "Is Admin", "description": "A flag that indicates whether the flag is admin", "examples": [true] }, "is_global_operator": { "type": "boolean", "title": "Is Global Operator", "description": "Indicates if the user is a global operator (read-only cross-account)", "default": false, "examples": [false] }, "status": { "type": "string", "title": "Status", "description": "The user status", "examples": [ "active" ] }, "created_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created At", "description": "The user creation date", "examples": [ "2026-05-14T01:57:17.017979" ] }, "last_login": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Last Login", "description": "The user's last login date", "examples": [ "2026-05-14T01:57:17.017979" ] }, "updated_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Updated At", "description": "The user last update date", "examples": [ "2026-05-14T01:57:17.017979" ] }, "groups": { "items": { "type": "string" }, "type": "array", "title": "Groups", "description": "The user's groups", "default": [], "examples": [ [ "5f887c764c40e5598f717676" ] ] }, "source": { "type": "string", "title": "Source", "description": "The user source", "examples": [ "rivery" ] }, "invited_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Invited By", "description": "The user who invited this user", "examples": [ "invite@rivey.io" ] }, "is_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Active", "description": "Indicates if the user is active", "default": true }, "onboarding": { "anyOf": [ { "$ref": "#/components/schemas/UserOnboardingModel" }, { "type": "null" } ] }, "is_super_admin": { "type": "boolean", "title": "Is Super Admin", "description": "Indicates if the user is a super admin", "examples": [false] }, "is_super_admin_creator": { "type": "boolean", "title": "Is Super Admin Creator", "description": "Indicates if the user is a super admin creator", "examples": [false] }, "allow_login_password": { "type": "boolean", "title": "Allow Login Password", "description": "Indicates if the user is allowed to login with password", "examples": [true] }, "allow_login_google": { "type": "boolean", "title": "Allow Login Google", "description": "Indicates if the user is allowed to login with google", "examples": [true] }, "allow_login_sso": { "type": "boolean", "title": "Allow Login Sso", "description": "Indicates if the user is allowed to login with SSO", "examples": [true] } }, "type": "object", "required": [ "user_id", "user_email", "user_name", "environments", "is_admin", "status", "source", "is_super_admin", "is_super_admin_creator", "allow_login_password", "allow_login_google", "allow_login_sso" ], "title": "UserModel", "description": "User model" }, "UserOnboardingModel": { "properties": { "know_rivery_step": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Know Rivery Step", "description": "User finished first step", "examples": [ { "onboarding_river_types": { "status": true, "update_time": "2026-05-14T01:57:17.017979" }, "onboarding_rivery_introduction": { "status": true, "update_time": "2026-05-14T01:57:17.017979" } } ] }, "data_connections_step": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Data Connections Step", "description": "User finished second step", "examples": [ { "onboarding_add_connection": false } ] }, "data_pipeline_step": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Data Pipeline Step", "description": "User finished third step", "examples": [ { "onboarding_create_s2t": false, "onboarding_view_activities": false } ] }, "transform_and_orchestrate_step": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Transform And Orchestrate Step", "description": "User finished fourth step", "examples": [null] }, "pre_built_solutions_step": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Pre Built Solutions Step", "description": "User finished fifth step", "examples": [null] }, "invite_member_step": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Invite Member Step", "description": "User finished sixth step", "examples": [null] } }, "type": "object", "title": "UserOnboardingModel", "description": "Onboarding steps model" }, "UserPermissionsResponse": { "properties": { "environments": { "type": "object", "title": "Environments" } }, "type": "object", "required": [ "environments" ], "title": "UserPermissionsResponse", "description": "User permission response" }, "UserTeamsListResponse": { "properties": { "next_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Page", "description": "The next page URL" }, "previous_page": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Page", "description": "The previous page URL" }, "page": { "type": "integer", "title": "Page", "description": "The page number", "default": 1 }, "current_page_size": { "type": "integer", "title": "Current Page Size", "description": "The current page size" }, "total_items": { "type": "integer", "title": "Total Items", "description": "The total number of entities fetched", "default": 0 }, "account_id": { "type": "string", "title": "Account Id", "description": "The account id" }, "items": { "items": { "$ref": "#/components/schemas/UserTeamsModel" }, "type": "array", "title": "Items" } }, "type": "object", "required": [ "current_page_size", "account_id", "items" ], "title": "UserTeamsListResponse", "description": "List user teams response" }, "UserTeamsModel": { "properties": { "_id": { "type": "string", "title": " Id", "description": "The user group id", "examples": [ "633ede20f1fc5500111fd7b3" ] }, "account_id": { "type": "string", "title": "Account Id", "description": "The account id", "examples": [ "55bf7c4270fdca16cac18761" ] }, "display_name": { "type": "string", "title": "Display Name", "description": "The display name", "examples": [ "Boomi Data Integration Core Team" ] }, "remote_display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Remote Display Name", "description": "The SCIM display name", "examples": [ "Core Team" ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "description": "Internal description", "examples": [ "Some description" ] }, "environments": { "type": "object", "title": "Environments", "description": "Dictionary of environment id and environment role", "default": { }, "examples": [ { "5f887c764c40e5598f717676": { "role": "viewer" }, "633ede20f1fc5500111fd7b3": { "role": "viewer" } } ] }, "default_environment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Default Environment", "description": "Default Environment ID for this team (Optional)", "examples": [true] }, "is_all_environment_admin": { "type": "boolean", "title": "Is All Environment Admin", "description": "Indicates if group have Admin permission for all environment", "default": false, "examples": [true] }, "source": { "allOf": [ { "$ref": "#/components/schemas/GroupOrUserSourceEnum" } ], "description": "Source if this group locally of rivery or imported from external such as Active Directory", "default": "rivery", "examples": [ "rivery" ] }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "Created team datatime", "examples": [ "2026-05-14T01:57:28.407620" ] } }, "type": "object", "required": [ "_id", "account_id", "display_name", "created_at" ], "title": "UserTeamsModel", "description": "Base user team model properties to return." }, "UserUpdateSourceInput": { "properties": { "source": { "allOf": [ { "$ref": "#/components/schemas/GroupOrUserSourceEnum" } ], "description": "The desired source of the user. For example, if the user should managed by active directory then the source should be active_directory", "examples": [ "active_directory" ] } }, "type": "object", "required": [ "source" ], "title": "UserUpdateSourceInput", "description": "User update source input" }, "UsersSortByEnum": { "type": "string", "enum": [ "user_name", "created_at", "last_login", "user_email", "invited_by", "is_admin", "source" ], "title": "UsersSortByEnum", "description": "User sort properties in the UI." }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "VariablesResponse": { "properties": { "variables": { "type": "object", "title": "Variables" } }, "type": "object", "required": [ "variables" ], "title": "VariablesResponse", "description": "List of variables response" }, "VerticaAdditionalSourceSettings": { "properties": { "filter_expression": { "type": "string", "title": "Filter Expression", "description": "The filter expression of the river entity.", "default": "", "examples": [ "id \u003E 100" ] }, "source_type": { "const": "vertica", "title": "Source Type", "description": "Internal field, populated automatically", "default": "vertica" } }, "additionalProperties": false, "type": "object", "title": "VerticaAdditionalSourceSettings", "description": "Vertica specific source settings" }, "WriteDatabaseTableDetailsInput": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table (relevant to multi-tables rivers)", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "$ref": "#/components/schemas/ExtractMethodEnum" }, { "type": "null" } ], "description": "The extract method of the table entity.if not specified the extract method of the riverwill be used.", "examples": [ "incremental" ] }, "name": { "type": "string", "title": "Name", "description": "The name of the table", "examples": [ "table_name" ] }, "incremental_field": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Incremental Field", "description": "The interval field of the river entity.", "examples": [ "some_date_field" ] }, "date_range": { "anyOf": [ { "$ref": "#/components/schemas/DateRange" }, { "type": "null" } ], "description": "The date range of the river entity only needed if the extract method is incremental." }, "running_number": { "anyOf": [ { "$ref": "#/components/schemas/RunningNumber" }, { "type": "null" } ], "description": "The running number of the river entity only needed if the extract method is incremental." }, "epoch": { "anyOf": [ { "$ref": "#/components/schemas/Epoch" }, { "type": "null" } ], "description": "The epoch dates of the river entity only needed if the extract method is incremental." }, "exporter_chunk_size": { "type": "integer", "title": "Exporter Chunk Size", "description": "The exporter chunk size of the river entity. i.e. the number of rows to extract per chuck", "default": 30000, "examples": [1000] }, "table_status": { "anyOf": [ { "$ref": "#/components/schemas/TableStatusEnum" }, { "type": "null" } ], "description": "The table status of the river entity.", "examples": [ "waiting_for_migration" ] }, "cdc_settings": { "anyOf": [ { "$ref": "#/components/schemas/TableCDCSettings" }, { "type": "null" } ], "description": "The CDC settings of this table." }, "change_tracking_settings": { "anyOf": [ { "$ref": "#/components/schemas/ChangeTrackingSettings" }, { "type": "null" } ] }, "system_versioning_settings": { "anyOf": [ { "$ref": "#/components/schemas/SystemVersioningSettings" }, { "type": "null" } ] }, "additional_source_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/MongoDBAdditionalSourceSettings" }, { "$ref": "#/components/schemas/MySQLAdditionalSourceSettings" }, { "$ref": "#/components/schemas/PostgreSQLAdditionalSourceSettings" }, { "$ref": "#/components/schemas/OracleAdditionalSourceSettings" }, { "$ref": "#/components/schemas/BigQueryAdditionalSourceSettings" }, { "$ref": "#/components/schemas/MariaDBAdditionalSourceSettings" }, { "$ref": "#/components/schemas/MSSQLAdditionalSourceSettings" }, { "$ref": "#/components/schemas/RecipeAdditionalSourceSettings" }, { "$ref": "#/components/schemas/SnowflakeAdditionalSourceSettings" }, { "$ref": "#/components/schemas/BoomiForSapAdditionalSourceSettings" }, { "$ref": "#/components/schemas/VerticaAdditionalSourceSettings" }, { "$ref": "#/components/schemas/RedshiftAdditionalSourceSettings" }, { "$ref": "#/components/schemas/ElasticSearchAdditionalSourceSettings" }, { "$ref": "#/components/schemas/SalesforceAdditionalSourceSettings" }, { "$ref": "#/components/schemas/NetSuiteAnalyticsAdditionalSourceSettings" }, { "$ref": "#/components/schemas/HubspotAdditionalSourceSettings" }, { "$ref": "#/components/schemas/CoupaAdditionalSourceSettings" }, { "$ref": "#/components/schemas/DataHubAdditionalSourceSettings" } ], "discriminator": { "propertyName": "source_type", "mapping": { "bigquery": "#/components/schemas/BigQueryAdditionalSourceSettings", "blueprint": "#/components/schemas/RecipeAdditionalSourceSettings", "boomi_for_sap": "#/components/schemas/BoomiForSapAdditionalSourceSettings", "coupa": "#/components/schemas/CoupaAdditionalSourceSettings", "datahub": "#/components/schemas/DataHubAdditionalSourceSettings", "elasticsearch": "#/components/schemas/ElasticSearchAdditionalSourceSettings", "hubspot": "#/components/schemas/HubspotAdditionalSourceSettings", "mariadb": "#/components/schemas/MariaDBAdditionalSourceSettings", "mongodb": "#/components/schemas/MongoDBAdditionalSourceSettings", "mssql": "#/components/schemas/MSSQLAdditionalSourceSettings", "mysql": "#/components/schemas/MySQLAdditionalSourceSettings", "netsuite_analytics": "#/components/schemas/NetSuiteAnalyticsAdditionalSourceSettings", "oracle": "#/components/schemas/OracleAdditionalSourceSettings", "postgresql": "#/components/schemas/PostgreSQLAdditionalSourceSettings", "redshift": "#/components/schemas/RedshiftAdditionalSourceSettings", "salesforce": "#/components/schemas/SalesforceAdditionalSourceSettings", "snowflake": "#/components/schemas/SnowflakeAdditionalSourceSettings", "vertica": "#/components/schemas/VerticaAdditionalSourceSettings" } } }, { "type": "null" } ], "title": "Additional Source Settings", "description": "The additional source settings of this table.", "examples": [ { "filter_expression": "", "source_type": "mysql" } ] }, "is_custom_incremental": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Custom Incremental", "description": "Indicates weather the table is using custom incrementalcolumn", "default": false, "examples": [false] } }, "additionalProperties": false, "type": "object", "required": [ "name" ], "title": "WriteDatabaseTableDetailsInput", "description": "Table properties which define the db table details data\nThis schema is being used for Create or Update purposes" }, "WriteDatabaseTableInput": { "properties": { "run_type_and_datasource": { "const": "multi_tables", "title": "Run Type And Datasource", "description": "Internal field", "default": "multi_tables" }, "details": { "allOf": [ { "$ref": "#/components/schemas/WriteDatabaseTableDetailsInput" } ], "description": "The database table details" } }, "type": "object", "required": [ "details" ], "title": "WriteDatabaseTableInput", "description": "Table properties which define the db table data\nThis schema is being used for Create or Update purposes" }, "WriteFacebookAdsPredefinedAdAccountActivitiesReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_ad_account_activities", "title": "Report Id", "description": "The report id" }, "incremental_field": { "const": "Date", "title": "Incremental Field", "description": "The interval field of the river entity.", "default": "Date", "examples": [ "date_field" ] }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteFacebookAdsPredefinedAdAccountActivitiesReport", "description": "Facebook ads predefined ad account activities report, used for write." }, "WriteFacebookAdsPredefinedAdAccountReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "all", "examples": [ "all" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "example": "all", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_ad_account", "title": "Report Id", "description": "The report id" } }, "type": "object", "required": [ "report_id" ], "title": "WriteFacebookAdsPredefinedAdAccountReport", "description": "Facebook ads predefined ad account report, used for write." }, "WriteFacebookAdsPredefinedAdCreativesReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_ad_creatives", "title": "Report Id", "description": "The report id" }, "incremental_field": { "const": "Ads Creation Date", "title": "Incremental Field", "description": "The interval field of the river entity.", "default": "Ads Creation Date", "examples": [ "ads_creation_date_field" ] }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteFacebookAdsPredefinedAdCreativesReport", "description": "Facebook ads predefined ad creatives report, used for write." }, "WriteFacebookAdsPredefinedAdLeadsFormsReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "all", "examples": [ "all" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "example": "all", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_ad_leads_forms", "title": "Report Id", "description": "The report id" } }, "type": "object", "required": [ "report_id" ], "title": "WriteFacebookAdsPredefinedAdLeadsFormsReport", "description": "Facebook ads predefined ad leads forms report, used for write." }, "WriteFacebookAdsPredefinedAdLeadsReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_ad_leads", "title": "Report Id", "description": "The report id" }, "incremental_field": { "const": "Ads Creation Date", "title": "Incremental Field", "description": "The interval field of the river entity.", "default": "Ads Creation Date", "examples": [ "ads_creation_date" ] }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteFacebookAdsPredefinedAdLeadsReport", "description": "Facebook ads predefined ad leads report, used for write." }, "WriteFacebookAdsPredefinedAdSetsReport": { "properties": { "adsets_ac": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IDNameInput" }, "type": "array" }, { "type": "null" } ], "title": "Adsets Ac", "description": "Leave empty for all ad sets", "default": [] }, "adsets_filter": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Adsets Filter", "description": "Leave empty for all ad sets", "default": [] }, "adsets_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Adsets Ids", "description": "Leave empty for all ad sets", "default": [] }, "adsets_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Adsets Names", "description": "Leave empty for all ad sets", "default": [] }, "adsets_type": { "anyOf": [ { "$ref": "#/components/schemas/FacebookAdsSetsTypeEnum" }, { "type": "null" } ], "description": "The type of ad sets input to use", "examples": [ "adsets_names", "adsets_ids", "adsets_filter" ] }, "campaigns_ac": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IDNameInput" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Ac", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_filter": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Filter", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Ids", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Names", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_type": { "anyOf": [ { "$ref": "#/components/schemas/FacebookAdsCampaignsTypeEnum" }, { "type": "null" } ], "description": "The type of campaigns input to use", "examples": [ "campaigns_names", "campaigns_ids", "campaigns_filter" ] }, "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "all", "examples": [ "all" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "example": "all", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_adsets", "title": "Report Id", "description": "The report id" } }, "type": "object", "required": [ "report_id" ], "title": "WriteFacebookAdsPredefinedAdSetsReport", "description": "Facebook ads predefined ad sets report, used for write." }, "WriteFacebookAdsPredefinedAdsPixelsReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_ads_pixels", "title": "Report Id", "description": "The report id" }, "incremental_field": { "const": "Date", "title": "Incremental Field", "description": "The interval field of the river entity.", "default": "Date", "examples": [ "date_field" ] }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteFacebookAdsPredefinedAdsPixelsReport", "description": "Facebook ads predefined ads pixels report, used for write." }, "WriteFacebookAdsPredefinedAdsReport": { "properties": { "ads_ac": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IDNameInput" }, "type": "array" }, { "type": "null" } ], "title": "Ads Ac", "description": "Leave empty for all ads", "default": [] }, "ads_filter": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Ads Filter", "description": "Leave empty for all ads", "default": [] }, "ads_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Ads Ids", "description": "Leave empty for all ads", "default": [] }, "ads_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Ads Names", "description": "Leave empty for all ads", "default": [] }, "ads_type": { "anyOf": [ { "$ref": "#/components/schemas/FacebookAdsAdsTypeEnum" }, { "type": "null" } ], "description": "The type of ads input to use", "examples": [ "ads_ids", "ads_names", "ads_filter" ] }, "adsets_ac": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IDNameInput" }, "type": "array" }, { "type": "null" } ], "title": "Adsets Ac", "description": "Leave empty for all ad sets", "default": [] }, "adsets_filter": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Adsets Filter", "description": "Leave empty for all ad sets", "default": [] }, "adsets_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Adsets Ids", "description": "Leave empty for all ad sets", "default": [] }, "adsets_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Adsets Names", "description": "Leave empty for all ad sets", "default": [] }, "adsets_type": { "anyOf": [ { "$ref": "#/components/schemas/FacebookAdsSetsTypeEnum" }, { "type": "null" } ], "description": "The type of ad sets input to use", "examples": [ "adsets_names", "adsets_ids", "adsets_filter" ] }, "campaigns_ac": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IDNameInput" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Ac", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_filter": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Filter", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Ids", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Names", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_type": { "anyOf": [ { "$ref": "#/components/schemas/FacebookAdsCampaignsTypeEnum" }, { "type": "null" } ], "description": "The type of campaigns input to use", "examples": [ "campaigns_names", "campaigns_ids", "campaigns_filter" ] }, "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_ads", "title": "Report Id", "description": "The report id" }, "incremental_field": { "const": "Ads Creation Date", "title": "Incremental Field", "description": "The interval field of the river entity.", "default": "Ads Creation Date", "examples": [ "ads_creation_date" ] }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteFacebookAdsPredefinedAdsReport", "description": "Facebook ads predefined ads report, used for write." }, "WriteFacebookAdsPredefinedCampaignsReport": { "properties": { "campaigns_ac": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IDNameInput" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Ac", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_filter": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Filter", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Ids", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Names", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_type": { "anyOf": [ { "$ref": "#/components/schemas/FacebookAdsCampaignsTypeEnum" }, { "type": "null" } ], "description": "The type of campaigns input to use", "examples": [ "campaigns_names", "campaigns_ids", "campaigns_filter" ] }, "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "all", "examples": [ "all" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "example": "all", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_campaigns", "title": "Report Id", "description": "The report id" } }, "type": "object", "required": [ "report_id" ], "title": "WriteFacebookAdsPredefinedCampaignsReport", "description": "Facebook ads predefined campaigns report, used for write." }, "WriteFacebookAdsPredefinedCustomAudiencesReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "all", "examples": [ "all" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "example": "all", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_custom_audiences", "title": "Report Id", "description": "The report id" } }, "type": "object", "required": [ "report_id" ], "title": "WriteFacebookAdsPredefinedCustomAudiencesReport", "description": "Facebook ads predefined custom audiences report, used for write." }, "WriteFacebookAdsPredefinedCustomConversionsReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "all", "examples": [ "all" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "example": "all", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_custom_conversions", "title": "Report Id", "description": "The report id" } }, "type": "object", "required": [ "report_id" ], "title": "WriteFacebookAdsPredefinedCustomConversionsReport", "description": "Facebook ads predefined custom conversions report, used for write." }, "WriteFacebookAdsPredefinedInsightBasicReport": { "properties": { "ads_ac": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IDNameInput" }, "type": "array" }, { "type": "null" } ], "title": "Ads Ac", "description": "Leave empty for all ads", "default": [] }, "ads_filter": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Ads Filter", "description": "Leave empty for all ads", "default": [] }, "ads_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Ads Ids", "description": "Leave empty for all ads", "default": [] }, "ads_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Ads Names", "description": "Leave empty for all ads", "default": [] }, "ads_type": { "anyOf": [ { "$ref": "#/components/schemas/FacebookAdsAdsTypeEnum" }, { "type": "null" } ], "description": "The type of ads input to use", "examples": [ "ads_ids", "ads_names", "ads_filter" ] }, "adsets_ac": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IDNameInput" }, "type": "array" }, { "type": "null" } ], "title": "Adsets Ac", "description": "Leave empty for all ad sets", "default": [] }, "adsets_filter": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Adsets Filter", "description": "Leave empty for all ad sets", "default": [] }, "adsets_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Adsets Ids", "description": "Leave empty for all ad sets", "default": [] }, "adsets_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Adsets Names", "description": "Leave empty for all ad sets", "default": [] }, "adsets_type": { "anyOf": [ { "$ref": "#/components/schemas/FacebookAdsSetsTypeEnum" }, { "type": "null" } ], "description": "The type of ad sets input to use", "examples": [ "adsets_names", "adsets_ids", "adsets_filter" ] }, "campaigns_ac": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IDNameInput" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Ac", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_filter": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Filter", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Ids", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Names", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_type": { "anyOf": [ { "$ref": "#/components/schemas/FacebookAdsCampaignsTypeEnum" }, { "type": "null" } ], "description": "The type of campaigns input to use", "examples": [ "campaigns_names", "campaigns_ids", "campaigns_filter" ] }, "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_insight_report_basic", "title": "Report Id", "description": "The report id" }, "incremental_field": { "const": "Date", "title": "Incremental Field", "description": "The interval field of the river entity.", "default": "Date", "examples": [ "date_field" ] }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteFacebookAdsPredefinedInsightBasicReport", "description": "Facebook ads predefined insights basic report, used for write." }, "WriteFacebookAdsPredefinedInsightReportAgeGender": { "properties": { "ads_ac": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IDNameInput" }, "type": "array" }, { "type": "null" } ], "title": "Ads Ac", "description": "Leave empty for all ads", "default": [] }, "ads_filter": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Ads Filter", "description": "Leave empty for all ads", "default": [] }, "ads_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Ads Ids", "description": "Leave empty for all ads", "default": [] }, "ads_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Ads Names", "description": "Leave empty for all ads", "default": [] }, "ads_type": { "anyOf": [ { "$ref": "#/components/schemas/FacebookAdsAdsTypeEnum" }, { "type": "null" } ], "description": "The type of ads input to use", "examples": [ "ads_ids", "ads_names", "ads_filter" ] }, "adsets_ac": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IDNameInput" }, "type": "array" }, { "type": "null" } ], "title": "Adsets Ac", "description": "Leave empty for all ad sets", "default": [] }, "adsets_filter": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Adsets Filter", "description": "Leave empty for all ad sets", "default": [] }, "adsets_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Adsets Ids", "description": "Leave empty for all ad sets", "default": [] }, "adsets_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Adsets Names", "description": "Leave empty for all ad sets", "default": [] }, "adsets_type": { "anyOf": [ { "$ref": "#/components/schemas/FacebookAdsSetsTypeEnum" }, { "type": "null" } ], "description": "The type of ad sets input to use", "examples": [ "adsets_names", "adsets_ids", "adsets_filter" ] }, "campaigns_ac": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IDNameInput" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Ac", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_filter": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Filter", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Ids", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Names", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_type": { "anyOf": [ { "$ref": "#/components/schemas/FacebookAdsCampaignsTypeEnum" }, { "type": "null" } ], "description": "The type of campaigns input to use", "examples": [ "campaigns_names", "campaigns_ids", "campaigns_filter" ] }, "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_insight_report_age_gender", "title": "Report Id", "description": "The report id" }, "incremental_field": { "const": "Date", "title": "Incremental Field", "description": "The interval field of the river entity.", "default": "Date", "examples": [ "date_field" ] }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteFacebookAdsPredefinedInsightReportAgeGender", "description": "Facebook ads predefined insights age gender report, used for write." }, "WriteFacebookAdsPredefinedInsightReportCountry": { "properties": { "ads_ac": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IDNameInput" }, "type": "array" }, { "type": "null" } ], "title": "Ads Ac", "description": "Leave empty for all ads", "default": [] }, "ads_filter": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Ads Filter", "description": "Leave empty for all ads", "default": [] }, "ads_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Ads Ids", "description": "Leave empty for all ads", "default": [] }, "ads_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Ads Names", "description": "Leave empty for all ads", "default": [] }, "ads_type": { "anyOf": [ { "$ref": "#/components/schemas/FacebookAdsAdsTypeEnum" }, { "type": "null" } ], "description": "The type of ads input to use", "examples": [ "ads_ids", "ads_names", "ads_filter" ] }, "adsets_ac": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IDNameInput" }, "type": "array" }, { "type": "null" } ], "title": "Adsets Ac", "description": "Leave empty for all ad sets", "default": [] }, "adsets_filter": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Adsets Filter", "description": "Leave empty for all ad sets", "default": [] }, "adsets_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Adsets Ids", "description": "Leave empty for all ad sets", "default": [] }, "adsets_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Adsets Names", "description": "Leave empty for all ad sets", "default": [] }, "adsets_type": { "anyOf": [ { "$ref": "#/components/schemas/FacebookAdsSetsTypeEnum" }, { "type": "null" } ], "description": "The type of ad sets input to use", "examples": [ "adsets_names", "adsets_ids", "adsets_filter" ] }, "campaigns_ac": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IDNameInput" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Ac", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_filter": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Filter", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Ids", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Names", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_type": { "anyOf": [ { "$ref": "#/components/schemas/FacebookAdsCampaignsTypeEnum" }, { "type": "null" } ], "description": "The type of campaigns input to use", "examples": [ "campaigns_names", "campaigns_ids", "campaigns_filter" ] }, "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_insight_report_country", "title": "Report Id", "description": "The report id" }, "incremental_field": { "const": "Date", "title": "Incremental Field", "description": "The interval field of the river entity.", "default": "Date", "examples": [ "date_field" ] }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteFacebookAdsPredefinedInsightReportCountry", "description": "Facebook ads predefined insights country report, used for write." }, "WriteFacebookAdsPredefinedInsightReportPlatform": { "properties": { "ads_ac": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IDNameInput" }, "type": "array" }, { "type": "null" } ], "title": "Ads Ac", "description": "Leave empty for all ads", "default": [] }, "ads_filter": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Ads Filter", "description": "Leave empty for all ads", "default": [] }, "ads_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Ads Ids", "description": "Leave empty for all ads", "default": [] }, "ads_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Ads Names", "description": "Leave empty for all ads", "default": [] }, "ads_type": { "anyOf": [ { "$ref": "#/components/schemas/FacebookAdsAdsTypeEnum" }, { "type": "null" } ], "description": "The type of ads input to use", "examples": [ "ads_ids", "ads_names", "ads_filter" ] }, "adsets_ac": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IDNameInput" }, "type": "array" }, { "type": "null" } ], "title": "Adsets Ac", "description": "Leave empty for all ad sets", "default": [] }, "adsets_filter": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Adsets Filter", "description": "Leave empty for all ad sets", "default": [] }, "adsets_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Adsets Ids", "description": "Leave empty for all ad sets", "default": [] }, "adsets_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Adsets Names", "description": "Leave empty for all ad sets", "default": [] }, "adsets_type": { "anyOf": [ { "$ref": "#/components/schemas/FacebookAdsSetsTypeEnum" }, { "type": "null" } ], "description": "The type of ad sets input to use", "examples": [ "adsets_names", "adsets_ids", "adsets_filter" ] }, "campaigns_ac": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IDNameInput" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Ac", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_filter": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Filter", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Ids", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Names", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_type": { "anyOf": [ { "$ref": "#/components/schemas/FacebookAdsCampaignsTypeEnum" }, { "type": "null" } ], "description": "The type of campaigns input to use", "examples": [ "campaigns_names", "campaigns_ids", "campaigns_filter" ] }, "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_insight_report_platform", "title": "Report Id", "description": "The report id" }, "incremental_field": { "const": "Date", "title": "Incremental Field", "description": "The interval field of the river entity.", "default": "Date", "examples": [ "date_field" ] }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteFacebookAdsPredefinedInsightReportPlatform", "description": "Facebook ads predefined insights platform report, used for write." }, "WriteFacebookAdsPredefinedInsightReportProduct": { "properties": { "ads_ac": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IDNameInput" }, "type": "array" }, { "type": "null" } ], "title": "Ads Ac", "description": "Leave empty for all ads", "default": [] }, "ads_filter": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Ads Filter", "description": "Leave empty for all ads", "default": [] }, "ads_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Ads Ids", "description": "Leave empty for all ads", "default": [] }, "ads_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Ads Names", "description": "Leave empty for all ads", "default": [] }, "ads_type": { "anyOf": [ { "$ref": "#/components/schemas/FacebookAdsAdsTypeEnum" }, { "type": "null" } ], "description": "The type of ads input to use", "examples": [ "ads_ids", "ads_names", "ads_filter" ] }, "adsets_ac": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IDNameInput" }, "type": "array" }, { "type": "null" } ], "title": "Adsets Ac", "description": "Leave empty for all ad sets", "default": [] }, "adsets_filter": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Adsets Filter", "description": "Leave empty for all ad sets", "default": [] }, "adsets_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Adsets Ids", "description": "Leave empty for all ad sets", "default": [] }, "adsets_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Adsets Names", "description": "Leave empty for all ad sets", "default": [] }, "adsets_type": { "anyOf": [ { "$ref": "#/components/schemas/FacebookAdsSetsTypeEnum" }, { "type": "null" } ], "description": "The type of ad sets input to use", "examples": [ "adsets_names", "adsets_ids", "adsets_filter" ] }, "campaigns_ac": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IDNameInput" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Ac", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_filter": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Filter", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Ids", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Campaigns Names", "description": "Leave empty for all campaigns", "default": [] }, "campaigns_type": { "anyOf": [ { "$ref": "#/components/schemas/FacebookAdsCampaignsTypeEnum" }, { "type": "null" } ], "description": "The type of campaigns input to use", "examples": [ "campaigns_names", "campaigns_ids", "campaigns_filter" ] }, "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_insight_report_product", "title": "Report Id", "description": "The report id" }, "incremental_field": { "const": "Date", "title": "Incremental Field", "description": "The interval field of the river entity.", "default": "Date", "examples": [ "date_field" ] }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteFacebookAdsPredefinedInsightReportProduct", "description": "Facebook ads predefined insights product report, used for write." }, "WriteFacebookAdsPredefinedSavedAudiencesReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "all", "examples": [ "all" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "example": "all", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_saved_audiences", "title": "Report Id", "description": "The report id" } }, "type": "object", "required": [ "report_id" ], "title": "WriteFacebookAdsPredefinedSavedAudiencesReport", "description": "Facebook ads predefined saved audiences report, used for write." }, "WritePredefinedReportFacebookAdsTableInput": { "properties": { "run_type_and_datasource": { "const": "predefined_report_facebook ads", "title": "Run Type And Datasource", "description": "Internal field", "default": "predefined_report_facebook ads" }, "details": { "anyOf": [ { "$ref": "#/components/schemas/WriteFacebookAdsPredefinedInsightBasicReport" }, { "$ref": "#/components/schemas/WriteFacebookAdsPredefinedCampaignsReport" }, { "$ref": "#/components/schemas/WriteFacebookAdsPredefinedAdsReport" }, { "$ref": "#/components/schemas/WriteFacebookAdsPredefinedAdLeadsFormsReport" }, { "$ref": "#/components/schemas/WriteFacebookAdsPredefinedAdsPixelsReport" }, { "$ref": "#/components/schemas/WriteFacebookAdsPredefinedAdSetsReport" }, { "$ref": "#/components/schemas/WriteFacebookAdsPredefinedAdAccountReport" }, { "$ref": "#/components/schemas/WriteFacebookAdsPredefinedAdAccountActivitiesReport" }, { "$ref": "#/components/schemas/WriteFacebookAdsPredefinedAdCreativesReport" }, { "$ref": "#/components/schemas/WriteFacebookAdsPredefinedAdLeadsReport" }, { "$ref": "#/components/schemas/WriteFacebookAdsPredefinedCustomAudiencesReport" }, { "$ref": "#/components/schemas/WriteFacebookAdsPredefinedCustomConversionsReport" }, { "$ref": "#/components/schemas/WriteFacebookAdsPredefinedInsightReportAgeGender" }, { "$ref": "#/components/schemas/WriteFacebookAdsPredefinedInsightReportCountry" }, { "$ref": "#/components/schemas/WriteFacebookAdsPredefinedInsightReportPlatform" }, { "$ref": "#/components/schemas/WriteFacebookAdsPredefinedInsightReportProduct" }, { "$ref": "#/components/schemas/WriteFacebookAdsPredefinedSavedAudiencesReport" } ], "title": "Details", "description": "The predefined report table details" } }, "additionalProperties": false, "type": "object", "required": [ "details" ], "title": "WritePredefinedReportFacebookAdsTableInput", "description": "Table properties which define the predefined report table data\nThis schema is being used for Create or Update purposes" }, "WritePredefinedReportShopifyTableInput": { "properties": { "run_type_and_datasource": { "const": "predefined_report_shopify", "title": "Run Type And Datasource", "description": "Internal field", "default": "predefined_report_shopify" }, "details": { "anyOf": [ { "$ref": "#/components/schemas/WriteShopifyPredefinedOrdersReport" }, { "$ref": "#/components/schemas/WriteShopifyPredefinedShopReport" }, { "$ref": "#/components/schemas/WriteShopifyPredefinedAddressesReport" }, { "$ref": "#/components/schemas/WriteShopifyPredefinedAnalyticReport" }, { "$ref": "#/components/schemas/WriteShopifyPredefinedCustomersReport" }, { "$ref": "#/components/schemas/WriteShopifyPredefinedInventoryLevelsReport" }, { "$ref": "#/components/schemas/WriteShopifyPredefinedMarketingEventsReport" }, { "$ref": "#/components/schemas/WriteShopifyPredefinedOrderTransactionsReport" }, { "$ref": "#/components/schemas/WriteShopifyPredefinedProductsReport" } ], "title": "Details", "description": "The predefined report table details" } }, "additionalProperties": false, "type": "object", "required": [ "details" ], "title": "WritePredefinedReportShopifyTableInput", "description": "Table properties which define the predefined report table data\nThis schema is being used for Create or Update purposes" }, "WritePredefinedReportTiktokTableInput": { "properties": { "run_type_and_datasource": { "const": "predefined_report_tiktok", "title": "Run Type And Datasource", "description": "Internal field", "default": "predefined_report_tiktok" }, "details": { "anyOf": [ { "$ref": "#/components/schemas/WriteTikTokPredefinedAdGroupsReport" }, { "$ref": "#/components/schemas/WriteTikTokPredefinedAdsReport" }, { "$ref": "#/components/schemas/WriteTikTokPredefinedAdvertisersInfoReport" }, { "$ref": "#/components/schemas/WriteTikTokPredefinedAuctionAdsAdGroupSkanReport" }, { "$ref": "#/components/schemas/WriteTikTokPredefinedAuctionAdsAdGroupsBasicDailyReport" }, { "$ref": "#/components/schemas/WriteTikTokPredefinedAuctionAdsAudienceCampaignAgeReport" }, { "$ref": "#/components/schemas/WriteTikTokPredefinedAuctionAdsAudienceCampaignCountryReport" }, { "$ref": "#/components/schemas/WriteTikTokPredefinedAuctionAdsAudienceCampaignGenderReport" }, { "$ref": "#/components/schemas/WriteTikTokPredefinedAuctionAdsAudienceCampaignLanguageReport" }, { "$ref": "#/components/schemas/WriteTikTokPredefinedAuctionAdsAudienceCampaignPlatformReport" }, { "$ref": "#/components/schemas/WriteTikTokPredefinedAuctionAdsBasicDailyReport" }, { "$ref": "#/components/schemas/WriteTikTokPredefinedAuctionAdsCampaignBasicDailyReport" }, { "$ref": "#/components/schemas/WriteTikTokPredefinedAuctionAdsCampaignSkanReport" }, { "$ref": "#/components/schemas/WriteTikTokPredefinedCampaignsReport" }, { "$ref": "#/components/schemas/WriteTikTokPredefinedImageFilesReport" }, { "$ref": "#/components/schemas/WriteTikTokPredefinedVideoFilesReport" } ], "title": "Details", "description": "The predefined report table details" } }, "additionalProperties": false, "type": "object", "required": [ "details" ], "title": "WritePredefinedReportTiktokTableInput", "description": "Table properties which define the predefined report table data\nThis schema is being used for Create or Update purposes" }, "WriteRiverInput": { "properties": { "name": { "type": "string", "title": "Name", "description": "The name of the river.", "examples": [ "river_name" ] }, "kind": { "anyOf": [ { "$ref": "#/components/schemas/RiverKindEnum" }, { "type": "null" } ], "description": "The kind of the river.", "default": "main_river", "examples": [ "main_river" ] }, "type": { "allOf": [ { "$ref": "#/components/schemas/RiverTypeEnum" } ], "description": "The type of river.", "examples": [ "source_to_target" ] }, "group_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Group Id", "description": "The id of the group the river belongs to.", "examples": [ "55fr7d4270fdca16cac18261" ] }, "group_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Group Name", "description": "The name of the group the river belongs to.", "examples": [ "river_group_1" ] }, "metadata": { "allOf": [ { "$ref": "#/components/schemas/RiverMetadata" } ], "description": "An object containing river metadata." }, "settings": { "allOf": [ { "$ref": "#/components/schemas/RiverSettings" } ], "description": "An object containing river settings." }, "properties": { "oneOf": [ { "$ref": "#/components/schemas/WriteSourceToTargetRiverPropertiesInput" }, { "$ref": "#/components/schemas/ActionProperties" }, { "$ref": "#/components/schemas/LogicProperties" } ], "title": "Properties", "description": "The properties of a river.", "discriminator": { "propertyName": "properties_type", "mapping": { "actions": "#/components/schemas/ActionProperties", "logic": "#/components/schemas/LogicProperties", "source_to_target": "#/components/schemas/WriteSourceToTargetRiverPropertiesInput" } } }, "schedulers": { "items": { "$ref": "#/components/schemas/RiverSchedule" }, "type": "array", "maxItems": 1, "minItems": 0, "title": "Schedulers", "description": "An object containing the schedule settings. Currently support only one scheduler", "default": [] }, "cross_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cross Id", "description": "The cross_id of the river to be deployed.", "hidden": true }, "deployment_definition": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Deployment Definition", "description": "The deployment definition of the river to be deployed.", "hidden": true }, "account_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Account Id", "description": "The account id.", "examples": [ "62e7f4352c13160013dc39be" ] }, "environment_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Environment Id", "description": "The environment id.", "examples": [ "62e7f4352c13160013dc39be" ] }, "environment_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Environment Name", "description": "The name of the environment.", "examples": [ "my_environment" ] } }, "additionalProperties": false, "type": "object", "required": [ "name", "type", "metadata", "settings", "properties" ], "title": "WriteRiverInput", "description": "River fields for new river creation / update an existing river." }, "WriteSchemaInput": { "properties": { "name": { "type": "string", "title": "Name", "description": "The name of the schema" }, "tables": { "items": { "oneOf": [ { "$ref": "#/components/schemas/WriteDatabaseTableInput" }, { "$ref": "#/components/schemas/WritePredefinedReportShopifyTableInput" }, { "$ref": "#/components/schemas/WritePredefinedReportFacebookAdsTableInput" }, { "$ref": "#/components/schemas/WritePredefinedReportTiktokTableInput" } ], "description": "The tables of the schema entity", "discriminator": { "propertyName": "run_type_and_datasource", "mapping": { "multi_tables": "#/components/schemas/WriteDatabaseTableInput", "predefined_report_facebook ads": "#/components/schemas/WritePredefinedReportFacebookAdsTableInput", "predefined_report_shopify": "#/components/schemas/WritePredefinedReportShopifyTableInput", "predefined_report_tiktok": "#/components/schemas/WritePredefinedReportTiktokTableInput" } } }, "type": "array", "title": "Tables", "default": [] } }, "type": "object", "required": [ "name" ], "title": "WriteSchemaInput", "description": "Schema properties to write (PUT operations)" }, "WriteShopifyPredefinedAddressesReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_addresses", "title": "Report Id", "description": "The report id" }, "incremental_field": { "allOf": [ { "$ref": "#/components/schemas/IncrementalFieldEnum" } ], "description": "The interval field of the river entity.", "default": "updated at", "examples": [ "date_field" ], "extra": { "display_name": "Incremental Field", "options": [ { "label": "updated at", "value": "updated at" }, { "label": "created at", "value": "created at" } ], "type": "incremental_field" } }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteShopifyPredefinedAddressesReport", "description": "Shopify predefined addresses report, used for write.", "extra_fields": { "skip_failed_queues": { "chakra": true, "display_name": "Number of allowed failed queues", "name": "skip_failed_queues", "readonly": true, "required": false, "type": "number", "value": 0 } }, "report_index": { "advanced_settings": 4, "date_range": 3, "extract_method": 0, "include_end_value": 4.1, "incremental_field": 1, "incremental_type": 2, "interval_size": 4.3, "skip_failed_queues": 5, "time_interval": 4.2 } }, "WriteShopifyPredefinedAnalyticReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_analytic_reports", "title": "Report Id", "description": "The report id" }, "incremental_field": { "const": "updated at", "title": "Incremental Field", "description": "The interval field of the river entity.", "default": "updated at", "examples": [ "date_field" ] }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteShopifyPredefinedAnalyticReport", "description": "Shopify predefined analytic report, used for write.", "extra_fields": { "skip_failed_queues": { "chakra": true, "display_name": "Number of allowed failed queues", "name": "skip_failed_queues", "readonly": true, "required": false, "type": "number", "value": 0 } }, "report_index": { "advanced_settings": 4, "date_range": 3, "extract_method": 0, "include_end_value": 4.1, "incremental_field": 1, "incremental_type": 2, "interval_size": 4.3, "skip_failed_queues": 5, "time_interval": 4.2 } }, "WriteShopifyPredefinedCustomersReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_customers", "title": "Report Id", "description": "The report id" }, "incremental_field": { "allOf": [ { "$ref": "#/components/schemas/IncrementalFieldEnum" } ], "description": "The interval field of the river entity.", "default": "updated at", "examples": [ "date_field" ], "extra": { "display_name": "Incremental Field", "options": [ { "label": "updated at", "value": "updated at" }, { "label": "created at", "value": "created at" } ], "type": "incremental_field" } }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteShopifyPredefinedCustomersReport", "description": "Shopify predefined analytic report, used for write.", "extra_fields": { "skip_failed_queues": { "chakra": true, "display_name": "Number of allowed failed queues", "name": "skip_failed_queues", "readonly": true, "required": false, "type": "number", "value": 0 } }, "report_index": { "advanced_settings": 4, "date_range": 3, "extract_method": 0, "include_end_value": 4.1, "incremental_field": 1, "incremental_type": 2, "interval_size": 4.3, "skip_failed_queues": 5, "time_interval": 4.2 } }, "WriteShopifyPredefinedInventoryLevelsReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_inventory_levels", "title": "Report Id", "description": "The report id" }, "incremental_field": { "allOf": [ { "$ref": "#/components/schemas/IncrementalFieldEnum" } ], "description": "The interval field of the river entity.", "default": "created at", "examples": [ "date_field" ], "extra": { "display_name": "Incremental Field", "options": [ { "label": "updated at", "value": "updated at" }, { "label": "created at", "value": "created at" } ], "type": "incremental_field" } }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteShopifyPredefinedInventoryLevelsReport", "description": "Shopify predefined inventory levels report, used for write.", "extra_fields": { "skip_failed_queues": { "chakra": true, "display_name": "Number of allowed failed queues", "name": "skip_failed_queues", "readonly": true, "required": false, "type": "number", "value": 0 } }, "report_index": { "advanced_settings": 4, "date_range": 3, "extract_method": 0, "include_end_value": 4.1, "incremental_field": 1, "incremental_type": 2, "interval_size": 4.3, "skip_failed_queues": 5, "time_interval": 4.2 } }, "WriteShopifyPredefinedMarketingEventsReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "all", "examples": [ "all" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "example": "all", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_marketing_events", "title": "Report Id", "description": "The report id" } }, "type": "object", "required": [ "report_id" ], "title": "WriteShopifyPredefinedMarketingEventsReport", "description": "Shopify predefined marketing events report, used for write.", "report_index": { "extract_method": 0 } }, "WriteShopifyPredefinedOrderTransactionsReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_order_transactions", "title": "Report Id", "description": "The report id" }, "incremental_field": { "allOf": [ { "$ref": "#/components/schemas/IncrementalFieldEnum" } ], "description": "The interval field of the river entity.", "default": "updated at", "examples": [ "date_field" ], "extra": { "display_name": "Incremental Field", "options": [ { "label": "updated at", "value": "updated at" }, { "label": "created at", "value": "created at" } ], "type": "incremental_field" } }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteShopifyPredefinedOrderTransactionsReport", "description": "Shopify predefined order transaction report, used for write.", "extra_fields": { "skip_failed_queues": { "chakra": true, "display_name": "Number of allowed failed queues", "name": "skip_failed_queues", "readonly": true, "required": false, "type": "number", "value": 0 } }, "report_index": { "advanced_settings": 4, "date_range": 3, "extract_method": 0, "include_end_value": 4.1, "incremental_field": 1, "incremental_type": 2, "interval_size": 4.3, "skip_failed_queues": 5, "time_interval": 4.2 } }, "WriteShopifyPredefinedOrdersReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_orders", "title": "Report Id", "description": "The report id" }, "incremental_field": { "const": "updated at", "title": "Incremental Field", "description": "The interval field of the river entity.", "default": "updated at", "examples": [ "date_field" ], "extra": { "display_name": "Incremental Field", "options": [ { "label": "updated at", "value": "updated at" } ], "type": "incremental_field" } }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } }, "status": { "allOf": [ { "$ref": "#/components/schemas/StatusEnum" } ], "description": "Filter by order status", "default": "any", "extra": { "chakra": true, "display_name": "Status", "options": [ { "id": "any", "name": "Any" }, { "id": "cancelled", "name": "Cancelled" }, { "id": "closed", "name": "Closed" }, { "id": "open", "name": "Open" } ], "required": true, "type": "list_single_options" } }, "financial_status": { "allOf": [ { "$ref": "#/components/schemas/FinancialStatusEnum" } ], "description": "Filter by order's financial status", "default": "any", "extra": { "chakra": true, "display_name": "Financial Status", "options": [ { "id": "any", "name": "Any" }, { "id": "paid", "name": "Paid" }, { "id": "unpaid", "name": "Unpaid" }, { "id": "voided", "name": "Voided" }, { "id": "pending", "name": "Pending" }, { "id": "refunded", "name": "Refunded" }, { "id": "authorized", "name": "Authorized" }, { "id": "partially_paid", "name": "Partially paid" }, { "id": "partially_refunded", "name": "Partially refunded" } ], "type": "list_single_options" } } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteShopifyPredefinedOrdersReport", "description": "Shopify predefined orders report, used for write.", "extra_fields": { "skip_failed_queues": { "chakra": true, "display_name": "Number of allowed failed queues", "name": "skip_failed_queues", "readonly": true, "required": false, "type": "number", "value": 0 } }, "report_index": { "advanced_settings": 6, "date_range": 5, "extract_method": 2, "financial_status": 1, "include_end_value": 6.1, "incremental_field": 3, "incremental_type": 4, "interval_size": 6.3, "skip_failed_queues": 7, "status": 0, "time_interval": 6.2 } }, "WriteShopifyPredefinedProductsReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_products", "title": "Report Id", "description": "The report id" }, "incremental_field": { "allOf": [ { "$ref": "#/components/schemas/ProductsIncrementalFieldEnum" } ], "description": "The interval field of the river entity.", "default": "updated at", "examples": [ "date_field" ], "extra": { "display_name": "Incremental Field", "options": [ { "label": "updated at", "value": "updated at" }, { "label": "created at", "value": "created at" }, { "label": "published at", "value": "published at" } ], "type": "incremental_field" } }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteShopifyPredefinedProductsReport", "description": "Shopify predefined products report, used for write.", "extra_fields": { "skip_failed_queues": { "chakra": true, "display_name": "Number of allowed failed queues", "name": "skip_failed_queues", "readonly": true, "required": false, "type": "number", "value": 0 } }, "report_index": { "advanced_settings": 4, "date_range": 3, "extract_method": 0, "include_end_value": 4.1, "incremental_field": 1, "incremental_type": 2, "interval_size": 4.3, "skip_failed_queues": 5, "time_interval": 4.2 } }, "WriteShopifyPredefinedShopReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "all", "examples": [ "all" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "example": "all", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_shop", "title": "Report Id", "description": "The report id" } }, "type": "object", "required": [ "report_id" ], "title": "WriteShopifyPredefinedShopReport", "description": "Shopify predefined shop report, used for write.", "report_index": { "extract_method": 0 } }, "WriteSourceToTargetRiverPropertiesInput": { "properties": { "properties_type": { "const": "source_to_target", "title": "Properties Type", "default": "source_to_target" }, "source": { "allOf": [ { "$ref": "#/components/schemas/SourceSettings" } ], "description": "The source of the river." }, "target": { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTargetSettings" }, { "$ref": "#/components/schemas/S3TargetSettings" }, { "$ref": "#/components/schemas/EmailTargetSettings" }, { "$ref": "#/components/schemas/BlobStorageSettings" }, { "$ref": "#/components/schemas/GcsTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTargetSettings" }, { "$ref": "#/components/schemas/AthenaTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTargetSettings" }, { "$ref": "#/components/schemas/PostgresTargetSettings" } ], "title": "Target", "description": "The target of the river.", "discriminator": { "propertyName": "name", "mapping": { "athena": "#/components/schemas/AthenaTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTargetSettings", "bigquery": "#/components/schemas/BigQueryTargetSettings", "blob_storage": "#/components/schemas/BlobStorageSettings", "databricks": "#/components/schemas/DatabricksTargetSettings", "gcs": "#/components/schemas/GcsTargetSettings", "postgres_rds": "#/components/schemas/PostgresTargetSettings", "redshift": "#/components/schemas/RedshiftTargetSettings", "s3": "#/components/schemas/S3TargetSettings", "snowflake": "#/components/schemas/SnowflakeTargetSettings", "target_email": "#/components/schemas/EmailTargetSettings" } } }, "schemas": { "items": { "$ref": "#/components/schemas/WriteSchemaInput" }, "type": "array", "title": "Schemas", "description": "The schemas of the river entity", "default": [] } }, "additionalProperties": false, "type": "object", "required": [ "source", "target" ], "title": "WriteSourceToTargetRiverPropertiesInput", "description": "Source to target River properties that is being used for PUT purposes" }, "WriteTikTokPredefinedAdGroupsReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_ad_groups", "title": "Report Id", "description": "The report id" }, "incremental_field": { "const": "modify_time", "title": "Incremental Field", "description": "The interval field of the river entity.", "default": "modify_time", "examples": [ "modify_time" ] }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteTikTokPredefinedAdGroupsReport", "description": "TikTok predefined ad groups report, used for write." }, "WriteTikTokPredefinedAdsReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_ads", "title": "Report Id", "description": "The report id" }, "incremental_field": { "const": "modify_time", "title": "Incremental Field", "description": "The interval field of the river entity.", "default": "modify_time", "examples": [ "modify_time" ] }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } }, "primary_status": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Primary Status", "description": "Leave empty to get all available data", "default": [] } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteTikTokPredefinedAdsReport", "description": "TikTok predefined ads report, used for write." }, "WriteTikTokPredefinedAdvertisersInfoReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "all", "examples": [ "all" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "example": "all", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_advertisers_info", "title": "Report Id", "description": "The report id" } }, "type": "object", "required": [ "report_id" ], "title": "WriteTikTokPredefinedAdvertisersInfoReport", "description": "TikTok predefined advertisers info report, used for write." }, "WriteTikTokPredefinedAuctionAdsAdGroupSkanReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_auction_ads_ad_group_skan", "title": "Report Id", "description": "The report id" }, "incremental_field": { "const": "stat_time_day", "title": "Incremental Field", "description": "The interval field of the river entity.", "default": "stat_time_day", "examples": [ "stat_time_day" ] }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteTikTokPredefinedAuctionAdsAdGroupSkanReport", "description": "TikTok predefined auction ads ad group skan report, used for write." }, "WriteTikTokPredefinedAuctionAdsAdGroupsBasicDailyReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_auction_ads_adgroups_basic_daily", "title": "Report Id", "description": "The report id" }, "incremental_field": { "const": "stat_time_day", "title": "Incremental Field", "description": "The interval field of the river entity.", "default": "stat_time_day", "examples": [ "stat_time_day" ] }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteTikTokPredefinedAuctionAdsAdGroupsBasicDailyReport", "description": "TikTok predefined auction ads ad groups basic daily report, used for write." }, "WriteTikTokPredefinedAuctionAdsAudienceCampaignAgeReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_auction_ads_audience_campaign_age", "title": "Report Id", "description": "The report id" }, "incremental_field": { "const": "stat_time_day", "title": "Incremental Field", "description": "The interval field of the river entity.", "default": "stat_time_day", "examples": [ "stat_time_day" ] }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } }, "campaign_ids": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IDNameInput" }, "type": "array" }, { "type": "null" } ], "title": "Campaign Ids", "description": "Leave empty for all campaigns", "default": [] } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteTikTokPredefinedAuctionAdsAudienceCampaignAgeReport", "description": "TikTok predefined auction ads audience campaign age report, used for write." }, "WriteTikTokPredefinedAuctionAdsAudienceCampaignCountryReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_auction_ads_audience_campaign_country", "title": "Report Id", "description": "The report id" }, "incremental_field": { "const": "stat_time_day", "title": "Incremental Field", "description": "The interval field of the river entity.", "default": "stat_time_day", "examples": [ "stat_time_day" ] }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } }, "campaign_ids": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IDNameInput" }, "type": "array" }, { "type": "null" } ], "title": "Campaign Ids", "description": "Leave empty for all campaigns", "default": [] } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteTikTokPredefinedAuctionAdsAudienceCampaignCountryReport", "description": "TikTok predefined auction ads audience campaign country report, used for write." }, "WriteTikTokPredefinedAuctionAdsAudienceCampaignGenderReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_auction_ads_audience_campaign_gender", "title": "Report Id", "description": "The report id" }, "incremental_field": { "const": "stat_time_day", "title": "Incremental Field", "description": "The interval field of the river entity.", "default": "stat_time_day", "examples": [ "stat_time_day" ] }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } }, "campaign_ids": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IDNameInput" }, "type": "array" }, { "type": "null" } ], "title": "Campaign Ids", "description": "Leave empty for all campaigns", "default": [] } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteTikTokPredefinedAuctionAdsAudienceCampaignGenderReport", "description": "TikTok predefined auction ads audience campaign gender report, used for write." }, "WriteTikTokPredefinedAuctionAdsAudienceCampaignLanguageReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_auction_ads_audience_campaign_language", "title": "Report Id", "description": "The report id" }, "incremental_field": { "const": "stat_time_day", "title": "Incremental Field", "description": "The interval field of the river entity.", "default": "stat_time_day", "examples": [ "stat_time_day" ] }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } }, "campaign_ids": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IDNameInput" }, "type": "array" }, { "type": "null" } ], "title": "Campaign Ids", "description": "Leave empty for all campaigns", "default": [] } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteTikTokPredefinedAuctionAdsAudienceCampaignLanguageReport", "description": "TikTok predefined auction ads audience campaign language report, used for write." }, "WriteTikTokPredefinedAuctionAdsAudienceCampaignPlatformReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_auction_ads_audience_campaign_platform", "title": "Report Id", "description": "The report id" }, "incremental_field": { "const": "stat_time_day", "title": "Incremental Field", "description": "The interval field of the river entity.", "default": "stat_time_day", "examples": [ "stat_time_day" ] }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } }, "campaign_ids": { "items": { "type": "string" }, "type": "array", "title": "Campaign Ids", "description": "Leave empty for all campaigns", "default": [] } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteTikTokPredefinedAuctionAdsAudienceCampaignPlatformReport", "description": "TikTok predefined auction ads audience campaign platform report, used for write." }, "WriteTikTokPredefinedAuctionAdsBasicDailyReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_auction_ads_basic_daily", "title": "Report Id", "description": "The report id" }, "incremental_field": { "const": "stat_time_day", "title": "Incremental Field", "description": "The interval field of the river entity.", "default": "stat_time_day", "examples": [ "stat_time_day" ] }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } }, "ad_ids": { "items": { "type": "string" }, "type": "array", "title": "Ad Ids", "description": "The ad ids", "default": [] } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteTikTokPredefinedAuctionAdsBasicDailyReport", "description": "TikTok predefined auction ads basic daily report, used for write." }, "WriteTikTokPredefinedAuctionAdsCampaignBasicDailyReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_auction_ads_campaign_basic_daily", "title": "Report Id", "description": "The report id" }, "incremental_field": { "const": "stat_time_day", "title": "Incremental Field", "description": "The interval field of the river entity.", "default": "stat_time_day", "examples": [ "stat_time_day" ] }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } }, "campaign_ids": { "items": { "type": "string" }, "type": "array", "title": "Campaign Ids", "description": "The campaign ids", "default": [] } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteTikTokPredefinedAuctionAdsCampaignBasicDailyReport", "description": "TikTok predefined auction ads campaign basic daily report, used for write." }, "WriteTikTokPredefinedAuctionAdsCampaignSkanReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_auction_ads_campaign_skan", "title": "Report Id", "description": "The report id" }, "incremental_field": { "const": "stat_time_day", "title": "Incremental Field", "description": "The interval field of the river entity.", "default": "stat_time_day", "examples": [ "stat_time_day" ] }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } }, "campaign_ids": { "anyOf": [ { "items": { "$ref": "#/components/schemas/IDNameInput" }, "type": "array" }, { "type": "null" } ], "title": "Campaign Ids", "description": "Leave empty for all campaigns", "default": [] } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteTikTokPredefinedAuctionAdsCampaignSkanReport", "description": "TikTok predefined auction ads campaign skan report, used for write." }, "WriteTikTokPredefinedCampaignsReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "incremental", "examples": [ "incremental" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_campaigns", "title": "Report Id", "description": "The report id" }, "incremental_field": { "const": "modify_time", "title": "Incremental Field", "description": "The interval field of the river entity.", "default": "modify_time", "examples": [ "modify_time" ] }, "date_range": { "allOf": [ { "$ref": "#/components/schemas/DateRange" } ], "description": "The date range of the river entity.", "extra": { "type": "date_range" } } }, "additionalProperties": false, "type": "object", "required": [ "report_id", "date_range" ], "title": "WriteTikTokPredefinedCampaignsReport", "description": "TikTok predefined campaigns report, used for write." }, "WriteTikTokPredefinedImageFilesReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "all", "examples": [ "all" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "example": "all", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_image_files", "title": "Report Id", "description": "The report id" } }, "type": "object", "required": [ "report_id" ], "title": "WriteTikTokPredefinedImageFilesReport", "description": "TikTok predefined image files report, used for write." }, "WriteTikTokPredefinedVideoFilesReport": { "properties": { "is_selected": { "type": "boolean", "title": "Is Selected", "description": "If the table is selected or not.", "default": false, "examples": [true] }, "target_table": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Table", "description": "The name of the target table relevant to multi-tables and predefined rivers", "examples": [ "target_table_name" ] }, "modified_columns": { "items": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/BigQueryModifiedColumn" }, { "$ref": "#/components/schemas/SnowflakeModifiedColumn" }, { "$ref": "#/components/schemas/RedshiftModifiedColumn" }, { "$ref": "#/components/schemas/S3ModifiedColumn" }, { "$ref": "#/components/schemas/GCSModifiedColumn" }, { "$ref": "#/components/schemas/EmailModifiedColumn" }, { "$ref": "#/components/schemas/AthenaModifiedColumn" }, { "$ref": "#/components/schemas/AzureSqlModifiedColumn" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn" }, { "$ref": "#/components/schemas/DatabricksModifiedColumn" }, { "$ref": "#/components/schemas/PostgresModifiedColumn" }, { "$ref": "#/components/schemas/AzureBlobModifiedColumn" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaModifiedColumn", "azure_sql": "#/components/schemas/AzureSqlModifiedColumn", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsModifiedColumn", "bigquery": "#/components/schemas/BigQueryModifiedColumn", "blob_storage": "#/components/schemas/AzureBlobModifiedColumn", "databricks": "#/components/schemas/DatabricksModifiedColumn", "gcs": "#/components/schemas/GCSModifiedColumn", "postgres_rds": "#/components/schemas/PostgresModifiedColumn", "redshift": "#/components/schemas/RedshiftModifiedColumn", "s3": "#/components/schemas/S3ModifiedColumn", "snowflake": "#/components/schemas/SnowflakeModifiedColumn", "target_email": "#/components/schemas/EmailModifiedColumn" } } }, { "type": "null" } ], "description": "The modified columns of the river entity for example if you want to unselect a column or change the column name or type." }, "type": "array", "title": "Modified Columns", "description": "The modified columns of the river entityfor example if you want to unselect a column or change the column name or type.", "default": [] }, "additional_target_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/RedshiftTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/BigQueryTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AthenaTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSqlTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/PostgresTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings" }, { "$ref": "#/components/schemas/DatabricksTableAdditionalTargetSettings" } ], "discriminator": { "propertyName": "target_type", "mapping": { "athena": "#/components/schemas/AthenaTableAdditionalTargetSettings", "azure_sql": "#/components/schemas/AzureSqlTableAdditionalTargetSettings", "azure_synapse_analytics": "#/components/schemas/AzureSynapseAnalyticsTableAdditionalTargetSettings", "bigquery": "#/components/schemas/BigQueryTableAdditionalTargetSettings", "databricks": "#/components/schemas/DatabricksTableAdditionalTargetSettings", "postgres_rds": "#/components/schemas/PostgresTableAdditionalTargetSettings", "redshift": "#/components/schemas/RedshiftTableAdditionalTargetSettings", "snowflake": "#/components/schemas/SnowflakeTableAdditionalTargetSettings" } } }, { "type": "null" } ], "title": "Additional Target Settings", "description": "The additional target settings of this table.", "examples": [ { "enforce_masking_policy": false, "is_ordered_merge_key": false, "recreate_keys": false, "target_type": "snowflake" }, { "distribution_method": "even", "is_ordered_merge_key": false, "target_type": "redshift" } ] }, "extract_method": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Extract Method", "description": "The extract method of the table entity.", "default": "all", "examples": [ "all" ], "extra": { "display_name": "Pick the way you would like to extract data from your source", "example": "all", "is_disabled": true, "name": "extract_method", "title": "Extract Method", "type": "extract_method" } }, "report_id": { "const": "predefined_video_files", "title": "Report Id", "description": "The report id" } }, "type": "object", "required": [ "report_id" ], "title": "WriteTikTokPredefinedVideoFilesReport", "description": "TikTok predefined video files report, used for write." } }, "securitySchemes": { "HTTPBearer": { "type": "http", "scheme": "bearer" } } }, "tags": [ { "name": "Rivers", "description": "Management of rivers" }, { "name": "Activities", "description": "Get the Boomi Data Integration activities data with various of GET operations" }, { "name": "Operations", "description": "Management of the status response of any given asynchronous operation ID" }, { "name": "Connections", "description": "Management of connection entities" }, { "name": "Dataframes", "description": "Management of dataframe entities" }, { "name": "Environments", "description": "Listing account's environments" }, { "name": "Accounts", "description": "Listing accounts" }, { "name": "Audit Events", "description": "Listing account's audit events" } ], "externalDocs": { "description": "Find out more about Data Integration", "url": "https://help.boomi.com/docs/Atomsphere/Data_Integration/Data_Integration_Overview" } }