Request

Response

    Get Product EPDs Details
    GET

    v3/datasets/{datasetId}/product-epds/details/{productEpdId}

    Retrieves detailed information about a specific product Environmental Product Declaration (EPD) by its Id.

    Resource Information

    Method and URI
    GET
    https://developer.api.autodesk.com/sustainability/v3/datasets/{datasetId}/product-epds/details/{productEpdId}
    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.
    productEpdId
    string
    Unique identifier for the product EPD. The value is specific to each data provider and may be a UUID or another type.

    Response

    HTTP Status Code Summary

    200
    OK
    Product EPD 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 product EPD information including manufacturer details and technical specifications
    id
    string
    Unique identifier for the product EPD
    name
    string
    Display name of the product EPD
    categoryIds
    array: string
    Array of category identifiers. Empty array if no categories are specified.
    description
    string
    Detailed description of the product EPD. Null if no description is provided.
    jurisdictions
    array: string
    Array of geographic regions where this EPD is applicable and valid for use. Empty array if no regions are specified.
    dateOfIssue
    string
    Date when the EPD was issued (YYYY-MM-DD). Null if no issue date.
    validUntil
    string
    Date until which the EPD is valid (YYYY-MM-DD). Null if no expiration date.
    declarationUrl
    string
    URL to the original EPD declaration document. Null if no URL is available.
    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
    manufacturer
    object
    Manufacturer information. Use null when no manufacturer information is available. When present as an object, name is required and url is optional.
    name
    string
    Name of the manufacturer. Required when the manufacturer object is present.
    url
    string
    Website URL of the manufacturer. Optional.
    version
    string
    Version of the EPD document. Null if version is not specified.
    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

    Product EPD details were successfully retrieved.

    Request

    curl -v 'https://developer.api.autodesk.com/sustainability/v3/datasets/f81d4fae-7dec-11d0-a765-00a0c91e6bf6/product-epds/details/b03dba1dca5b49acb1a5aa4daab546b4' \
      -H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
    

    Response

    {
      "data": {
        "id": "b03dba1dca5b49acb1a5aa4daab546b4",
        "name": "Standard Concrete Block",
        "categoryIds": [
          "cat-masterformat-030000"
        ],
        "description": "Lightweight aggregate concrete masonry units manufactured using expanded clay, shale, and slate.",
        "jurisdictions": [
          "US-CA"
        ],
        "dateOfIssue": "2023-01-15",
        "validUntil": "2028-01-15",
        "declarationUrl": "https://example.com/epd/b03dba1dca5b49acb1a5aa4daab546b4",
        "declaredUnit": {
          "qty": 1,
          "unit": "m3"
        },
        "manufacturer": {
          "name": "Green Building Materials Inc.",
          "url": "https://www.example.com"
        },
        "version": "1.0"
      },
      "cacheRefreshTimestamp": "2021-06-01T00:00:00Z"
    }
    
    Show More