Conga File Store API

openapi: 3.2.0
info:
  title: File Store API
  version: v1
servers:
- url: https://rls.congacloud.com
security:
- Bearer: []
tags:
- name: File Store
paths:
  /api/filestore/v1/files:
    delete:
      tags:
      - File Store
      summary: Delete a file from the file store
      description: Validates if the specified file exists at the given path and deletes it if found.
      requestBody:
        description: 'The request object containing the file details to delete, including:

          - FileName: The name of the file to be deleted.

          - FilePath: The path where the file is stored.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteFileRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/DeleteFileRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/DeleteFileRequest'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DeleteFileResponseAPIResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteFileResponseAPIResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/DeleteFileResponseAPIResponse'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
            text/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
        '503':
          description: Service Temporarily Unavailable
  /api/filestore/v1/files/bulk:
    delete:
      tags:
      - File Store
      summary: Delete multiple files from the file store
      description: "Deletes multiple files at the given path with partial success handling. \nFound files are deleted, while missing files return detailed error information. \nEach file’s deletion status is tracked in the response."
      requestBody:
        description: 'The request object containing:

          - FilePath: Common path where the files are stored.

          - FileNames: Collection of file names to be deleted.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkDeleteFileRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/BulkDeleteFileRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/BulkDeleteFileRequest'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DeleteFileResponseAPIResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteFileResponseAPIResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/DeleteFileResponseAPIResponse'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
            text/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
        '503':
          description: Service Temporarily Unavailable
    post:
      tags:
      - File Store
      summary: Upload multiple files
      description: 'Upload multiple files in a single request, including file contents and metadata.

        Each file can have unique tags, expiration settings, and shared URI configuration.

        Files are stored at the specified path.'
      requestBody:
        description: 'The request object containing:

          - FilePath: Common path where all files will be stored.

          - Files: Collection of file data, including file names, content, tags, and optional settings.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkCreateFileRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/BulkCreateFileRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/BulkCreateFileRequest'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CreateFileResponseListAPIResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CreateFileResponseListAPIResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CreateFileResponseListAPIResponse'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
            text/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
        '503':
          description: Service Temporarily Unavailable
  /api/filestore/v1/files/limits:
    get:
      tags:
      - File Store
      summary: Retrieve file size limitation information
      description: 'This endpoint provides the current configuration limits for file operations:

        - Maximum allowed payload size for standard file uploads

        - Minimum file part size required for multipart uploads


        This information is useful for client applications to properly manage file uploads,

        especially when handling large files that require multipart upload functionality.'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/FileLimitsAPIResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/FileLimitsAPIResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/FileLimitsAPIResponse'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
            text/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
        '503':
          description: Service Temporarily Unavailable
  /api/filestore/v1/files/multipart-uploads:
    delete:
      tags:
      - File Store
      summary: Abort an incomplete multipart upload process
      description: "Cancels an in-progress multipart upload operation and removes any parts \nthat have already been uploaded. Use this endpoint when you need to:\n- Cancel an upload that is no longer needed\n- Handle error conditions where the upload cannot be completed\n- Clean up resources when an upload process is interrupted\n\nAll previously uploaded parts associated with the specified uploadId will be deleted,\nand the upload ID will no longer be valid for future operations."
      requestBody:
        description: 'The request object containing:

          - FileName: The name of the file being uploaded.

          - FilePath: The path where the file was being stored.

          - UploadId: Unique identifier returned from InitiateMultipartUploadAsync'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileAbortMultipartUploadRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/FileAbortMultipartUploadRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/FileAbortMultipartUploadRequest'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
            text/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
            text/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
        '503':
          description: Service Temporarily Unavailable
    post:
      tags:
      - File Store
      summary: Initiate a multipart upload process for a large file
      description: "Starts a multipart upload by creating an upload session.\nIt returns an upload ID for use in subsequent API calls to:\n- Upload individual parts of the file (UploadPartAsync)\n- Complete the multipart upload (CompleteMultipartUploadAsync) \n- Abort the multipart upload if needed (AbortMultipartUploadAsync)\n\nThe multipart upload process allows to upload large files in smaller chunks,\nproviding better reliability for large file transfers and the ability to pause/resume uploads."
      requestBody:
        description: 'The request object containing:

          - FileName: The name of the file to be uploaded.

          - FilePath: The path where the file will be stored.

          - FileTags: Optional metadata associated with the file

          - FileExpirationRequest: Optional configuration for file expiration'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileInitiateMultipartUploadRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/FileInitiateMultipartUploadRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/FileInitiateMultipartUploadRequest'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/FileInitiateMultipartUploadResponseAPIResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/FileInitiateMultipartUploadResponseAPIResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/FileInitiateMultipartUploadResponseAPIResponse'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
            text/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
        '503':
          description: Service Temporarily Unavailable
    put:
      tags:
      - File Store
      summary: Upload a single part of a large file in a multipart upload process
      description: 'Uploads a single part of a large file in a multipart upload session and returns the ETag and part number.

        This endpoint is used as part of the multipart upload workflow:

        1. First, initialize a multipart upload using InitiateMultipartUploadAsync

        2. Upload individual parts using this endpoint

        3. Complete the upload using CompleteMultipartUploadAsync


        The part number must be between 1 and 10,000, and parts must be uploaded sequentially.

        The same part number can be reused to replace a previously uploaded part.'
      parameters:
      - name: PartNumber
        in: query
        schema:
          type: integer
          format: int32
      - name: UploadId
        in: query
        schema:
          type: string
      - name: FileName
        in: query
        schema:
          type: string
      - name: FilePath
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/FileUploadPartResponseAPIResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/FileUploadPartResponseAPIResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/FileUploadPartResponseAPIResponse'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
            text/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
        '503':
          description: Service Temporarily Unavailable
  /api/filestore/v1/files/multipart-uploads/complete:
    post:
      tags:
      - File Store
      summary: Complete a multipart upload process by combining all uploaded parts into the final file
      description: "This endpoint is the final step in the multipart upload workflow:\n1. Start with InitiateMultipartUploadAsync to get an uploadId\n2. Upload individual parts with UploadPartAsync\n3. Complete the process with this endpoint\n\nThe request requires the uploadId from the initial request and a dictionary of part numbers \nmapped to their ETags (received when each part is uploaded). This allows the system to\nverify all parts and combine them in the correct order.\n\nIf successful, the file will be available at the specified file path."
      requestBody:
        description: 'Request containing:

          - FileName: The name of the file being uploaded.

          - FilePath: The path where the completed file will be stored.

          - UploadId: Identifier from the InitiateMultipartUploadAsync call

          - ETags: Dictionary mapping part numbers to their ETags

          - FileSharedURIRequest: Optional settings to generate a shared access URI for the completed file'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileCompleteMultipartUploadRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/FileCompleteMultipartUploadRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/FileCompleteMultipartUploadRequest'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
            text/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
            text/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
        '503':
          description: Service Temporarily Unavailable
  /api/filestore/v1/files/shareduri:
    post:
      tags:
      - File Store
      summary: Provide time-based public access to a file
      description: 'Generates a temporary URL that provides public access to a file for a limited time.

        The URL will be valid for the duration specified in the request''s TTLSeconds parameter.'
      requestBody:
        description: 'The request object containing:

          - FileName: The name of the file for which the temporary URL is generated.

          - FilePath: The path where the file is stored.

          - TTLSeconds: The duration (in seconds) for which the access URL remains valid.

          - Protocol: The protocol to use (HTTP or HTTPS).'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FileCreateSharedURIRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/FileCreateSharedURIRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/FileCreateSharedURIRequest'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/FileSharedURIResponseAPIResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/FileSharedURIResponseAPIResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/FileSharedURIResponseAPIResponse'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
            text/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
        '503':
          description: Service Temporarily Unavailable
  /api/filestore/v1/files/{filePath}/download:
    get:
      tags:
      - File Store
      summary: Download multiple files as a ZIP archive
      description: 'Retrieves multiple files based on their names and file path, packages them into a ZIP archive, and returns the file for download.

        If any requested files are not found, appropriate error details are returned.'
      parameters:
      - name: filePath
        in: path
        description: The path where the file is stored (e.g. CLM, cpq-cart-{path}, cpq/cart/{path}).
        required: true
        schema:
          type: string
      - name: fileNames
        in: query
        description: The list of file names to be zipped and downloaded.
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: Zip Archive of the downloaded files
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
            text/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
            text/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
        '503':
          description: Service Temporarily Unavailable
  /api/filestore/v1/files/{filePath}/filenames/list:
    get:
      tags:
      - File Store
      summary: Get list of file names
      description: 'Returns a paginated list of files available at the specified path in the file store.

        It supports:

        - Pagination through continuation tokens for efficient retrieval of large file sets

        - Optional retrieval of file metadata tags

        - Configurable limits on the number of file names returned per request


        The response includes file names and optionally their associated metadata tags.

        For large directories, use the continuation token from the response to retrieve subsequent pages of results.'
      parameters:
      - name: filePath
        in: path
        description: The path where the file is stored (e.g. CLM, cpq-cart-{path}, cpq/cart/{path}).
        required: true
        schema:
          type: string
      - name: maxFiles
        in: query
        description: 'Maximum number of file names to be retrieved in a single request. For example: 10.'
        schema:
          type: integer
          format: int32
      - name: includeFileTags
        in: query
        description: Select true to include metadata tags for each file in the response
        schema:
          type: boolean
      - name: continuationToken
        in: query
        description: Optional token used to retrieve the next set of results when paginating.
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/GetFileNamesResponseAPIResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/GetFileNamesResponseAPIResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/GetFileNamesResponseAPIResponse'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
            application/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
            text/json:
              schema:
                $ref: '#/components/schemas/StringAPIResponse'
              example:
                Success: false
                Errors:
                - Message: Internal server error occurred. Please contact admin.
                StatusCode: OK
        '503':
          description: Service Temporarily Unavailable
  /api/filestore/v1/files/{filePath}/{fileName}/download:
    get:
      tags:
      - File Store
      summary: Download a file using the specified file path and file name
      description: 'Retrieves a file from the file store and returns it as a downloadable response.

        It handles the following:

        - URL decoding of the file path to support special characters

        - Determining the appropriate content type based on file extension

        - Setting response headers including content length and modified date

        - Adding file path information for client reference


        If the requested file is not found, it returns a 404 Not Found response.'
      parameters:
      - name: fileName
        in: path
        description: The name of the file to be downloaded, with or without extension.
        required: true
        schema:
          type: string
      - name: filePath
        in: path
        description: The path where the fi

# --- truncated at 32 KB (108 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/openapi/conga-file-store-api-openapi.yml