Filter Industry EPDs
This task shows you how to retrieve a filtered list of industry Environmental Product Declarations (EPDs) for a dataset. Industry EPDs provide category-average (industry-wide) environmental impacts useful for benchmarking when product-specific EPDs are not available.
By the end of this task, you will know how to:
- Call the industry EPDs filtering endpoint
- Interpret returned industry EPD metadata and pagination
- Prepare for filtering (as capabilities expand)
You use the following operation for this task:
| Operation | HTTP Request |
|---|---|
| Filter Industry EPDs for Dataset | POST /v3/datasets/{datasetId}/industry-epds/list:filter |
Prerequisites
Before starting this task, ensure you have:
- The access token from Obtain an Access Token (it should start with something like
eyJhbGciOiJIUzI1NiIs...) - Completed Get the List of Supported Datasets and obtained a dataset ID
Warning
Filter support varies by dataset. Before building filter expressions, complete Get Industry EPD Filters to discover which filters are supported and which operators and values are allowed.
Step 1: Call the Industry EPDs Endpoint
Use the access token from Obtain an Access Token and a dataset ID from Get the List of Supported Datasets to call the industry EPDs endpoint. Filtering is provided via a request body object and may expand over time.
Replace <YOUR_ACCESS_TOKEN> and <DATASET_ID> with your values.
curl -v 'https://developer.api.autodesk.com/sustainability/v3/datasets/<DATASET_ID>/industry-epds/list:filter' \
-X 'POST' \
-H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"filters": {}
}'
const accessToken = "<YOUR_ACCESS_TOKEN>";
const datasetId = "<DATASET_ID>";
const url = `https://developer.api.autodesk.com/sustainability/v3/datasets/${datasetId}/industry-epds/list:filter`;
const filterCriteria = {
filters: {}
};
fetch(url, {
method: 'POST',
headers: {
'Authorization': `Bearer ${accessToken}`,
'Content-Type': 'application/json',
'Accept': 'application/json'
},
body: JSON.stringify(filterCriteria)
})
.then(response => response.json())
.then(data => {
console.log(`Found ${data.results.length} industry EPDs:`);
data.results.forEach((epd, index) => {
console.log(`\nIndustry EPD ${index + 1}:`);
console.log(` ID: ${epd.id}`);
console.log(` Name: ${epd.name}`);
console.log(` Jurisdictions: ${(epd.jurisdictions || []).join(', ')}`);
console.log(` Declared Unit: ${epd.declaredUnit?.qty} ${epd.declaredUnit?.unit}`);
console.log(` Date of Issue: ${epd.dateOfIssue || 'N/A'}`);
console.log(` Valid Until: ${epd.validUntil || 'N/A'}`);
console.log(` Version: ${epd.version || 'N/A'}`);
console.log(` Declaration URL: ${epd.declarationUrl || 'N/A'}`);
console.log(` Category IDs: ${(epd.categoryIds || []).join(', ') || 'N/A'}`);
});
if (data.pagination && data.pagination.nextUrl) {
console.log(`\nMore results available. Next page: ${data.pagination.nextUrl}`);
}
})
.catch(error => console.error('Error:', error));
import requests
access_token = "<YOUR_ACCESS_TOKEN>"
dataset_id = "<DATASET_ID>"
url = f"https://developer.api.autodesk.com/sustainability/v3/datasets/{dataset_id}/industry-epds/list:filter"
headers = {
'Authorization': f'Bearer {access_token}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
filter_data = { "filters": {} }
response = requests.post(url, headers=headers, json=filter_data)
if response.status_code == 200:
data = response.json()
print(f"Found {len(data['results'])} industry EPDs:")
for index, epd in enumerate(data['results'], 1):
print(f"\nIndustry EPD {index}:")
print(f" ID: {epd['id']}")
print(f" Name: {epd.get('name', 'N/A')}")
print(f" Jurisdictions: {', '.join(epd.get('jurisdictions', []))}")
du = epd.get('declaredUnit') or {}
if 'qty' in du and 'unit' in du:
print(f" Declared Unit: {du['qty']} {du['unit']}")
print(f" Date of Issue: {epd.get('dateOfIssue', 'N/A')}")
print(f" Valid Until: {epd.get('validUntil', 'N/A')}")
print(f" Version: {epd.get('version', 'N/A')}")
print(f" Declaration URL: {epd.get('declarationUrl', 'N/A')}")
print(f" Category IDs: {', '.join(epd.get('categoryIds', [])) or 'N/A'}")
if data.get('pagination') and data['pagination'].get('nextUrl'):
print(f"\nMore results available. Next page: {data['pagination']['nextUrl']}")
else:
print(f"Error: {response.status_code} - {response.text}")
using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
public class IndustryEpdService
{
private readonly HttpClient _httpClient;
public IndustryEpdService()
{
_httpClient = new HttpClient();
}
public async Task GetIndustryEpdsAsync(string accessToken, string datasetId)
{
string url = $"https://developer.api.autodesk.com/sustainability/v3/datasets/{datasetId}/industry-epds/list:filter";
_httpClient.DefaultRequestHeaders.Clear();
_httpClient.DefaultRequestHeaders.Add("Authorization", $"Bearer {accessToken}");
_httpClient.DefaultRequestHeaders.Add("Accept", "application/json");
var filterData = new { filters = new { } };
string jsonContent = JsonConvert.SerializeObject(filterData);
var content = new StringContent(jsonContent, Encoding.UTF8, "application/json");
try
{
HttpResponseMessage response = await _httpClient.PostAsync(url, content);
response.EnsureSuccessStatusCode();
string responseContent = await response.Content.ReadAsStringAsync();
dynamic data = JsonConvert.DeserializeObject(responseContent);
Console.WriteLine($"Found {data.results.Count} industry EPDs:");
for (int i = 0; i < data.results.Count; i++)
{
var epd = data.results[i];
Console.WriteLine($"\nIndustry EPD {i + 1}:");
Console.WriteLine($" ID: {epd.id}");
Console.WriteLine($" Name: {epd.name ?? "N/A"}");
Console.WriteLine($" Jurisdictions: {string.Join(", ", epd.jurisdictions ?? new string[]{ })}");
if (epd.declaredUnit != null)
{
Console.WriteLine($" Declared Unit: {epd.declaredUnit.qty} {epd.declaredUnit.unit}");
}
Console.WriteLine($" Date of Issue: {epd.dateOfIssue ?? "N/A"}");
Console.WriteLine($" Valid Until: {epd.validUntil ?? "N/A"}");
Console.WriteLine($" Version: {epd.version ?? "N/A"}");
Console.WriteLine($" Declaration URL: {epd.declarationUrl ?? "N/A"}");
Console.WriteLine($" Category IDs: {string.Join(", ", epd.categoryIds ?? new string[]{})}");
}
if (data.pagination?.nextUrl != null)
{
Console.WriteLine($"\nMore results available. Next page: {data.pagination.nextUrl}");
}
}
catch (Exception ex)
{
Console.WriteLine($"Error: {ex.Message}");
}
}
}
Step 2: Understanding the Response
A successful response returns an array of industry EPDs and pagination metadata.
Example Response
{
"results": [
{
"id": "9e8d99c10e2a46f581026c80233eb10a",
"name": "Wood I-Joists",
"jurisdictions": ["CA", "US"],
"dateOfIssue": "2013-07-23",
"validUntil": "2018-07-23",
"version": "1",
"declarationUrl": "https://buildingtransparency.org/ec3/industry-epds/ec3ggjej",
"declaredUnit": { "qty": 1, "unit": "m3" },
"categoryIds": ["cat-masterformat-03-30-00"]
}
],
"pagination": {
"offset": 0,
"limit": 25,
"totalResults": 150,
"nextUrl": "https://developer.api.autodesk.com/sustainability/v3/datasets/{datasetId}/industry-epds/list:filter?offset=25&limit=25"
},
"appliedFilters": {},
"ignoredFilters": {}
}
Key Response Fields:
results: Array of industry EPDsid: Unique identifier for the industry EPDname: Display name of the industry EPDjurisdictions: Regions where the EPD applies (may be empty)dateOfIssue/validUntil: Validity period (may be null)version: EPD document version (may be null)declarationUrl: Link to the EPD document (may be null)declaredUnit.qty/declaredUnit.unit: Declared unit for measurementscategoryIds: Category identifiers for the industry EPD (required field)pagination: Supports paging large result setsappliedFilters: Map of filter keys to the requested vs. applied filter values (with optional warnings when a value was dropped)appliedFilters.*.requested: The filter value the client asked for (object withopandvalue)appliedFilters.*.applied: The filter value the connector actually applied (object withopandvalue)appliedFilters.*.warnings: Optional human-readable notes about values that could not be appliedignoredFilters: Map of unrecognised filter keys to the reason they were ignoredignoredFilters.*.reason: Human-readable explanation of why the filter key was not used
Step 3: Working with Industry EPDs
Practical Uses:
- Benchmarking: Use industry-wide values when product-specific EPDs are not available.
- Early Design: Establish baseline expectations for categories before product selection.
- Regional Checks: Ensure jurisdictional applicability to your project location.
Pagination Handling:
Use pagination.nextUrl to iterate through large result sets until it is absent.
Filtering Notes:
Filtering is submitted in the request body via filters and may expand over time. For now, sending an empty object returns available results for your dataset.
Troubleshooting:
If you encounter any errors while making this request, please refer to the Error Handling section of this guide for detailed information about common error codes and their solutions.