openapi: 3.2.0
info:
  title: Bynder Step 3 API
  version: 1.0.0
  description: 'Operations tagged Step 3 across 2 of this provider''s published API definitions: bynder-asset-upload-steps-test-openapi.json, bynder-modern-stack-upload-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{your-bynder-domain}/
  variables:
    your-bynder-domain:
      default: your-bynder-domainDefaultValue
- url: https://{your-auth-url}
  variables:
    your-auth-url:
      default: DefaultParameterValue
tags:
- name: Step 3
  description: 'This endpoint finalizes the upload after all chunks have been uploaded. You need to provide the file ID and details about the file, including its name, size, and the number of chunks it was split into.

    '
paths:
  /api/v4/upload/{id}:
    parameters: []
    post:
      tags:
      - Step 3
      summary: Register uploaded chunk
      description: Register the completion of an uploaded chunk.
      operationId: Registeruploadedchunk
      parameters:
      - name: id
        in: path
        description: ''
        required: true
        style: simple
        schema:
          type: string
          examples:
          - T3.fS5.5HPhtYFtm2b_.e7wVe910tL5XQutKw1jkMqlP5cPQVyZkOZxZ9lJiGUk4FIw6M0CFZ3xogTWrm.GPI2p2CaglQcAS5aH37zT_vHJnbtkebYbheXIQc_.M_6hM
      - name: Content-Type
        in: header
        description: ''
        required: true
        style: simple
        schema:
          const: application/x-www-form-urlencoded
          type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            encoding: {}
            schema:
              type: object
              properties:
                chunkNumber:
                  type: number
                  description: required for every chunk
                  contentEncoding: double
                  examples:
                  - 5
                targetid:
                  type: string
                  description: required for every chunk
                  examples:
                  - final/00000000-0000-0000-0000000000000000/Logo.png
                filename:
                  type: string
                  description: required for every chunk
                  examples:
                  - api_uploads/00000000-0000-0000-0000000000000000/00000000-0000-0000-0000000000000000/Logo.png/p5
                s3_filename:
                  type: string
                  description: required in the final call
                  examples:
                  - api_uploads/159D8D4B-B981-49B8-BF0569FD144CB359/A29FABF0-26B8-44BF-890920E4C09E7C11/Logo.png
                chunks:
                  type: number
                  description: required in the final call
                  contentEncoding: double
                  examples:
                  - 5
                original_filename:
                  type: string
                  description: required in the final call
                  examples:
                  - Logo.png
              contentMediaType: application/x-www-form-urlencoded
        required: false
      responses:
        '202':
          description: Chunk registered successfully
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiV4UploadResponse'
        '500':
          description: Upload failed or not ready
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiV4Upload500Error1'
      deprecated: false
      security:
      - OAuth2:
        - MEDIAUPLOAD
        - MEDIAUPLOADFORAPPROVAL
      - permanentToken:
        - MEDIAUPLOAD
        - MEDIAUPLOADFORAPPROVAL
    servers:
    - url: https://{your-bynder-domain}/
      variables:
        your-bynder-domain:
          default: your-bynder-domainDefaultValue
    - url: https://{your-auth-url}
      variables:
        your-auth-url:
          default: DefaultParameterValue
  /v7/file_cmds/upload/{file_id}/finalise_api:
    post:
      summary: Finalize the upload
      description: Finalize the upload after all chunks have been uploaded.
      tags:
      - Step 3
      parameters:
      - name: file_id
        in: path
        required: true
        description: The file ID retrieved from the prepare upload step.
        schema:
          type: string
          example: 00000000-0000-0000-0000-000000000000
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                fileName:
                  type: string
                  description: Filename of the file.
                  example: image.jpeg
                fileSize:
                  type: integer
                  description: Size of the file in bytes.
                  example: 63973541
                chunksCount:
                  type: integer
                  description: Number of chunks the file was split into.
                  example: 1
      responses:
        '201':
          description: Upload finalized successfully
        '400':
          description: Bad request
    servers:
    - url: https://{your-bynder-domain}/
      variables:
        your-bynder-domain:
          default: example.com
          description: Your Bynder domain.
components:
  schemas:
    ApiV4Upload500Error1:
      title: ApiV4Upload500Error1
      type: object
      properties:
        message:
          type: string
          examples:
          - Could not complete upload
        retry:
          type: integer
          contentEncoding: int32
          examples:
          - 1
        success:
          type: boolean
          examples:
          - false
    File:
      title: File
      type: object
      properties:
        bucket:
          type: string
          examples:
          - BUCKET
        path:
          type: string
          examples:
          - final/2ba07d00-586a-4a44-b13c-c58598cfe828/IMG_1874.JPG
        type:
          type: string
          examples:
          - s3
    ApiV4UploadResponse:
      title: ApiV4UploadResponse
      type: object
      properties:
        status:
          type: string
          description: Only for chunk registration
          examples:
          - ok
        output:
          type: string
          examples:
          - final/2ba07d00-586a-4a44-b13c-c58598cfe828/
        batchId:
          type: string
          examples:
          - 00000000-0000-0000-0000000000000000
        file:
          $ref: '#/components/schemas/File'
        filename:
          type: string
          examples:
          - final/2ba07d00-586a-4a44-b13c-c58598cfe828/IMG_1874.JPG
        importId:
          type: string
          examples:
          - 000000000-0000-0000-0000000000000000
        locationType:
          type: string
          examples:
          - s3
        success:
          type: integer
          contentEncoding: int32
          examples:
          - 1
  securitySchemes:
    permanentToken:
      type: apiKey
      name: Authorization
      in: header
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://your-bynder-domainDefaultValue/v6/authentication/oauth2/token
          scopes:
            MEDIAUPLOAD: ''
            MEDIAUPLOADFORAPPROVAL: ''
        authorizationCode:
          authorizationUrl: https://DefaultParameterValue/
          tokenUrl: https://your-bynder-domainDefaultValue/v6/authentication/oauth2/token
          scopes:
            MEDIAUPLOAD: ''
            MEDIAUPLOADFORAPPROVAL: ''
x-refined-from:
- bynder-asset-upload-steps-test-openapi.json
- bynder-modern-stack-upload-openapi.json