openapi: 3.2.0
info:
  title: Data Bridge Import Upload API
  description: Endpoints for Data Bridge.
  version: 2022-09
servers:
- url: https://{host}/databridge
  description: Intelligent Risk Platform
  variables:
    host:
      enum:
      - api-euw1.rms.com
      - api-use1.rms.com
      default: api-euw1.rms.com
      description: 'Data center that hosts the tenant instance: api-euw1.rms.com or api-use1.rms.com.'
security:
- RMS_Auth: []
tags:
- name: Import Upload
paths:
  /v1/sql-instances/{instanceName}/databases/{databaseName}/{fileExtension}/init-upload:
    post:
      tags:
      - Import Upload
      summary: Initiate multipart upload
      operationId: initiatemultipartupload
      parameters:
      - name: instanceName
        in: path
        required: true
        schema:
          type: string
      - name: databaseName
        in: path
        required: true
        schema:
          pattern: ^[_\-a-zA-Z0-9]+$
          type: string
      - name: fileExtension
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.InitUploadResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.InitUploadResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.InitUploadResponse'
  /v1/sql-instances/{instanceName}/databases/{databaseName}/{fileExtension}/upload-part/{uploadId}/{partNumber}:
    get:
      tags:
      - Import Upload
      summary: Get pre-signed URL for multipart upload
      operationId: geturiformultipartupload
      parameters:
      - name: instanceName
        in: path
        required: true
        schema:
          type: string
      - name: databaseName
        in: path
        required: true
        schema:
          type: string
      - name: fileExtension
        in: path
        required: true
        schema:
          type: string
      - name: uploadId
        in: path
        required: true
        schema:
          type: string
      - name: partNumber
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
    put:
      tags:
      - Import Upload
      summary: Upload data part by number
      operationId: uploaddatapartbynumber
      parameters:
      - name: instanceName
        in: path
        required: true
        schema:
          type: string
      - name: databaseName
        in: path
        required: true
        schema:
          type: string
      - name: fileExtension
        in: path
        required: true
        schema:
          type: string
      - name: uploadId
        in: path
        required: true
        schema:
          type: string
      - name: partNumber
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/octet-stream:
            schema:
              type: string
              format: byte
          application/json-patch+json:
            schema:
              type: string
              format: byte
          application/json:
            schema:
              type: string
              format: byte
          text/json:
            schema:
              type: string
              format: byte
          application/*+json:
            schema:
              type: string
              format: byte
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
  /v1/sql-instances/{instanceName}/databases/{databaseName}/{fileExtension}/complete-upload:
    post:
      tags:
      - Import Upload
      summary: Complete multipart upload
      operationId: completemultipartupload
      parameters:
      - name: instanceName
        in: path
        required: true
        schema:
          type: string
      - name: databaseName
        in: path
        required: true
        schema:
          type: string
      - name: fileExtension
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.CompleteUploadRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.CompleteUploadRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.CompleteUploadRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/RMS.EnterpriseIntegrationHub.Contracts.CompleteUploadRequest'
      responses:
        '200':
          description: Success
components:
  schemas:
    RMS.EnterpriseIntegrationHub.Contracts.InitUploadResponse:
      type: object
      properties:
        uploadId:
          type:
          - string
          - 'null'
      additionalProperties: false
    RMS.EnterpriseIntegrationHub.Contracts.CompleteUploadRequest:
      type: object
      properties:
        uploadId:
          type:
          - string
          - 'null'
        etags:
          type:
          - object
          - 'null'
          additionalProperties:
            type: string
      additionalProperties: false
  securitySchemes:
    RMS_Auth:
      type: apiKey
      name: Authorization
      in: header
      description: An API key is a token that enables a client application to make requests to tenant applications running on Intelligent Risk Platform.
      x-default: XXXXXXXXXX
x-readme:
  explorer-enabled: false
  samples-languages:
  - curl
  - java
  - csharp
  - node
  - python
  proxy-enabled: true
  samples-enabled: true