Autodesk Upload Workflow API

Operations for uploading an object directly to S3 using signed URLs.

GitHub OpenAPI

Operations 2

GET /oss/v2/buckets/{bucketKey}/objects/{objectKey}/signeds3upload Generate Signed S3 Upload URL #
POST /oss/v2/buckets/{bucketKey}/objects/{objectKey}/signeds3upload Complete Upload to S3 Signed URL #

Documentation

📖
Documentation
https://aps.autodesk.com/en/docs/acc/v1/overview/field-guide/issues/
📖
Documentation
https://aps.autodesk.com/developer/overview/autodesk-construction-cloud
📖
Documentation
https://aps.autodesk.com/developer/overview/authentication-api
📖
APIReference
https://aps.autodesk.com/en/docs/oauth/v2/reference/http
📖
GettingStarted
https://aps.autodesk.com/en/docs/oauth/v2/tutorials
📖
Documentation
https://aps.autodesk.com/developer/overview/data-management-api
📖
GettingStarted
https://aps.autodesk.com/en/docs/data/v2/tutorials/
📖
Documentation
https://aps.autodesk.com/developer/overview/model-derivative-api
📖
APIReference
https://aps.autodesk.com/en/docs/model-derivative/v2/reference/
📖
GettingStarted
https://aps.autodesk.com/en/docs/model-derivative/v2/tutorials/
📖
Documentation
https://aps.autodesk.com/developer/overview/automation-api
📖
Documentation
https://aps.autodesk.com/webhooks-api
📖
APIReference
https://aps.autodesk.com/en/docs/webhooks/v1/reference/
📖
GettingStarted
https://aps.autodesk.com/en/docs/webhooks/v1/tutorials/
📖
Documentation
https://aps.autodesk.com/developer/overview/reality-capture-api
📖
GettingStarted
https://aps.autodesk.com/en/docs/reality-capture/v1/tutorials/create-3d-mesh-from-photos/
📖
Documentation
https://aps.autodesk.com/developer/overview/sustainability-data-api
📖
APIReference
https://aps.autodesk.com/en/docs/sustainability/v3/reference/http/
📖
GettingStarted
https://aps.autodesk.com/en/docs/sustainability/v3/tutorials/tutorial_01/
📖
Documentation
https://aps.autodesk.com/developer/overview/parameters-api
📖
GettingStarted
https://aps.autodesk.com/en/docs/parameters/v1/tutorials/getting-started/
📖
Documentation
https://aps.autodesk.com/developer/overview/tandem-data-api
📖
Documentation
https://aps.autodesk.com/developer/overview/flow-graph-engine-api
📖
APIReference
https://aps.autodesk.com/en/docs/flow_graph_engine/v1/reference/quick_reference/
📖
GettingStarted
https://aps.autodesk.com/en/docs/acc/v1/tutorials/admin
📖
APIReference
https://aps.autodesk.com/en/docs/acc/v1/reference
📖
Documentation
https://aps.autodesk.com/developer/overview/bim-360-api
📖
APIReference
https://aps.autodesk.com/en/docs/bim360/v1/reference/
📖
Documentation
https://aps.autodesk.com/en/docs/oauth/v2/reference/http
📖
Documentation
https://aps.autodesk.com/en/docs/data/v2/tutorials/
📖
Documentation
https://aps.autodesk.com/en/docs/acc/v1/tutorials/admin
📖
Documentation
https://aps.autodesk.com/en/docs/model-derivative/v2/reference/
📖
Documentation
https://github.com/autodesk-platform-services/aps-sdk-openapi/tree/main/secureserviceaccount
📖
Documentation
https://aps.autodesk.com/en/docs/webhooks/v1/reference/

Specifications

SDKs

Schemas & Data

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/autodesk:autodesk-upload-workflow-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

autodesk-upload-workflow-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: oss Upload Workflow API
  version: '1.0'
  description: The Object Storage Service (OSS) allows your application to download and upload raw files (such as PDF, XLS, DWG, or RVT) that are managed by the Data service.
  contact:
    name: Autodesk Platform Services
    url: https://aps.autodesk.com/
    email: aps.help@autodesk.com
  termsOfService: https://www.autodesk.com/company/legal-notices-trademarks/terms-of-service-autodesk360-web-services/forge-platform-web-services-api-terms-of-service
  x-support: https://stackoverflow.com/questions/tagged/autodesk-data-management
servers:
- url: https://developer.api.autodesk.com
tags:
- name: Upload Workflow
  description: Operations for uploading an object directly to S3 using signed URLs.
paths:
  /oss/v2/buckets/{bucketKey}/objects/{objectKey}/signeds3upload:
    parameters:
    - $ref: '#/components/parameters/bucketKey'
    - $ref: '#/components/parameters/objectKey'
    get:
      tags:
      - Upload Workflow
      summary: Generate Signed S3 Upload URL
      description: 'Generates a signed URL to upload an object directly to S3, bypassing OSS servers. This signed URL expires in 2 minutes by default, but you can change this duration if needed. You must start the upload before the signed URL expires. The upload itself can take longer.


        Additionally:


        - Chunked uploads: You can request an array of signed URLs to upload an object in chunks for better performance.

        - Upload completion: After uploading all chunks, you must call the Complete Upload to S3 Signed URL operation to assemble the chunks and reconstitute the object on OSS. This is required even when using a single signed URL.

        - Failed uploads: If an upload fails after the signed URL expires, you can call this operation again using the same ``uploadKey`` that was originally returned.


        OSS offers two types of signed URLs:


        - S3 Signed URLs (the type generated by this operation): Enable direct S3 upload/download but are restricted to bucket owners only.

        - OSS Signed URLs: Also support upload/download operations and can be configured for access by other applications, making them ideal for sharing objects across different systems.


        **Important:** Only applications that own the bucket can call this operation.'
      operationId: signedS3Upload
      parameters:
      - name: parts
        in: query
        description: "The number of parts you intend to chunk the object for uploading. OSS will return that many signed URLs, one URL for each chunk. If you do not specify a value you'll get only one URL to upload the entire object.             \n"
        schema:
          type: integer
      - name: firstPart
        in: query
        description: The index of the first chunk to be uploaded.
        schema:
          type: integer
      - name: uploadKey
        in: query
        description: The ``uploadKey`` of a previously-initiated upload, in order to request more chunk upload URLs for the same upload. If you do not specify a value, OSS will initiate a new upload entirely.
        schema:
          type: string
      - name: minutesExpiration
        in: query
        description: 'The time window (in minutes) the signed URL will remain usable. Acceptable values = 1-60 minutes. Default = 2 minutes.


          **Tip:** Use the smallest possible time window to minimize exposure of the signed URL.

          '
        schema:
          type: integer
          minimum: 1
          maximum: 60
      - name: useAcceleration
        in: query
        description: 'Determines whether the generated signed upload URL should use S3 Transfer Acceleration. Possible values:


          - ``true`` : (Default) Generates a faster S3 signed URL using Transfer Acceleration.

          - ``false`` : Generates a standard S3 signed URL.

          '
        schema:
          type: boolean
      responses:
        '200':
          description: The signed S3 upload URLs were successfully generated.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/SignedS3Upload'
            application/json:
              examples:
                multipart:
                  summary: Requests an array of signed URLs with which to upload an object in multiple parts. (200).
                  value:
                    uploadKey: '{UPLOAD_KEY}'
                    uploadExpiration: '2022-01-25T00:00:00Z'
                    urlExpiration: '2022-01-23T21:48:42Z'
                    urls:
                    - https://com-autodesk-oss-direct-upload.s3-accelerate.amazonaws.com/signed-url-uploads/647eac4c-538a-430f-aeb9-f9868c812f0a?uploadId=DMgAHXjzyxNyetLEdTxBOGmtAglxYcvCiSdzJGeXlxrELy6LV1u5sV1vJMomNA1ajJLU_Si7MYFsZ2mAvQbrgBl32AKD1ZQ25dgZl0DJsMbEqfC_AciKZWGryKcW.WwzlUXJrbqLSzzqAolhoGDm0A--&partNumber=1&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEPz%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJIMEYCIQD5Kzy1P6NLaYATv93vjMe4xlBvvYXZQCNjWMmASGM%2FKgIhAPQVE0Qjg4muudsXUCgp%2BMcR%2F6Xu8WSPDgEpsDN34m0EKoMECPX%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEQABoMOTkzNzg5OTkyMDYzIgz7JvvTxzNi3xf3K8Aq1wOKZgmdUjLUXjBwryTukT8udQWjmR7nTXydT09euWNE7Sh%2FVztSQhXDXpBXp%2B9%2Ffpyw7CyZJOoJJgqH0DfgqIglXTP%2FUnT7cG89AIryNVDa3Tndtb1P1IlLjf0T%2BWMCXw0U%2BryS5%2BMngDrw5O82e2qeAWPcCJjo0X1SWg%2FzWac44I6vqH02U0dZoQQ%2Bu3n9yiI4DtWMj60wjgt%2FgjGmSY5jD2mILpvOSJpHvtai6%2BMCbQOstEEc6OaY1LeOBlf3Pf8SEfrpHGsHw%2BhJQ5RlpEcudX2ZO8LdZjk44%2FH6INdISZJr4N8gKKBG5%2FiXmOI4qzwcydNgfYJ3lN7yt7YRntBPnJ2N3EmKOPMot%2B0OCk7DFS%2F0f2JbcJCEB%2Bmg2tWG5KqV9tu968SR%2FkC4l2LAyo4ZVRLhQTOWgSYbfhYTL1F%2BIGGWE%2Fi%2BzGYSXKthrVYpC4h7eSeFK%2B3FUQSb6lJ0yScRP%2B%2FRmy6W%2FynJC8F%2BFkYLT%2FJaFE8tKgTUdphHtat0zppFp5UzrOQePc1abSg2uMpKkjvUSt%2FrvJ3WuN7UBj2LQ1ruUV6nx7rS7fSOUazOXmP5ToY5SXbAEx5Dvc9hEyBkxct9ZhbaF5mJE4yQbfn20xaMw73%2Bzvsw0b%2FshwY6pAH8uiCdcXXWNsEYc2g0T7H6fuCFE19VflTSlmBVnGLRTho0y4kCX6k4VIn6xV2dbuTAZzB8U%2Fdms%2FkgIM29DXNdJuJgskulKDnMjK7rRQUe44MUQoxx2P20M8pX0Oq5epgKRGtqxi6%2F8XFh5mJRVhamJwu59WmvLdSvGVsbGJk3oYtTmyEJn4N0or2QWbZdFtfrBGhLlm%2FuTislKvcut0uDWixBfA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20210723T214743Z&X-Amz-SignedHeaders=host&X-Amz-Expires=120&X-Amz-Credential=[AMZ CREDENTIAL]&X-Amz-Signature=269cde4288e380ce720b2a8a039b5e311cb9d4276ccf5e59582b32676a8f378b
                    - https://com-autodesk-oss-direct-upload.s3-accelerate.amazonaws.com/signed-url-uploads/647eac4c-538a-430f-aeb9-f9868c812f0a?uploadId=DMgAHXjzyxNyetLEdTxBOGmtAglxYcvCiSdzJGeXlxrELy6LV1u5sV1vJMomNA1ajJLU_Si7MYFsZ2mAvQbrgBl32AKD1ZQ25dgZl0DJsMbEqfC_AciKZWGryKcW.WwzlUXJrbqLSzzqAolhoGDm0A--&partNumber=2&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEPz%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJIMEYCIQD5Kzy1P6NLaYATv93vjMe4xlBvvYXZQCNjWMmASGM%2FKgIhAPQVE0Qjg4muudsXUCgp%2BMcR%2F6Xu8WSPDgEpsDN34m0EKoMECPX%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEQABoMOTkzNzg5OTkyMDYzIgz7JvvTxzNi3xf3K8Aq1wOKZgmdUjLUXjBwryTukT8udQWjmR7nTXydT09euWNE7Sh%2FVztSQhXDXpBXp%2B9%2Ffpyw7CyZJOoJJgqH0DfgqIglXTP%2FUnT7cG89AIryNVDa3Tndtb1P1IlLjf0T%2BWMCXw0U%2BryS5%2BMngDrw5O82e2qeAWPcCJjo0X1SWg%2FzWac44I6vqH02U0dZoQQ%2Bu3n9yiI4DtWMj60wjgt%2FgjGmSY5jD2mILpvOSJpHvtai6%2BMCbQOstEEc6OaY1LeOBlf3Pf8SEfrpHGsHw%2BhJQ5RlpEcudX2ZO8LdZjk44%2FH6INdISZJr4N8gKKBG5%2FiXmOI4qzwcydNgfYJ3lN7yt7YRntBPnJ2N3EmKOPMot%2B0OCk7DFS%2F0f2JbcJCEB%2Bmg2tWG5KqV9tu968SR%2FkC4l2LAyo4ZVRLhQTOWgSYbfhYTL1F%2BIGGWE%2Fi%2BzGYSXKthrVYpC4h7eSeFK%2B3FUQSb6lJ0yScRP%2B%2FRmy6W%2FynJC8F%2BFkYLT%2FJaFE8tKgTUdphHtat0zppFp5UzrOQePc1abSg2uMpKkjvUSt%2FrvJ3WuN7UBj2LQ1ruUV6nx7rS7fSOUazOXmP5ToY5SXbAEx5Dvc9hEyBkxct9ZhbaF5mJE4yQbfn20xaMw73%2Bzvsw0b%2FshwY6pAH8uiCdcXXWNsEYc2g0T7H6fuCFE19VflTSlmBVnGLRTho0y4kCX6k4VIn6xV2dbuTAZzB8U%2Fdms%2FkgIM29DXNdJuJgskulKDnMjK7rRQUe44MUQoxx2P20M8pX0Oq5epgKRGtqxi6%2F8XFh5mJRVhamJwu59WmvLdSvGVsbGJk3oYtTmyEJn4N0or2QWbZdFtfrBGhLlm%2FuTislKvcut0uDWixBfA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20210723T214743Z&X-Amz-SignedHeaders=host&X-Amz-Expires=120&X-Amz-Credential=[AMZ CREDENTIAL]&X-Amz-Signature=e5e4edcf819856f4a689c8a90975a64395df7fb33d60e3ab351e39ad0fe2585c
                    - https://com-autodesk-oss-direct-upload.s3-accelerate.amazonaws.com/signed-url-uploads/647eac4c-538a-430f-aeb9-f9868c812f0a?uploadId=DMgAHXjzyxNyetLEdTxBOGmtAglxYcvCiSdzJGeXlxrELy6LV1u5sV1vJMomNA1ajJLU_Si7MYFsZ2mAvQbrgBl32AKD1ZQ25dgZl0DJsMbEqfC_AciKZWGryKcW.WwzlUXJrbqLSzzqAolhoGDm0A--&partNumber=3&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEPz%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJIMEYCIQD5Kzy1P6NLaYATv93vjMe4xlBvvYXZQCNjWMmASGM%2FKgIhAPQVE0Qjg4muudsXUCgp%2BMcR%2F6Xu8WSPDgEpsDN34m0EKoMECPX%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEQABoMOTkzNzg5OTkyMDYzIgz7JvvTxzNi3xf3K8Aq1wOKZgmdUjLUXjBwryTukT8udQWjmR7nTXydT09euWNE7Sh%2FVztSQhXDXpBXp%2B9%2Ffpyw7CyZJOoJJgqH0DfgqIglXTP%2FUnT7cG89AIryNVDa3Tndtb1P1IlLjf0T%2BWMCXw0U%2BryS5%2BMngDrw5O82e2qeAWPcCJjo0X1SWg%2FzWac44I6vqH02U0dZoQQ%2Bu3n9yiI4DtWMj60wjgt%2FgjGmSY5jD2mILpvOSJpHvtai6%2BMCbQOstEEc6OaY1LeOBlf3Pf8SEfrpHGsHw%2BhJQ5RlpEcudX2ZO8LdZjk44%2FH6INdISZJr4N8gKKBG5%2FiXmOI4qzwcydNgfYJ3lN7yt7YRntBPnJ2N3EmKOPMot%2B0OCk7DFS%2F0f2JbcJCEB%2Bmg2tWG5KqV9tu968SR%2FkC4l2LAyo4ZVRLhQTOWgSYbfhYTL1F%2BIGGWE%2Fi%2BzGYSXKthrVYpC4h7eSeFK%2B3FUQSb6lJ0yScRP%2B%2FRmy6W%2FynJC8F%2BFkYLT%2FJaFE8tKgTUdphHtat0zppFp5UzrOQePc1abSg2uMpKkjvUSt%2FrvJ3WuN7UBj2LQ1ruUV6nx7rS7fSOUazOXmP5ToY5SXbAEx5Dvc9hEyBkxct9ZhbaF5mJE4yQbfn20xaMw73%2Bzvsw0b%2FshwY6pAH8uiCdcXXWNsEYc2g0T7H6fuCFE19VflTSlmBVnGLRTho0y4kCX6k4VIn6xV2dbuTAZzB8U%2Fdms%2FkgIM29DXNdJuJgskulKDnMjK7rRQUe44MUQoxx2P20M8pX0Oq5epgKRGtqxi6%2F8XFh5mJRVhamJwu59WmvLdSvGVsbGJk3oYtTmyEJn4N0or2QWbZdFtfrBGhLlm%2FuTislKvcut0uDWixBfA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20210723T214743Z&X-Amz-SignedHeaders=host&X-Amz-Expires=120&X-Amz-Credential=[AMZ CREDENTIAL]&X-Amz-Signature=e54df1482da076b43b32b7da891fbaa3bf66a458e367739173c74442345e35a1
              schema:
                $ref: '#/components/schemas/SignedS3Upload'
        '400':
          $ref: '#/components/responses/BAD_REQUEST'
        '401':
          $ref: '#/components/responses/UNAUTHORIZED'
        '403':
          $ref: '#/components/responses/FORBIDDEN'
        '404':
          description: The specified bucket does not exist.
          content: {}
        '500':
          $ref: '#/components/responses/INTERNAL_SERVER_ERROR'
      security:
      - 2-legged:
        - data:write
        - data:create
      x-codeSamples:
      - lang: cURL
        source: 'curl -v "https://developer.api.autodesk.com/oss/v2/buckets/apptestbucket/objects/objectKeyFoo/signeds3upload?parts=3" -X GET -H "Authorization: Bearer eYeL5gYxAT2j3u9TEerxoJoToNbi" -H "Content-Type: application/json"'
    post:
      tags:
      - Upload Workflow
      summary: Complete Upload to S3 Signed URL
      description: Completes the upload to the S3 signed URL by assembling and reconstituting the object from uploaded chunks. You must call this operation only after all parts/chunks of the object have been uploaded. This operation must be performed even if only 1 chunk was uploaded.
      operationId: completeSignedS3Upload
      parameters:
      - name: Content-Type
        in: header
        description: Must be ``application/json``.
        required: true
        schema:
          type: string
      - name: x-ads-meta-Content-Type
        in: header
        description: The Content-Type value for the uploaded object to record within OSS.
        schema:
          type: string
      - name: x-ads-meta-Content-Disposition
        in: header
        description: The Content-Disposition value for the uploaded object to record within OSS.
        schema:
          type: string
      - name: x-ads-meta-Content-Encoding
        in: header
        description: The Content-Encoding value for the uploaded object to record within OSS.
        schema:
          type: string
      - name: x-ads-meta-Cache-Control
        in: header
        description: The Cache-Control value for the uploaded object to record within OSS.
        schema:
          type: string
      - name: x-ads-user-defined-metadata
        in: header
        description: Custom metadata to be stored with the object, which can be retrieved later on download or when retrieving object details. Must be a JSON object that is less than 100 bytes.
        schema:
          type: string
      requestBody:
        content:
          application/json:
            examples:
              success:
                summary: Request to complete the object creation process after the bytes have been uploaded directly to S3. (200).
                value:
                  uploadKey: '{UPLOAD_KEY_PROVIDED_FROM_GET_UPLOAD_URLS_RESPONSE}'
              validation-failure:
                summary: Request to complete the object creation process after the bytes have been uploaded directly to S3 with Size and ETag validation (200).
                value:
                  uploadKey: '{UPLOAD_KEY_PROVIDED_FROM_GET_UPLOAD_URLS_RESPONSE}'
                  size: 1
                  eTags:
                  - c4ca4238a0b923820dcc509a6f75849b
                  - 68ed4d53c0c933b7bf7debbd640386b1
                  - 12ee9a859b60e71df4ef727f41c6b6d8
            schema:
              $ref: '#/components/schemas/CompleteS3UploadPayload'
        required: true
      responses:
        '200':
          description: The upload operation completed. The response body depends on whether the request includes the ``size`` and/or ``eTags`` properties. If these properties are omitted, the response contains the completed object's details. If either property is specified, the response contains the results of validating the uploaded object.
          content:
            application/json:
              examples:
                success:
                  summary: Request to complete the object creation process after the bytes have been uploaded directly to S3. (200).
                  value:
                    bucketKey: apptestbucket
                    objectId: urn:adsk.objects:os.object:apptestbucket/random_file.bin
                    objectKey: random_file.bin
                    size: 12582912
                    contentType: application/octet-stream
                    location: https://developer.api.autodesk.com/oss/v2/buckets/apptestbucket/objects/random_file.bin
                validation-failure:
                  summary: Request to complete the object creation process after the bytes have been uploaded directly to S3 with Size and ETag validation (200).
                  value:
                    uploadKey: '{UPLOAD_KEY}'
                    status: error
                    reason: MissingOrInvalidParts
                    size:
                      expected: 1
                      detected: 12582912
                    parts:
                    - part: 1
                      size: 5242880
                      eTag: 9aec28c3d07e2978e6502f6427c515da
                      status: Unexpected
                    - part: 2
                      size: 5242880
                      eTag: 68ed4d53c0c933b7bf7debbd640386b1
                      status: Ok
                    - part: 3
                      size: 2097152
                      eTag: 12ee9a859b60e71df4ef727f41c6b6d8
                      status: Ok
              schema:
                $ref: '#/components/schemas/CompleteS3Upload'
        '400':
          $ref: '#/components/responses/BAD_REQUEST'
        '401':
          $ref: '#/components/responses/UNAUTHORIZED'
        '403':
          $ref: '#/components/responses/FORBIDDEN'
        '404':
          description: The specified object or bucket does not exist.
          content: {}
        '500':
          $ref: '#/components/responses/INTERNAL_SERVER_ERROR'
      security:
      - 2-legged:
        - data:write
        - data:create
      x-codeSamples:
      - lang: cURL
        source: 'curl -v "https://developer.api.autodesk.com/oss/v2/buckets/apptestbucket/objects/random_file.bin/signeds3upload" -X POST -H "Authorization: Bearer eYeL5gYxAT2j3u9TEerxoJoToNbi" -H "Content-Type: application/json" -H "x-ads-meta-Content-Type: application/octet-stream" --data-raw ''{"uploadKey":"{UPLOAD_KEY_PROVIDED_FROM_GET_UPLOAD_URLS_RESPONSE}"}'''
components:
  schemas:
    CompleteS3Upload:
      description: 'The response payload for a Complete Upload to S3 Signed URL operation.


        **Note:** The documentation labels this ``oneOf``, but its two variants overlap — a plain

        success payload validates against both — so ``anyOf`` is used here.

        '
      anyOf:
      - $ref: '#/components/schemas/CompleteS3UploadSuccess'
      - $ref: '#/components/schemas/CompleteS3UploadValidation'
    CompleteS3UploadPayload:
      required:
      - uploadKey
      type: object
      description: The request payload for a Complete Upload to S3 Signed URL operation.
      properties:
        uploadKey:
          type: string
          description: The ID uniquely identifying the upload session that was returned when you called [Get S3 Signed Upload URL](/en/docs/data/v2/reference/http/oss/buckets-:bucketKey-objects-:objectKey-signeds3upload-GET/).
        size:
          type: integer
          description: The expected size of the object, in bytes. If specified, OSS compares this value against the actual size of the object in S3.
          format: int64
        eTags:
          type: array
          description: An array of eTags. S3 returns an eTag to each upload request, be it for a chunk or an entire file. For a single-part upload, this array contains the expected eTag of the entire object. For a multipart upload, this array contains the expected eTag of each part of the upload; the index of an eTag in the array corresponds to its part number in the upload. If specified, OSS validates these eTags against the content in S3.
          items:
            type: string
    Status:
      title: Status
      x-stoplight:
        id: cuyfz4812l1b2
      type: string
      description: "Indicates whether this particular part uploaded to S3 is valid. Possible values are:\n\n- ``Pending`` - No such part was uploaded to S3 for this index. \n- ``Unexpected`` - The eTag of the part in S3 does not match the one provided in the request. \n- ``TooSmall`` - A chunk uploaded to S3 is smaller than 5MB. Only the final chunk can be smaller than 5MB. \n- ``Unexpected+TooSmall`` - The chunk is both too small and has an eTag mismatch. \n- ``Ok`` - The chunk has no issues.'\n"
      enum:
      - Pending
      - Unexpected
      - TooSmall
      - Unexpected+TooSmall
      - Ok
    CompletedObjectSize:
      description: 'The object size, in bytes. Returned as an integer when validation succeeds or when only ``eTags`` was specified in the request. Returned as the requested and detected object sizes when ``size`` was specified in the request and size validation fails.

        '
      oneOf:
      - type: integer
        format: int64
        description: The total amount of storage space occupied by the object, in bytes. Returned when validation succeeds or when only ``eTags`` was specified in the request.
      - type: object
        description: Contains the object size specified in the request compared with the size detected in S3. Returned when validation fails.
        properties:
          expected:
            type: integer
            format: int64
            description: The object size specified in the request, in bytes.
          detected:
            type: integer
            format: int64
            description: The object size detected in S3, in bytes.
    CompleteS3UploadSuccess:
      type: object
      description: The response body returned when the request does not include ``size`` or ``eTags``.
      properties:
        bucketKey:
          type: string
          description: The bucket key of the bucket the object was uploaded to.
        objectId:
          type: string
          description: An identifier (URN) that uniquely and persistently identifies the object.
        objectKey:
          type: string
          description: A URL-encoded human-friendly name that identifies the object.
        size:
          type: integer
          format: int64
          description: The total amount of storage space occupied by the object, in bytes.
        contentType:
          type: string
          description: The format of the data stored within the object, expressed as a MIME type.
        location:
          type: string
          description: A URL that points to the actual location of the object.
    SignedS3Upload:
      required:
      - uploadKey
      - urls
      type: object
      description: The response payload to a Generate Signed S3 Upload URL operation.
      properties:
        uploadKey:
          type: string
          description: "An ID that uniquely identifies the upload session. It allows OSS to differentiate between fresh upload attempts from attempts to resume uploading data for an active upload session, in case of network interruptions. You must provide this value when:\n\n- Re-requesting chunk URLs for an active upload session. \n- When calling the [Complete Upload to S3 Signed URL](/en/docs/data/v2/reference/http/oss/buckets-:bucketKey-objects-:objectKey-signeds3upload-POST/) operation to end an active upload session.\n"
        urls:
          type: array
          description: An array of signed URLs. For a single-part upload, this will contain only one URL. For a multipart upload, there will be one for each chunk of a multipart upload; the index of the URL in the array corresponds to the part number of the chunk.
          items:
            type: string
        urlExpiration:
          type: string
          description: The date and time, in the ISO 8601 format, indicating when the signed URLs will expire.
        uploadExpiration:
          type: string
          description: The deadline to call [Complete Upload to S3 Signed URL](/en/docs/data/v2/reference/http/oss/buckets-:bucketKey-objects-:objectKey-signeds3upload-POST/) for the object. If not completed by this time, all uploaded data for this session will be discarded.
    CompleteS3UploadValidation:
      type: object
      description: The response body returned when the request includes ``size`` and/or ``eTags`` to validate the uploaded object.
      properties:
        uploadKey:
          type: string
          description: The ID uniquely identifying the upload session that was returned when you called Get S3 Signed Upload URL.
        status:
          type: string
          description: The overall validation outcome for the upload. If this attribute is not returned, validation succeeded.
        reason:
          type: string
          description: The reason for the failure, when validation fails.
        bucketKey:
          type: string
          description: The bucket key of the bucket the object was uploaded to. Returned when validation succeeds.
        objectId:
          type: string
          description: An identifier (URN) that uniquely and persistently identifies the object. Returned when validation succeeds.
        objectKey:
          type: string
          description: A URL-encoded human-friendly name that identifies the object. Returned when validation succeeds.
        contentType:
          type: string
          description: The format of the data stored within the object, expressed as a MIME type. Returned when validation succeeds.
        location:
          type: string
          description: A URL that points to the actual location of the object. Returned when validation succeeds.
        size:
          $ref: '#/components/schemas/CompletedObjectSize'
        parts:
          type: array
          description: An array of objects where each object represents the validation status of an uploaded part.
          items:
            $ref: '#/components/schemas/CompletedPart'
    CompletedPart:
      type: object
      description: Represents the validation status of an uploaded part.
      properties:
        part:
          type: integer
          description: The part number in the multipart upload.
        status:
          $ref: '#/components/schemas/Status'
        size:
          type: integer
          format: int64
          description: The size of the part detected in S3, in bytes.
        eTag:
          type: string
          description: The eTag of the part detected in S3.
  responses:
    INTERNAL_SERVER_ERROR:
      description: An unexpected error occurred on the server, preventing it from completing your request. Please try again later. If the issue persists, contact the support team for assistance.
      content: {}
    BAD_REQUEST:
      description: OSS was unable to process the request. The syntax of the request is malformed or the request is missing a required header. Do not repeat the request without fixing the issue. The response body may indicate what is wrong with the request
      content: {}
    FORBIDDEN:
      description: The request was successfully validated but lacking the required permissions. Verify your credentials and permissions before you send this request again.
      content: {}
    UNAUTHORIZED:
      description: The supplied authorization header was not valid or the supplied token scope was not acceptable. Verify authentication and try again.
      content: {}
  parameters:
    objectKey:
      name: objectKey
      in: path
      description: The URL-encoded human friendly name of the object.
      required: true
      schema:
        type: string
    bucketKey:
      name: bucketKey
      in: path
      description: The unique ID of the bucket that contains the objects you are operating on. ``bucketKey`` must be URL-encoded.
      required: true
      schema:
        pattern: ^[-_.a-z0-9]{3,128}$
        type: string
  securitySchemes:
    oauth2_application:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: /authentication/v1/authenticate
          scopes:
            data:read: The application will be able to read the end user’s data within the Autodesk ecosystem.
            data:write: The application will be able to create, update, and delete data on behalf of the end user within the Autodesk ecosystem.
            data:create: The application will be able to create data on behalf of the end user within the Autodesk ecosystem.
            bucket:delete: The application will be able to delete an OSS bucket it will own.
            bucket:create: The application will be able to create an OSS bucket it will own.
            bucket:read: The application will be able to read the metadata and list contents for OSS buckets that it has access to.
            bucket:update: The application will be able to set permissions and entitlements for OSS buckets that it has permission to modify.
      x-authentication_context: application context required
    3-legged:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://developer.api.autodesk.com/authentication/v2/authorize
          tokenUrl: https://developer.api.autodesk.com/authentication/v2/token
          refreshUrl: https://developer.api.autodesk.com/authentication/v2/token
          scopes:
            data:read: read your data
            data:write: modify your data
            data:create: create new data
      x-authentication_context: user context required
      description: User context required.
    2-legged:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://developer.api.autodesk.com/authentication/v2/token
          scopes:
            data:read: read application accessible data
            data:write: write application accessible data
            data:create: create application accessible data
            bucket:create: create an OSS bucket the application will own
            bucket:read: read the metadata and list contents for OSS buckets the application has access to
            bucket:update: set permissions and entitlements for OSS buckets the application has permission to modify
            bucket:delete: delete an OSS bucket the application owns
            viewables:read: read viewables of application accessible data
      x-authentication_context: application context required
      description: Application context required.
x-provenance:
  method: harvested
  publisher: Autodesk
  source: https://raw.githubusercontent.com/autodesk-platform-services/aps-sdk-openapi/main/oss/oss.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)