Get Industry EPDs Filter Values
GET
v3/datasets/{datasetId}/industry-epds/filters/{filterId}
Retrieves the allowed values for a single dynamic industry EPDs filter available for the specified dataset. The filterId must match a filter declared in the dataset’s industry EPDs filter discovery metadata.
Response semantics:
- 200 with non-empty `results` – one or more allowed values for the filter.
- 200 with empty `results: []` – the filter is declared but currently has no values available (for example, an empty or newly-provisioned dataset). This is a valid steady state, not an error.
- 404 – the filterId is not declared in this datatype’s filter discovery metadata, or is declared with valueSource.type: implicit (implicit filters carry their values statically in the discovery metadata or provider documentation and are not exposed through this endpoint).
The data property is modeled with oneOf so future response shapes can be added later without changing the meaning of the current shape.
Resource Information
| Method and URI | GET https://developer.api.autodesk.com/sustainability/v3/datasets/{datasetId}/industry-epds/filters/{filterId} |
| 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. |
* 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. |
| filterId string | Identifier of the filter whose allowed values should be retrieved (e.g. jurisdictions, geography, classificationSystems). Must match a filter key declared in the filter discovery metadata for the datatype. |
Response
HTTP Status Code Summary
| 200 OK | Allowed values for the requested industry EPD filter. |
| 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 one of | Filter values payload. Modeled with oneOf so future response shapes can be added later without changing the meaning of the current shape. The current variant is an object with a results array. |
| 0 object | Current shape for a filter values payload. |
| results array: object | Allowed values for the requested filter. An empty array is a valid response and means the filter is declared in this datatype’s filter discovery metadata but currently has no values available (for example, an empty or newly-provisioned dataset). It MUST NOT be used to signal that the filterId is unknown – in that case the endpoint must return 404 instead. |
| value one of | Allowed value scalar for a filter. Filter values are typed scalars (string, number, or boolean) so they can be sent back verbatim in :filter requests. |
| 0 string | |
| 1 number | |
| 2 boolean | |
| name string | Human-readable label for the value. |
| description string | Human-readable description of the value. Required, but may be null when the value has no description. |
| grouping string | Optional grouping key clients can use to cluster values in a UI (e.g. AREA, REGION). Required, but may be null when the value has no grouping. |
Example
Allowed values for the requested industry EPD filter.
Request
curl -v 'https://developer.api.autodesk.com/sustainability/v3/datasets/f81d4fae-7dec-11d0-a765-00a0c91e6bf6/industry-epds/filters/jurisdictions' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"data": {
"results": [
{
"value": "001",
"name": "World",
"description": null,
"grouping": "AREA"
}
]
}
}
Show More