Boomi Data Integration API Reference (1.0.0) - Dataframes

Toggle Pane

• Dataframes
  • getGet Dataframes
  • postAdd Dataframe
  • getGet Dataframe
  • delDelete Dataframe
  • putUpdate Dataframe
  • getDownload Dataframe
  • postClear Dataframe Values

API docs by Redocly

Download OpenAPI Specification: Download

Find out more about Data Integration

Dataframes

Management of dataframe entities

Get Dataframes

Authorization scope: dataframe:list

Get all dataframe entities from the DB

Authorizations:

HTTPBearer

path Parameters

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

query Parameters

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

Responses

Response Schema: application/json

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

US

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

EU

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

Response samples

• 200
• 422

Content type

application/json

{

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

  • {

    • "account_id": "62e7f4352c13160013dc39be",
    • "environment_id": "82e7f4122c13169813dc395g",
    • "connection_settings": "\"connection_settings\":{\n \"connection\" : \"6278159bcfc148000fad5632\",\n \"datasource_id\" : \"s3\",\n \"storage_type\" : \"aws\",\n \"default_bucket\" : \"rivery-dev-tests\"}",
    • "name": "unique_name"

    }

  ]

}

Add Dataframe

Authorization scope: dataframe:write

Creates a new dataframe entity.

---

Please note that the Dataframe's name has to be unique

Authorizations:

HTTPBearer

path Parameters

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

Request Body schema: application/json

required

name required	string (Name) The name of the dataframe - must be unique
	DataframeConnectionSettingsInput (object) or null The connection settings of the dataframe

Responses

US

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

EU

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

Request samples

• Payload

Content type

application/json

{

• "connection_settings": "\"connection_settings\":{\n \"connection\" : \"6278159bcfc148000fad5632\",\n \"datasource_id\" : \"s3\",\n \"storage_type\" : \"aws\",\n \"default_bucket\" : \"rivery-dev-tests\"}\n ",
• "name": "unique_name"

}

Response samples

• 201
• 422

Content type

application/json

{

• "account_id": "62e7f4352c13160013dc39be",
• "environment_id": "82e7f4122c13169813dc395g",
• "connection_settings": "\"connection_settings\":{\n \"connection\" : \"6278159bcfc148000fad5632\",\n \"datasource_id\" : \"s3\",\n \"storage_type\" : \"aws\",\n \"default_bucket\" : \"rivery-dev-tests\"}",
• "name": "unique_name"

}

Get Dataframe

Authorization scope: dataframe:list

Get a specific dataframe by name.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
dataframe_name required	string (Dataframe Name)

Responses

Response Schema: application/json

account_id required	string (Account Id) The account id of the user
environment_id required	string (Environment Id) The environment id of the user
name required	string (Name) The name of the dataframe - must be unique
connection_settings	object (Connection Settings) Default: {} The connection settings of the dataframe

US

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

EU

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

Response samples

• 200
• 422

Content type

application/json

{

• "account_id": "62e7f4352c13160013dc39be",
• "environment_id": "82e7f4122c13169813dc395g",
• "connection_settings": "\"connection_settings\":{\n \"connection\" : \"6278159bcfc148000fad5632\",\n \"datasource_id\" : \"s3\",\n \"storage_type\" : \"aws\",\n \"default_bucket\" : \"rivery-dev-tests\"}",
• "name": "unique_name"

}

Delete Dataframe

Authorization scope: dataframe:write

Delete a dataframe.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
dataframe_name required	string (Dataframe Name)

Responses

Response Schema: application/json

any

US

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

EU

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

Response samples

• 200
• 422

Content type

application/json

null

Update Dataframe

Authorization scope: dataframe:write

Updates an existing dataframe entity. Please note that only the connecting_settings field can be modified

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
dataframe_name required	string (Dataframe Name)

Request Body schema: application/json

required

	DataframeConnectionSettingsInput (object) or null The connection settings of the dataframe
Any of connection required string (Connection) The connection of the connection_settings datasource_id required string (Datasource Id) The datasource_id of the connection_settings default_bucket required string (Default Bucket) The default bucket of the connection settings storage_type required string (Storage Type) The storage type of the connection settings

Responses

Response Schema: application/json

account_id required	string (Account Id) The account id of the user
environment_id required	string (Environment Id) The environment id of the user
name required	string (Name) The name of the dataframe - must be unique
connection_settings	object (Connection Settings) Default: {} The connection settings of the dataframe

US

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

EU

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

Request samples

• Payload

Content type

application/json

{

• "connection_settings": "\"connection_settings\":{\n \"connection\" : \"6278159bcfc148000fad5632\",\n \"datasource_id\" : \"s3\",\n \"storage_type\" : \"aws\",\n \"default_bucket\" : \"rivery-dev-tests\"}\n "

}

Response samples

• 200
• 422

Content type

application/json

{

• "account_id": "62e7f4352c13160013dc39be",
• "environment_id": "82e7f4122c13169813dc395g",
• "connection_settings": "\"connection_settings\":{\n \"connection\" : \"6278159bcfc148000fad5632\",\n \"datasource_id\" : \"s3\",\n \"storage_type\" : \"aws\",\n \"default_bucket\" : \"rivery-dev-tests\"}",
• "name": "unique_name"

}

Download Dataframe

Authorization scope: dataframe:list

This endpoint creates a new task for downloading a dataframe.

---

---

Be advised: the task is an async operation, which means that after creating the task, the client must call the endpoint GET operation in order to get the result.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
dataframe_name required	string (Dataframe Name)

Responses

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/dataframes/{dataframe_name}/download

EU

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

Response samples

• 202
• 422

Content type

application/json

{

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

}

Clear Dataframe Values

Authorization scope: dataframe:write

This endpoint creates an asynchronous operation for clearing the Dataframe's data. .

---

Please note - this is different from deleting the Dataframe, which deletes both the Dataframe's data and configuration.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
dataframe_name required	string (Dataframe Name)

Responses

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/dataframes/{dataframe_name}/clear

EU

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

Response samples

• 202
• 422

Content type

application/json

{

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

}