openapi: 3.2.0
info:
  title: Boomi Data Integration Logicode 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: Logicode
  description: Management of the Logic Python feature
paths:
  /v1/accounts/{account_id}/environments/{environment_id}/logicode_file/{file_id}:
    get:
      tags:
      - Logicode
      summary: Get Logicode Files
      description: '**Authorization scope:** `logicode:list`


        **Get the logicode file of the python script for a specific account id and**

        **environment id.**

        ****

        ****

        ****

        **The endpoint returns a S3 pre-signed URL of the python''s step.**

        ****

        **e.g. [GET] v1/accounts/55bf7c4270fdca16cac18761/environments/563f5b62b0a10e18f0808895/**

        **logicode_file/60abd52d62833f001eb05be6**'
      operationId: get_logicode_files
      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: file_id
        in: path
        required: true
        schema:
          type: string
          title: File Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LogicodeScriptFileResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/accounts/{account_id}/environments/{environment_id}/logicode_file:
    post:
      tags:
      - Logicode
      summary: Add Logicode File
      description: '**Authorization scope:** `data flow:write`


        **Add a logicode file to the account id and environment id.**'
      operationId: add_logicode_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
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLogicodeFileInput'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateFileResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    CreateFileResponse:
      properties:
        file_id:
          type: string
          title: File Id
          description: The file id
        url:
          type: string
          title: Url
          description: The presigned url for the file. With this URL you can update the file content.
      type: object
      required:
      - file_id
      - url
      title: CreateFileResponse
      description: The response for the create file
    LogicodeScriptFileResponse:
      properties:
        url:
          type: string
          title: Url
        filename:
          anyOf:
          - type: string
          - type: 'null'
          title: Filename
          description: The file name
      type: object
      required:
      - url
      title: LogicodeScriptFileResponse
      description: This response contains the filename
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
    CreateLogicodeFileInput:
      properties:
        file_name:
          type: string
          title: File Name
          description: The logicode file name
      type: object
      required:
      - file_name
      title: CreateLogicodeFileInput
      description: The input for the logicode file
  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