Request

Response

    Get Datasets Filters
    GET

    v3/datasets/filters

    Retrieves filter metadata for the datasets list endpoint.

    Resource Information

    Method and URI
    GET
    https://developer.api.autodesk.com/sustainability/v3/datasets/filters
    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

    Response

    HTTP Status Code Summary

    200
    OK
    Filter metadata for datasets list.
    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.

    Response

    Body Structure (200)

    Expand all
    resource
    enum:string
    Resource this metadata applies to. Will always be: datasets
    actions
    object
    Per-action filtering contract. Only list is supported for datasets.
    list
    object
    Partner path and filter contract for one :filter surface. The path must match the action (e.g. /{resource}/categories:filter for categories, not the list path).
    path
    string
    Partner path for this action’s :filter endpoint.
    label
    string
    Human-readable label specific to this action (list vs categories, etc.).
    filters
    array: object
    List of filters supported by this action.
    id
    string
    Filter key supported by this action.
    required
    boolean
    Whether this filter is required for this action.
    default
    one of
    Suggested default when the client omits this filter: a string, number, or boolean scalar, or a homogeneous string[] or number[] of zero or more elements. Boolean arrays are not supported.
    0
    string
    1
    number
    2
    boolean
    3
    array: string
    4
    array: number
    filters
    object
    Map of filter identifier to definition. Keys are filter ids and must match id values referenced under actions.
    *
    object
    Definition for a filter field. Keys in the parent filters map must match id values referenced under actions.
    label
    string
    Human-readable filter name.
    field
    string
    Field identifier used by the connector for filtering semantics.
    dataType
    string
    Data type of the filter value.
    operators
    array: string
    Supported operators for the filter.
    supportsMultiple
    boolean
    Whether multiple values are supported for this filter.
    valueSource
    one of
    Describes how allowable values for a filter are obtained. When type is dynamic, endpoint must be present. When type is implicit, no endpoint is used. Filter ids, operators, and value sources are declared by each provider in the discovery response. The platform does not guarantee a single universal pattern for how implicit filters expose their values.
    0
    object
    type
    enum:string
    Clients must determine valid inputs from the filter metadata or from the provider documentation. Implicit filters do not offer a dedicated endpoint to retrieve allowed values. Will always be: implicit
    1
    object
    type
    enum:string
    Allowed values may vary by dataset and are retrieved via the filter-values endpoint referenced in valueSource.endpoint. Will always be: dynamic
    endpoint
    string
    Endpoint to retrieve allowed values (partner-relative path).
    description
    string
    Human-readable description of the filter.

    Example

    Filter metadata for datasets list.

    Request

    curl -v 'https://developer.api.autodesk.com/sustainability/v3/datasets/filters' \
      -H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
    

    Response

    {
      "resource": "datasets",
      "actions": {
        "list": {
          "path": "/product-epds/categories:filter",
          "label": "Categories",
          "filters": [
            {
              "id": "jurisdictions",
              "required": false,
              "default": "US"
            }
          ]
        }
      },
      "filters": {
        "supportedDataType": {
          "label": "Supported data type",
          "field": "supportedDataTypes",
          "dataType": "string",
          "operators": [
            "IN"
          ],
          "supportsMultiple": true,
          "valueSource": {
            "type": "implicit"
          },
          "description": "Return datasets that support at least one of the given types."
        },
        "name": {
          "label": "Dataset name",
          "field": "name",
          "dataType": "string",
          "operators": [
            "EQ"
          ],
          "supportsMultiple": false,
          "valueSource": {
            "type": "implicit"
          },
          "description": "Case-insensitive substring match on dataset name."
        }
      }
    }
    
    Show More