Request

Response

    Get Generic Estimates Details
    GET

    v3/datasets/{datasetId}/generic-estimates/details/{genericEstimateId}

    Retrieves detailed information about a specific generic estimate by its Id.

    Resource Information

    Method and URI
    GET
    https://developer.api.autodesk.com/sustainability/v3/datasets/{datasetId}/generic-estimates/details/{genericEstimateId}
    Authentication Context
    User context required
    Required OAuth Scopes
    data:read
    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 (SSA) flow.

    The 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.

    adsk-sda-cache-control
    string
    The adsk-sda-cache-control header an optional header to control the caching of the response. Caching can be disabled for the request by setting the value to no-cache.
    * Required

    Request

    URI Parameters

    datasetId
    string
    Unique identifier for the dataset. Use this value as the datasetId URI parameter in API requests to access that dataset’s data.
    genericEstimateId
    string
    Unique identifier for the generic estimate. The value is specific to each data provider and may be a UUID or another type.

    Response

    HTTP Status Code Summary

    200
    OK
    Generic estimate details were successfully retrieved.
    400
    Bad Request
    The request could not be processed due to invalid or malformed data. Check the request parameters, body format, and required fields before retrying.
    401
    Unauthorized
    The supplied authorization header was invalid or the token scope was not acceptable. Verify your authentication credentials and try again.
    403
    Forbidden
    The request was valid but lacked the necessary permissions. Verify your credentials and permissions before sending the request again.
    404
    Not Found
    The requested resource could not be found on the server. Review the request and try again.
    422
    Unprocessable Entity
    The dataset does not declare the data type required by this route in supportedDataTypes. Use GET /v3/datasets to inspect supportedDataTypes for the dataset.
    424
    The request could not be completed because the data provider failed or does not support this operation. Inspect the response body’s type, title, and detail fields to determine the cause: NOT_FOUND means the operation is unsupported for this dataset; AUTH_ERROR means the provider could not authenticate the request due to invalid credentials or token; RESOURCE_NOT_FOUND means the requested resource could not be found; REQUEST_LIMIT_EXCEEDED means the data provider has reached its request limit. Please reach out to them; UNKNOWN means the provider encountered an unexpected error.

    Response

    Body Structure (200)

    Expand all
    data
    object
    Detailed generic estimate information including applicability details
    id
    string
    Unique identifier for the generic estimate
    name
    string
    Display name of the generic estimate
    categoryIds
    array: string
    Empty array if no categories are specified.
    declaredUnit
    object
    Declared unit for measurements
    qty
    number
    Quantity value for the declared unit
    unit
    enum:string
    Canonical unit code. Mass units: t is the metric tonne (exactly 1000 kg); ton is the US short ton (exactly 907.18474 kg). These are distinct and not convertible within SDA. Possible values: cm, ft, ft2, in, item, kg, kW, kWh, m, m2, m3, MJ, mm, MPa, psi, t, ton, tkm, W, year, yd3
    description
    string
    Brief description. Null if no description is provided.
    jurisdictions
    array: string
    Jurisdiction or geographic coverage. Empty array if no jurisdictions are specified.
    dataSource
    object
    Data source information. Use null when generic/industry average data. When present as an object, name is required and url is optional.
    name
    string
    Name of the data source. Required when the data source object is present.
    url
    string
    Website URL of the data source. Optional.
    language
    string
    Language code for the generic estimate content (ISO 639-1)
    source
    string
    URL to the original generic estimate resource or documentation
    cacheRefreshTimestamp
    string
    ISO UTC timestamp indicating when the data was last retrieved from the provider and cached for performance optimization. This attribute is null when the data was not cached or retrieved directly from the provider.

    Example

    Generic estimate details were successfully retrieved.

    Request

    curl -v 'https://developer.api.autodesk.com/sustainability/v3/datasets/f81d4fae-7dec-11d0-a765-00a0c91e6bf6/generic-estimates/details/ge-550e8400-e29b-41d4-a716-446655440000' \
      -H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
    

    Response

    {
      "data": {
        "id": "ge-550e8400-e29b-41d4-a716-446655440000",
        "name": "Ready-Mix Concrete, 4000 psi",
        "categoryIds": [
          "Concrete",
          "Steel"
        ],
        "declaredUnit": {
          "qty": 1,
          "unit": "m3"
        },
        "description": "Industry-average ready-mix concrete for structural use",
        "jurisdictions": [
          "US",
          "CA"
        ],
        "dataSource": {
          "name": "Acme Materials Inc.",
          "url": "https://www.example.com"
        },
        "language": "en",
        "source": "Internal LCIA"
      },
      "cacheRefreshTimestamp": "2021-06-01T00:00:00Z"
    }
    
    Show More