openapi: 3.2.0
info:
  title: Boomi Data Integration Dataframes API
  description: '# Boomi Data Integration API documentation


    Welcome to the Boomi Data Integration API Documentation.'
  contact:
    name: Boomi Data Integration Documentation
    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
tags:
- name: Dataframes
  description: Management of dataframe entities
paths:
  /v1/accounts/{account_id}/environments/{environment_id}/dataframes:
    get:
      tags:
      - Dataframes
      summary: Get Dataframes
      description: '**Authorization scope:** `dataframe:list`


        **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`


        **Creates a new dataframe entity.**

        ****

        **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`


        **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`


        **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`


        **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`


        **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.**'
      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`


        **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.**'
      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'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
    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
    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    "
    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
    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    "
    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.
    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    "
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
externalDocs:
  description: Find out more about Data Integration
  url: https://help.boomi.com/docs/Atomsphere/Data_Integration/Data_Integration_Overview