Request

Response

    Cancel content upload requests
    POST

    v2/hubs/{hubId}/content-upload-requests:cancel

    Batch-cancel one or more Content Upload Requests in a hub. Transition: PENDING -> CANCELED.

    Authorization. Only the request’s creator may cancel it — not even a hub admin may cancel someone else’s request (enforced per id, so an unauthorized id is reported as a per-item error rather than failing the whole batch).

    Batch and actionable state. The request body carries up to 20 request ids; a single-item action simply sends one id. Only PENDING requests are actionable; acting on a request that is already DECLINED or CANCELED is reported as a per-item error rather than failing the whole batch, and an approved request has been deleted, so it is reported as “Content upload request not found”.

    Side effects. Cancelling has no side effects — no content promotion or farm processing — it only changes the request’s status; the request then becomes immutable but, unlike an approved one, remains retrievable.

    Status codes. Returns 200 when every id succeeds, 207 when some succeed and some fail, and a 4xx/5xx error when the request cannot be processed.

    Resource Information

    Method and URI
    POST
    https://api.aps.autodesk.com/content-catalog/v2/hubs/{hubId}/content-upload-requests:cancel
    Authentication Context
    user context required
    Required OAuth Scopes
    data:write
    Data Format
    JSON

    Request

    Headers

    Authorization*
    string
    Must be Bearer <token>, where <token> is a three-legged access token obtained via an Authorization Code flow or a Secure Service Account flow.

    The Secure Service Account (SSA) flow is designed for headless server-to-server operations. While it functions like a two-legged flow (no user interaction), it is classified as three-legged because it preserves user context.

    Region
    string
    Region identifier for API routing. Defaults to US if not provided.
    Content-Type*
    string
    Must be application/json
    * Required

    Request

    URI Parameters

    hubId
    string
    Unique identifier for an individual hub (UUID format, uppercase).

    Request

    Body Structure

    ids*
    array: string
    Ids of the content upload requests to cancel (max 20).
    * Required

    Response

    HTTP Status Code Summary

    200
    OK
    All content upload requests were cancelled successfully.
    207
    Multi-status - some content upload requests were cancelled and some failed.
    400
    Bad Request
    The request was malformed or every id failed. Request-level failures (malformed body, or a batch size exceeding the maximum of 20 elements) return the standard error body; when the request is well-formed but every id fails, the batch response body is returned with an empty results list and a populated errors list.
    401
    Unauthorized
    The supplied authorization header was not valid or the supplied token scope was not acceptable. Verify authentication and try again.
    403
    Forbidden
    The caller does not have access to this hub. Cancelling additionally requires the caller to be the request’s creator; a caller who is not the creator of a specific id receives a per-item error instead. Verify your credentials and permissions before you send the request again.
    404
    Not Found
    The hub was not found. Review the request and try again.
    415
    Unsupported Media Type - the Content-Type header is not application/json.
    500
    Internal Server Error
    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.

    Response

    Body Structure (200)

    Expand all
    results
    array: object
    Successfully cancelled content upload requests. Empty when every id failed.
    contentUploadRequest
    object
    A content upload request staging record. Every property is always present on a response; optional values are returned as null rather than omitted. A record exists only while the request is PENDING, DECLINED or CANCELED: approval deletes it, so an approvalStatus of APPROVED appears only in the approve endpoint’s own response and never on a get or list.
    approvalStatus
    enum:string
    Approval status of a content item or upload request. Possible values: PENDING, DECLINED, APPROVED, CANCELED
    id
    string
    Unique identifier for the content upload request (UUID format, uppercase).
    hubId
    string
    Hub identifier (UUID format, uppercase).
    fileName
    string
    Name of the file including extension.
    contentType
    enum:string
    Content file type. Values are the canonical wire names from FileType.getName() (e.g. RFA, 3DM, MP4). Used on both request and response. Possible values: ANY, RFA, DWG, SKP, PDF, ZIP, DXF, RTF, RVT, SYSTEM_TYPE, VIEW, SCHEDULE, DETAIL_GROUP, MODEL_GROUP, RTE, 3DM, 3DM_BAK, RWS, AXM, STL, OBJ, SAT, TIF, TXT, DGN, LAYOUT, GH_3D, DYF, DYN, XLS, XLSM, XLSB, XLSX, CSV, DOCX, DOC, PPTX, PPT, 3DS, MAX, MA, MB, PSD, AI, EPS, JPG, JPEG, BMP, PNG, GIF, TIFF, NWD, NWC, NWF, DWT, PCP, CTB, STB, PAT, SHX, PC3, SCR_, ADSK, ADSK_LIB, FBX, LSP, VLX, RFT, GH, GHX, IPT, IAM, BLEND, SLD_PRT, BCF_ZIP, DAE, IFC, INDD, TTF, OTF, LSB, PY, PYC, CSS, VIS_MAT, MP4, AVI, WMV, RFA_MAT, CEL, DGN_LIB, RVT_SHEET, SKM, STYLE, JSON, FILL_PATTERN, IES, RMTL, XLTX, DWS, RAR, MP3, WAV, AAC, MOV, IND, PKT
    product
    string
    Authoring product (design program), or null when not supplied. When set it is a canonical product name — “Revit” (with no year suffix) or the name of another supported design program (e.g. “AutoCAD”, “Civil 3D”). See the create request for the full list.
    collectionIds
    array: string
    Associated collection IDs. Null when none are associated.
    tagIds
    array: string
    Associated tag IDs. Null when none are associated.
    proposedRevision
    object
    Proposed revision for the upload. Similar to ContentModel.currentRevision but without a revision number, which is assigned upon approval.
    category
    string
    Content category. Required when creating an upload request - an item without one is rejected as a per-item error.
    notes
    string
    Revision notes. Null when none were supplied.
    productVersion
    string
    Authoring product version. Null when not supplied.
    metadata
    object
    Revision-type-specific metadata. The fields present depend on the content type; the properties listed here represent the current supported set.
    hasTypeCatalog
    boolean
    Whether the source file has an associated type catalog. Caller-supplied and informational only — not verified against the uploaded type catalog source file. Null when not supplied.
    materialClass
    string
    Material class. Null when not supplied.
    measurementSystem
    enum:string
    Measurement system used by a content item or revision. Possible values: IMPERIAL_DECIMAL, IMPERIAL, METRIC
    fillPatternType
    string
    Fill pattern type. Null when not supplied.
    parameterGroups
    array: object
    Extended parameters; for example, Revit parameters. Null when none are supplied.
    name
    string
    Display or logical name of the parameter group
    parameters
    array: object
    Parameters in this group
    name
    string
    Name of the parameter
    value
    string
    Raw value of the parameter (typically numeric or internal representation)
    displayValue
    string
    Display value of the parameter (formatted for UI display)
    createdAt
    datetime: ISO 8601
    Creation timestamp.
    updatedAt
    datetime: ISO 8601
    Last update timestamp.
    uploadedAt
    datetime: ISO 8601
    Upload timestamp assigned by the server when the request was created. Every request created by the same call shares one value, so a multi-file upload is identifiable as a single batch. It cannot be supplied or changed by a caller. Always present on a response; null when not set.
    createdBy
    string
    Creator identifier (Autodesk ID).
    updatedBy
    string
    Last modifier identifier (Autodesk ID).
    errors
    array: object
    Per-item failures. Empty when every id succeeded.
    index
    int
    Zero-based position of the failed id in the original request array.
    error
    string
    Error message describing why the cancellation failed.
    contentUploadRequestId
    string
    The id of the request that failed, or null when none was assigned before failure.

    Response

    Body Structure (207)

    Expand all
    results
    array: object
    Successfully cancelled content upload requests. Empty when every id failed.
    contentUploadRequest
    object
    A content upload request staging record. Every property is always present on a response; optional values are returned as null rather than omitted. A record exists only while the request is PENDING, DECLINED or CANCELED: approval deletes it, so an approvalStatus of APPROVED appears only in the approve endpoint’s own response and never on a get or list.
    approvalStatus
    enum:string
    Approval status of a content item or upload request. Possible values: PENDING, DECLINED, APPROVED, CANCELED
    id
    string
    Unique identifier for the content upload request (UUID format, uppercase).
    hubId
    string
    Hub identifier (UUID format, uppercase).
    fileName
    string
    Name of the file including extension.
    contentType
    enum:string
    Content file type. Values are the canonical wire names from FileType.getName() (e.g. RFA, 3DM, MP4). Used on both request and response. Possible values: ANY, RFA, DWG, SKP, PDF, ZIP, DXF, RTF, RVT, SYSTEM_TYPE, VIEW, SCHEDULE, DETAIL_GROUP, MODEL_GROUP, RTE, 3DM, 3DM_BAK, RWS, AXM, STL, OBJ, SAT, TIF, TXT, DGN, LAYOUT, GH_3D, DYF, DYN, XLS, XLSM, XLSB, XLSX, CSV, DOCX, DOC, PPTX, PPT, 3DS, MAX, MA, MB, PSD, AI, EPS, JPG, JPEG, BMP, PNG, GIF, TIFF, NWD, NWC, NWF, DWT, PCP, CTB, STB, PAT, SHX, PC3, SCR_, ADSK, ADSK_LIB, FBX, LSP, VLX, RFT, GH, GHX, IPT, IAM, BLEND, SLD_PRT, BCF_ZIP, DAE, IFC, INDD, TTF, OTF, LSB, PY, PYC, CSS, VIS_MAT, MP4, AVI, WMV, RFA_MAT, CEL, DGN_LIB, RVT_SHEET, SKM, STYLE, JSON, FILL_PATTERN, IES, RMTL, XLTX, DWS, RAR, MP3, WAV, AAC, MOV, IND, PKT
    product
    string
    Authoring product (design program), or null when not supplied. When set it is a canonical product name — “Revit” (with no year suffix) or the name of another supported design program (e.g. “AutoCAD”, “Civil 3D”). See the create request for the full list.
    collectionIds
    array: string
    Associated collection IDs. Null when none are associated.
    tagIds
    array: string
    Associated tag IDs. Null when none are associated.
    proposedRevision
    object
    Proposed revision for the upload. Similar to ContentModel.currentRevision but without a revision number, which is assigned upon approval.
    category
    string
    Content category. Required when creating an upload request - an item without one is rejected as a per-item error.
    notes
    string
    Revision notes. Null when none were supplied.
    productVersion
    string
    Authoring product version. Null when not supplied.
    metadata
    object
    Revision-type-specific metadata. The fields present depend on the content type; the properties listed here represent the current supported set.
    hasTypeCatalog
    boolean
    Whether the source file has an associated type catalog. Caller-supplied and informational only — not verified against the uploaded type catalog source file. Null when not supplied.
    materialClass
    string
    Material class. Null when not supplied.
    measurementSystem
    enum:string
    Measurement system used by a content item or revision. Possible values: IMPERIAL_DECIMAL, IMPERIAL, METRIC
    fillPatternType
    string
    Fill pattern type. Null when not supplied.
    parameterGroups
    array: object
    Extended parameters; for example, Revit parameters. Null when none are supplied.
    name
    string
    Display or logical name of the parameter group
    parameters
    array: object
    Parameters in this group
    name
    string
    Name of the parameter
    value
    string
    Raw value of the parameter (typically numeric or internal representation)
    displayValue
    string
    Display value of the parameter (formatted for UI display)
    createdAt
    datetime: ISO 8601
    Creation timestamp.
    updatedAt
    datetime: ISO 8601
    Last update timestamp.
    uploadedAt
    datetime: ISO 8601
    Upload timestamp assigned by the server when the request was created. Every request created by the same call shares one value, so a multi-file upload is identifiable as a single batch. It cannot be supplied or changed by a caller. Always present on a response; null when not set.
    createdBy
    string
    Creator identifier (Autodesk ID).
    updatedBy
    string
    Last modifier identifier (Autodesk ID).
    errors
    array: object
    Per-item failures. Empty when every id succeeded.
    index
    int
    Zero-based position of the failed id in the original request array.
    error
    string
    Error message describing why the cancellation failed.
    contentUploadRequestId
    string
    The id of the request that failed, or null when none was assigned before failure.

    Example

    Multi-status - some content upload requests were cancelled and some failed.

    Request

    curl -v 'https://developer.api.autodesk.com/content-catalog/v2/hubs/757FF58F-AE23-42D8-B303-BD7B53FA2B98/content-upload-requests:cancel' \
      -X 'POST' \
      -H 'Authorization: ' \
      -H 'Content-Type: application/json' \
      -d '{
            "ids": [
              "550E8400-E29B-41D4-A716-446655440001",
              "219FA6F7-3A6E-45D0-B0AE-A34B6B1114C0"
            ]
          }'
    
    Show More

    Response

    {
      "results": [
        {
          "contentUploadRequest": {
            "approvalStatus": "CANCELED",
            "id": "550E8400-E29B-41D4-A716-446655440001",
            "hubId": "3BB2AB76-42A9-4E02-8D66-B8779A0DD0CF",
            "fileName": "Wall Speaker.rfa",
            "contentType": "RFA",
            "product": "Revit",
            "collectionIds": [
              "42E7EF17-C508-4954-9B40-025CC1369ED5"
            ],
            "tagIds": [
              "972F6B4B-C45E-4E89-B16F-7DF8DB2EBF4D"
            ],
            "proposedRevision": {
              "category": "Furniture",
              "notes": "Updated design",
              "productVersion": "2025",
              "metadata": {
                "hasTypeCatalog": true,
                "materialClass": "Concrete",
                "measurementSystem": "IMPERIAL",
                "fillPatternType": "Solid",
                "parameterGroups": [
                  {
                    "name": "",
                    "parameters": [
                      {
                        "name": "",
                        "value": "",
                        "displayValue": ""
                      }
                    ]
                  }
                ]
              }
            },
            "createdAt": "2025-06-11T17:43:45.881Z",
            "updatedAt": "2025-06-11T17:43:45.881Z",
            "uploadedAt": "2025-06-11T17:43:45.881Z",
            "createdBy": "QPT2UZV6LE7H9XN6",
            "updatedBy": "QPT2UZV6LE7H9XN6"
          }
        }
      ],
      "errors": [
        {
          "index": 3,
          "error": "User does not have upload permission to one or more specified collections",
          "contentUploadRequestId": "550E8400-E29B-41D4-A716-446655440001"
        }
      ]
    }
    
    Show More