Request

Response

    Beta APIs are subject to change. Please avoid using them in production environments.

    Sustainability Data API Errors

    The Sustainability Data API uses a structured error response format that provides detailed information about errors that occur during request processing. Errors can originate from either Autodesk services or third-party data providers.

    HTTP Status Codes

    In addition to the structured error body, endpoints may return standard HTTP status codes. The API reference documents the status codes supported by each operation. Common codes include:

    • 400 Bad Request — Invalid or malformed request parameters or body
    • 401 Unauthorized — Missing or invalid authentication credentials
    • 403 Forbidden — Valid credentials but insufficient permissions
    • 404 Not Found — The requested resource does not exist (Autodesk-side errors such as an invalid datasetId)
    • 424 Failed Dependency — The request could not be completed because a required dependency failed or does not support this operation. Inspect the response body’s origin, type, title, and detail fields. When origin is DATA_PROVIDER, NOT_FOUND usually means the operation is unsupported for this dataset (for example, check supportedDataTypes before calling); UNKNOWN usually means an unexpected failure where retry may help

    Main Error Response Structure

    The primary error response structure includes the following fields:

    origin
    string
    Specifies the source of the error: DATA_PROVIDER or ADSK
    type
    string
    Error code enum used to group errors of a specific type
    title
    string
    A short description of the error
    detail
    string
    Additional details that explain the error
    errors
    array
    Optional array of detailed error objects

    Origin Types

    • DATA_PROVIDER: The error occurred while the request was being handled by a data provider
    • ADSK: The error occurred while the request was being handled by an Autodesk service

    Error Types

    • AUTH_ERR: This Client ID does not have access to the Sustainability Data API or is not authorized to perform this operation
    • DATASET_NOT_FOUND: Requested dataset does not exist or has not been enabled for this Client ID
    • INVALID_PARAMS: Cannot process the request due to invalid parameters in the request
    • INVALID_LICENSE: Cannot process the request due to an invalid or expired Data License
    • NO_LICENSE: The dataset has been enabled for this Client ID but the Data License is missing or not provided
    • NOT_FOUND: The requested operation or resource is not supported or could not be found. When returned as 424 Failed Dependency, this typically indicates the dataset does not support the operation (check origin and supportedDataTypes)
    • UNKNOWN: Encountered an unknown error while processing the request. Use the origin field to determine whether the error came from ADSK or DATA_PROVIDER. When returned as 424 Failed Dependency with origin: DATA_PROVIDER, this typically indicates an unexpected upstream failure where retry may help

    Example - Provider Failed Dependency (424)

    When the API returns 424, inspect origin, type, title, and detail to determine the cause. The examples below show common 424 responses with origin: DATA_PROVIDER.

    Operation not supported (NOT_FOUND):

    {
      "origin": "DATA_PROVIDER",
      "type": "NOT_FOUND",
      "title": "Not Found",
      "detail": "This dataset does not support this operation"
    }
    

    Unexpected provider failure (UNKNOWN):

    {
      "origin": "DATA_PROVIDER",
      "type": "UNKNOWN",
      "title": "UNKNOWN",
      "detail": "The provider encountered an unknown error while processing the request"
    }
    

    Example - Autodesk Service Error

    {
      "origin": "ADSK",
      "type": "DATASET_NOT_FOUND",
      "title": "Dataset not found",
      "detail": "Invalid datasetId was used."
    }
    

    Example - Data Provider Error

    {
      "origin": "DATA_PROVIDER",
      "type": "INVALID_PARAMS",
      "title": "Invalid category ID",
      "detail": "The category ID '123' is invalid.",
      "errors": [
        {
          "title": "Invalid category parameter",
          "detail": "The specified category ID does not exist in the provider's dataset"
        }
      ]
    }
    
    Show More