Rivery Operations API

openapi: 3.2.0
info:
  title: Boomi Data Integration Operations 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: Operations
  description: Management of the status response of any given asynchronous operation ID
paths:
  /v1/accounts/{account_id}/environments/{environment_id}/operations/{operation_id}:
    get:
      tags:
      - Operations
      summary: Get Operation Status
      description: '**Authorization scope:** `operations:list`


        **For a given asynchronous operation ID, the endpoint returns its status.**


        ---


        ### 📖 Instructions for usage


        `activate_data_flow`, `get_operation`


        **`activate_data_flow`**


        ```

        Activate (schedule) a data flow so it runs on its configured schedule.


        Set wait=True to block until activation completes or fails — eliminates

        the need to manually call get_operation in a loop.

        Returns the final operation status when wait=True.

        ```


        **`get_operation`**


        ```

        Get an activation/validation operation by its operation_id (24-char hex).


        This is for activate_river / validate operations only.

        For data run status, use get_run instead.

        ```'
      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'
      x-mcp-tool:
      - activate_data_flow
      - get_operation
  /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:** `data flow:write`


        **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'
components:
  schemas:
    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
    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
    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.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  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