Request

Response

    Fetch Specific Properties
    POST

    {urn}/metadata/{modelGuid}/properties:query

    Queries the objects in the Model View (Viewable) specified by the modelGuid URI parameter and returns the specified properties in a paginated list. You can limit the number of objects to be queried by specifying a filter using the query attribute in the request body.

    Note: A design file must be translated to SVF or SVF2 before you can query object properties.

    Before you call this operation:

    • Use the List Model Views operation to obtain the list of Model Views in the source design.
    • Pick the ID of the Model View you want to query and specify that ID as the value for the modelGuid URI parameter.

    Resource Information

    Method and URI
    POST
    https://developer.api.autodesk.com/modelderivative/v2/designdata/{urn}/metadata/{modelGuid}/properties:query
    Method and URI (EMEA)
    POST
    https://developer.api.autodesk.com/modelderivative/v2/regions/eu/designdata/{urn}/metadata/{modelGuid}/properties:query
    Authentication Context
    user context optional.
    Required OAuth Scopes
    data:read
    Data Format
    JSON
    Rate Limit
    300 calls per minute for requests that trigger metadata extraction. Does not apply to requests querying models whose metadata extraction is complete or in progress.

    Request

    Headers

    Authorization*
    string
    Must be Bearer <token>, where <token> is obtained by means of POST /authentication/v2/token.
    Accept-Encoding
    string
    A comma separated list of the algorithms you want the response to be encoded in, specified in the order of preference.

    If you specify gzip or *, content is compressed and returned in gzip format.

    Content-Type*
    string
    Must be application/json.
    region
    enum: string
    Specifies the data center where the manifest and derivative of the specified source design are stored in. Possible values are:
    • US : (Default) Data center for the US region.
    • EMEA : Data center for the European Union, Middle East, and Africa regions.
    • AUS : (Beta) Data centre for the Australia region.
    • CAN : Data centre for the Canada region.
    • DEU : Data centre for the Germany region.
    • IND : Data centre for the India region.
    • JPN : Data centre for the Japan region.
    • GBR : Data centre for the United Kingdom region.

    Note:

    • The Model Derivative service ignores this parameter if you use the EMEA URI for this operation.
    • Beta features are subject to change. Please avoid using them in production environments.
    x-ads-derivative-format
    enum:string
    Specifies what type of Object IDs to return, if the design has legacy SVF derivatives generated by the BIM Docs service. Possible values are:
    • latest - (Default) Return SVF2 Object IDs.
    • fallback - Return SVF Object IDs.

    Note

    1. This parameter applies only to designs with legacy SVF derivatives generated by the BIM 360 Docs service.
    2. The BIM 360 Docs service now generates SVF2 derivatives. SVF2 Object IDs may not be compatible with the SVF Object IDs previously generated by the BIM 360 Docs service. Setting this header to fallback may resolve backward compatibility issues resulting from Object IDs of legacy SVF derivatives being retained on the client side.
    3. If you use this header with one derivative (URN), you must use it consistently across the following operations for that derivative.

    * Required

    Request

    URI Parameters

    urn
    string
    The URL safe Base64 encoded URN of the source design.
    modelGuid
    string
    The ID of the Model View (Viewable) that contains the objects you want to fetch properties for.

    Request

    Body Structure

    Expand all
    pagination
    object
    Specifies how to split the response into multiple pages, and return the response one page at a time.
    limit
    int
    The maximum number of properties to return in a single page. Use this attribute with the offset attribute to split the properties into multiple pages. To fetch the first page, specify offset =0 (do not skip any properties). To fetch the second page, specify offset = value of limit you specified for the first page. So, the server skips the search results returned on the first page. In general, offset = previous_offset + previous_limit. This attribute is 20 by default. The minimum value is 1 and the maximum is 1000.
    offset
    int
    The number of properties to skip. Use this attribute with the limit attribute to split the properties into multiple pages. To fetch the first page, specify offset =0 (do not skip any properties). To fetch the second page, specify offset = value of limit you specified for the first page. So, the server skips the properties returned on the first page. In general, offset = previous_offset + previous_limit. This attribute is 0 by default. The minimum value is 0.
    query*
    object
    Contains the parameters to pass to the query backend. Specifies what objects to query.
    oneOf
    $in
    array
    Returns only the objects with their objectid or externalId attribute exactly matching one of the values specified in the array.

    The first element of the array contains the name of the attribute to match (objectid or externalId). Subsequent elements contain the values to match.

    For example, if you specify an array as: "$in":["objectid",1,2], the request will only return the properties of the objects with objectid 1 and 2. If you specify an array as "$in":["externalId","doc_982afc8a","doc_afd75233" ] the request will only return the properties of the objects with extermnalId doc_982afc8a and doc_afd75233.

    $prefix
    array, string
    Returns only the objects with their name attribute beginning with the specified string.

    The first element of the array contains the name of the attribute to match (name). The second element contains the string to match. The array can have only two elements. Only the objects whose name begin with the specified string are returned.

    $eq
    array
    Returns only the objects where the value of the specified attribute (name attribute or any numerical property) is exactly equal to the specified value.

    The first element of the array contains the name of the attribute. This can be the name attribute or the name of a numerical property. The second element of the array must be the value to match. If the first element is name, must be a string value. If the first element is a numerical property, must be a numeric. The array can only be two elements long.

    For example, if you specify an array as: "$eq":["name","Rectangular"], the request will only return the properties of the object named Rectangular. if you specify an array as: "$eq":["properties.Dimensions.Width1",0.6], the request will return the properties of all objects whose properties.Dimensions.Width1 property is exactly equal to 0.6.

    Note: We recommend that you use $between instead of $eq when testing non-integer numeric values for equality. Using between mitigates floating-point errors.

    $between
    array
    Returns only the objects where the value of the specified numerical property lies between the specified values.

    The first element of the array contains the name of the property. The next two elements specify the values that the property must lie between. The array can only be three elements long.

    For example, if you specify an array as: "$between":["properties.Dimensions.Width1",1,10], the request returns the properties of all objects whose properties.Dimensions.Width1 property is between 1 and 10.

    Note: The Model Derivative service converts numeric values from their native units to metric base units for comparison. So, you must specify the values to compare in metric base units. For example, if the property you are comparing is a length measurement, you must specify the values in m. Not in cm, mm, or ft.

    $le
    array
    Returns only the objects where the value of the specified numerical property is less than or equal to the specified value.

    The first element of the array contains the name of the property. The next element specifies the values that the property must be less than or equal to. The array can only be two elements long.

    For example, if you specify an array as: "$le":["properties.Dimensions.Width1",10], the request returns the properties of all objects whose properties.Dimensions.Width1 property is less than or equal to 10.

    Note: The Model Derivative service converts numeric values from their native units to metric base units for comparison. So, the value to compare must be specified in metric base units. For example, if the property you are comparing is a length measurement, you must specify the value in m. Not in cm, mm, or ft.

    $ge
    array
    Returns only the objects where the value of the specified numerical property is greater than or equal to the specified value.

    The first element of the array contains the name of the property. The next element specifies the values that the property must be greater than or equal to. The array can only be two elements long.

    For example, if you specify an array as: "$ge":["properties.Dimensions.Width1",0.1], the request returns the properties of all objects whose properties.Dimensions.Width1 property is greater than or equal to 0.1.

    Note: The Model Derivative service converts numeric values from their native units to metric base units for comparison. So, the value to compare must be specified in metric base units. For example, if the property you are comparing is a length measurement, you must specify the value in m. Not in cm, mm, or ft.

    $contains
    array, string
    Returns only the objects where the value of the specified property contains the words specified in a string.

    The first element of the array contains the name of the property. The second element contains a string containing the words to match. The array can only be two elements long.

    For example, if you specify an array as: "$contains":["properties.Materials and Finishes.Structural Material","Concrete Situ"], the request returns the properties of all objects whose properties.Materials and Finishes.Structural Material property contains the words Concrete and Situ. You can specify up to 50 words.

    fields
    array, string
    Specifies what properties of the objects to return. If you do not specify this attribute, the response returns all properties. Possible values:
    • properties - Return all properties.
    • properties.something- Return the property named something and all its children.
    • properties.some* - Return all properties with names that begin with some and all their children.
    • properties.category.* - Return the property named category and all its children.
    • properties.*.property - Return any property named property regardless of its parent.
    payload
    enum
    Specifies the format for numeric values in the response body. Possible values:
    • text - (Default) Returns all properties requested in fields without applying any special formatting.
    • unit - Applies a filter and returns only the properties that contain numerical values. Additionally, it formats property values as ##<VALUE_OF_PROPERTY><UNIT_OF_VALUE><PRECISION><SYSTEM_UNIT>. For example ##94.172{mm}[3]{m}, where 94.172 is the value of the property, {mm} is the unit of the value, [3] is the precision, and {m} is the metric base unit for the measurement.
    * Required

    Response

    HTTP Status Code Summary

    200
    OK
    Success.
    202
    ACCEPTED
    Request accepted but processing is not complete. Call this endpoint again, until you receive 200 OK.
    400
    BAD REQUEST
    The request is invalid, either malformed inputs or missing required headers.
    404
    NOT FOUND
    The server was not able to understand the request. This could be due to malformed syntax or a missing request header.
    429
    TOO MANY REQUESTS
    Rate limit exceeded (300 requests per minute for requests that trigger metadata extraction). Wait some time before retrying.
    500
    INTERNAL SERVICE ERROR
    Unexpected service interruption.

    Response

    HTTP Headers

    x-ads-app-identifier
    string
    The service identifier made up of service name, version, and environment.
    x-ads-startup-time
    string
    The service startup time with data format EEE MMM dd HH:mm:ss Z yyyy.
    x-ads-duration
    string
    The request duration in milliseconds.
    x-ads-troubleshooting
    string
    Provides information about the server failure.
    x-ads-size
    string
    Size in bytes of the request data. It’s also for 413 response code.

    Response

    Body Structure (200)

    Expand all
    pagination
    object
    Envelope that contains pagination information.
    Limit
    int
    The maximum number of properties you requested for this page.
    offset
    int
    The number of items skipped (because they were returned in previous pages) when returning this page.
    totalresults
    int
    The total number of properties to be returned.
    data
    object
    Envelope that contains the return data.
    type
    string
    The type of data that is returned. Always properties.
    collection
    array
    Array of objects with their “properties” as a non-hierarchical list.
    objectid
    number
    Unique identifier of the object.

    Note: The objectid is a non-persistent session specific ID assigned to the object when a design file is translated to the SVF and SVF2 format. So:

    • The objectid of an object can change if the design is translated to SVF or SVF2 again.
    • If you require a persistent ID to reference an object, use externalId.
    name
    string
    Name of the object.
    externalId
    string
    A unique identifier of the object as defined in the source design. For example, UniqueID in Revit files.
    properties
    object
    A JSON object containing dictionary objects (key value pairs), where the key is the property name and the value is the value of the property.

    Response

    Body Structure (202)

    result
    string
    Always success. Indicates that the request was accepted but processing is yet to complete.

    Example 1

    This example retrieves all properties for the objects with object IDs 4269 and 438. This example uses a Revit model translated to SVF/SVF2. Among the models you can produce with Autodesk products, Revit models contain the richest set of metadata.

    Request

    curl -X 'POST' \
         -H 'Authorization: Bearer PtnrvrtSRpWwUi3407QhgvqdUVKL...'  \
         -H 'Content-Type: application/json' \
         -v 'https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxfZGVyaXZhdGl2ZV9wcm9wX2VuaGFuY2VtZW50X3Rlc3RpbmcvcmFjX2Jhc2ljX3NhbXBsZV9wcm9qZWN0LnJ2dA/metadata/6bfb4886-f2ee-9ccb-8db0-c5c170220c40/properties:query' \
         -d'{
                  "query": {
                      "$in": [
                          "objectid",
                          4269,
                          438
                      ]
                  },
                  "fields": [
                      "objectid",
                      "name",
                      "externalId",
                      "properties.Cons*"
                  ],
                  "pagination": {
                      "offset": 0,
                      "limit": 20
                  },
                  "payload": "text"
              }'
    
    Show More

    Response

    {
        "pagination": {
            "limit": 20,
            "offset": 0,
            "totalResults": 2
        },
        "data": {
            "type": "properties",
            "collection": [
                {
                    "objectid": 438,
                    "name": "Floor [418183]",
                    "externalId": "d85573c2-f8d5-46ae-966a-ac82fa18f500-00066187",
                    "properties": {
                        "Constraints": {
                            "Level": "Level 2",
                            "Height Offset From Level": "0.000 mm",
                            "Room Bounding": "Yes",
                            "Related to Mass": "No"
                        },
                        "Construction": {
                            "Structure": "",
                            "Default Thickness": "300.000 mm",
                            "Function": "Interior"
                        }
                    }
                },
                {
                    "objectid": 4269,
                    "name": "Generic 150mm",
                    "externalId": "e3e052f9-0156-11d5-9301-0000863f27ad-00000153",
                    "properties": {
                        "Construction": {
                            "Structure": "",
                            "Default Thickness": "150.000 mm",
                            "Function": "Interior"
                        }
                    }
                }
            ]
        }
    }
    
    Show More

    Example 2

    This example is the same as Example 1, except that the payload request body attribute is set to unit.

    Request

    curl -X 'POST' \
         -H 'Authorization: Bearer PtnrvrtSRpWwUi3407QhgvqdUVKL...'  \
         -H 'Content-Type: application/json' \
         -v 'https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxfZGVyaXZhdGl2ZV9wcm9wX2VuaGFuY2VtZW50X3Rlc3RpbmcvcmFjX2Jhc2ljX3NhbXBsZV9wcm9qZWN0LnJ2dA/metadata/6bfb4886-f2ee-9ccb-8db0-c5c170220c40/properties:query' \
         -d'{
                  "query": {
                      "$in": [
                          "objectid",
                          4269,
                          438
                      ]
                  },
                  "fields": [
                      "objectid",
                      "name",
                      "externalId",
                      "properties.Cons*"
                  ],
                  "pagination": {
                      "offset": 0,
                      "limit": 20
                  },
                  "payload": "unit"
              }'
    
    Show More

    Response

    {
        "pagination": {
            "limit": 20,
            "offset": 0,
            "totalResults": 2
        },
        "data": {
            "type": "properties",
            "collection": [
                {
                    "objectid": 438,
                    "name": "Floor [418183]",
                    "externalId": "d85573c2-f8d5-46ae-966a-ac82fa18f500-00066187",
                    "properties": {
                        "Constraints": {
                            "Height Offset From Level": "##0{mm}[1]{m}"
                        },
                        "Construction": {
                            "Default Thickness": "##300{mm}[1]{m}"
                        }
                    }
                },
                {
                    "objectid": 4269,
                    "name": "Generic 150mm",
                    "externalId": "e3e052f9-0156-11d5-9301-0000863f27ad-00000153",
                    "properties": {
                        "Construction": {
                            "Default Thickness": "##150{mm}[1]{m}"
                        }
                    }
                }
            ]
        }
    }
    
    Show More

    Example 3

    This example retrieves the “Analytical Properties” only for the objects with the specified external IDs. This example uses a Revit model translated to SVF/SVF2. Among the models you can produce with Autodesk products, Revit models contain the richest set of metadata.

    Request

    curl -X 'POST' \
         -H 'Authorization: Bearer PtnrvrtSRpWwUi3407QhgvqdUVKL...'  \
         -H 'Content-Type: application/json' \
         -v 'https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxfZGVyaXZhdGl2ZV9wcm9wX2VuaGFuY2VtZW50X3Rlc3RpbmcvcmFjX2Jhc2ljX3NhbXBsZV9wcm9qZWN0LnJ2dA/metadata/6bfb4886-f2ee-9ccb-8db0-c5c170220c40/properties:query' \
         -d'{
                  "query": {
                      "$in": [
                          "externalId",
                          "e3e052f9-0156-11d5-9301-0000863f27ad-00000153",
                          "5e8712a2-e372-44b6-9e73-0aaa430558ee-0008656f"
                      ]
                  },
                  "fields": [
                      "name",
                      "externalId",
                      "properties.Analytical Properties"
                  ],
                  "pagination": {
                      "offset": 0,
                      "limit": 20
                  },
                  "payload": "text"
              }'
    
    Show More

    Response

    {
        "pagination": {
            "limit": 20,
            "offset": 0,
            "totalResults": 2
        },
        "data": {
            "type": "properties",
            "collection": [
                {
                    "name": "Floor [550255]",
                    "externalId": "5e8712a2-e372-44b6-9e73-0aaa430558ee-0008656f",
                    "properties": {
                        "Analytical Properties": {
                            "Heat Transfer Coefficient (U)": "0.000 watt / (m^2 kelvin)",
                            "Thermal Resistance (R)": "0.000 m^2 kelvin / watt",
                            "Thermal mass": "0.000 kjoule / kelvin",
                            "Absorptance": "0.100",
                            "Roughness": "1"
                        }
                    }
                },
                {
                    "name": "Generic 150mm",
                    "externalId": "e3e052f9-0156-11d5-9301-0000863f27ad-00000153",
                    "properties": {
                        "Analytical Properties": {
                            "Heat Transfer Coefficient (U)": "0.000 watt / (m^2 kelvin)",
                            "Thermal Resistance (R)": "0.000 m^2 kelvin / watt",
                            "Thermal mass": "0.000 kjoule / kelvin",
                            "Absorptance": "0.100",
                            "Roughness": "1"
                        }
                    }
                }
            ]
        }
    }
    
    Show More

    Example 4

    This example retrieves an object by its name and retrieves all properties that belong to the Construction category. Note that the string to match is in lower case, while the actual name is in title case. The case insensitive matching finds the correct object. This example uses a Revit model translated to SVF/SVF2. Among the models you can produce with Autodesk products, Revit models contain the richest set of metadata.

    Request

    curl -X 'POST' \
         -H 'Authorization: Bearer PtnrvrtSRpWwUi3407QhgvqdUVKL...'  \
         -H 'Content-Type: application/json' \
         -v 'https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxfZGVyaXZhdGl2ZV9wcm9wX2VuaGFuY2VtZW50X3Rlc3RpbmcvcmFjX2Jhc2ljX3NhbXBsZV9wcm9qZWN0LnJ2dA/metadata/6bfb4886-f2ee-9ccb-8db0-c5c170220c40/properties:query' \
         -d'{
                  "query": {
                      "$eq": [
                          "name",
                          "timber suspended floor"
                      ]
                  },
                  "fields": [
                      "objectid",
                      "name",
                      "externalId",
                      "properties.Construction.*"
                  ],
                  "pagination": {
                      "offset": 0,
                      "limit": 20
                  },
                  "payload": "text"
              }'
    
    Show More

    Response

    {
        "pagination": {
            "limit": 20,
            "offset": 0,
            "totalResults": 1
        },
        "data": {
            "type": "properties",
            "collection": [
                {
                    "objectid": 4272,
                    "name": "Timber Suspended Floor",
                    "externalId": "203cff26-4c9d-4eb4-93e5-28d28a01f256-0002d338",
                    "properties": {
                        "Construction": {
                            "Structure": "",
                            "Default Thickness": "247.000 mm",
                            "Function": "Interior"
                        }
                    }
                }
            ]
        }
    }
    
    Show More

    Example 5

    This example retrieves objects with “Floor” in its name and retrieves all properties that begin with “type”. Note the use of the wildcard * to return properties regardless of the category of the property. This example uses a Revit model translated to SVF/SVF2. Among the models you can produce with Autodesk products, Revit models contain the richest set of metadata.

    Note: In the response, objects that do not have the requested properties are indicated by {}.

    Request

    curl -X 'POST' \
         -H 'Authorization: Bearer PtnrvrtSRpWwUi3407QhgvqdUVKL...'  \
         -H 'Content-Type: application/json' \
         -v 'https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxfZGVyaXZhdGl2ZV9wcm9wX2VuaGFuY2VtZW50X3Rlc3RpbmcvcmFjX2Jhc2ljX3NhbXBsZV9wcm9qZWN0LnJ2dA/metadata/6bfb4886-f2ee-9ccb-8db0-c5c170220c40/properties:query' \
         -d'{
                  "query": {
                      "$prefix": [
                          "name",
                          "floor"
                      ]
                  },
                  "fields": [
                      "objectid",
                      "name",
                      "externalId",
                      "properties.*.type*"
                  ],
                  "pagination": {
                      "offset": 0,
                      "limit": 20
                  },
                  "payload": "text"
              }'
    
    Show More

    Response

    {
        "pagination": {
            "limit": 20,
            "offset": 0,
            "totalResults": 10
        },
        "data": {
            "type": "properties",
            "collection": [
                {
                    "objectid": 91,
                    "name": "Floors",
                    "externalId": "225f03d8-e034-4a5b-858c-a767fc7a4ff1",
                    "properties": {}
                },
                {
                    "objectid": 169,
                    "name": "Floor [176804]",
                    "externalId": "203cff26-4c9d-4eb4-93e5-28d28a01f256-0002b2a4",
                    "properties": {
                        "Identity Data": {
                            "Type Name": "Generic 150mm",
                            "Type Image": "",
                            "Type Comments": "",
                            "Type Mark": ""
                        }
                    }
                },
                {
                    "objectid": 201,
                    "name": "Floor [495352]",
                    "externalId": "17836a3c-e764-47fa-a2e0-08216444f621-00078ef8",
                    "properties": {
                        "Identity Data": {
                            "Type Name": "Concrete-Domestic 425mm",
                            "Type Image": "",
                            "Type Comments": "",
                            "Type Mark": ""
                        }
                    }
                },
                {
                    "objectid": 207,
                    "name": "Floor [647908]",
                    "externalId": "66314231-2860-4f9f-87a8-f581c5b96b2f-0009e2e4",
                    "properties": {
                        "Identity Data": {
                            "Type Name": "Insitu Concrete 225mm",
                            "Type Image": "",
                            "Type Comments": "",
                            "Type Mark": ""
                        }
                    }
                },
                {
                    "objectid": 438,
                    "name": "Floor [418183]",
                    "externalId": "d85573c2-f8d5-46ae-966a-ac82fa18f500-00066187",
                    "properties": {
                        "Identity Data": {
                            "Type Name": "Generic 300",
                            "Type Image": "",
                            "Type Comments": "",
                            "Type Mark": ""
                        }
                    }
                },
                {
                    "objectid": 487,
                    "name": "Floor [549031]",
                    "externalId": "5e8712a2-e372-44b6-9e73-0aaa430558ee-000860a7",
                    "properties": {
                        "Identity Data": {
                            "Type Name": "Generic 300",
                            "Type Image": "",
                            "Type Comments": "",
                            "Type Mark": ""
                        }
                    }
                },
                {
                    "objectid": 507,
                    "name": "Floor [764691]",
                    "externalId": "c82e0dd9-31e8-407e-a294-c30431c2fda3-000bab13",
                    "properties": {
                        "Identity Data": {
                            "Type Name": "Insitu Concrete 225mm",
                            "Type Image": "",
                            "Type Comments": "",
                            "Type Mark": ""
                        }
                    }
                },
                {
                    "objectid": 589,
                    "name": "Floor [512683]",
                    "externalId": "1970f67d-62ee-4fc6-9008-0a9f00762fe0-0007d2ab",
                    "properties": {
                        "Identity Data": {
                            "Type Name": "Timber Suspended Floor",
                            "Type Image": "",
                            "Type Comments": "",
                            "Type Mark": ""
                        }
                    }
                },
                {
                    "objectid": 590,
                    "name": "Floor [550255]",
                    "externalId": "5e8712a2-e372-44b6-9e73-0aaa430558ee-0008656f",
                    "properties": {
                        "Identity Data": {
                            "Type Name": "Generic 150mm",
                            "Type Image": "",
                            "Type Comments": "",
                            "Type Mark": ""
                        }
                    }
                },
                {
                    "objectid": 4268,
                    "name": "Floor",
                    "externalId": "8e458af7-0024-4214-80e0-31b9845333d0",
                    "properties": {}
                }
            ]
        }
    }
    
    Show More

    Example 6

    This example retrieves objects that contain the words “SH_Resin” and “Concrete” in its Material and Finishes property. Note how the request is for the second page of the response. This example uses a Revit model translated to SVF/SVF2. Among the models you can produce with Autodesk products, Revit models contain the richest set of metadata.

    Request

    curl -X 'POST' \
         -H 'Authorization: Bearer PtnrvrtSRpWwUi3407QhgvqdUVKL...'  \
         -H 'Content-Type: application/json' \
         -v 'https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxfZGVyaXZhdGl2ZV9wcm9wX2VuaGFuY2VtZW50X3Rlc3RpbmcvcmFjX2Jhc2ljX3NhbXBsZV9wcm9qZWN0LnJ2dA/metadata/6bfb4886-f2ee-9ccb-8db0-c5c170220c40/properties:query' \
         -d'{
                  "query": {
                      "$contains": [
                          "properties.Materials and Finishes.Structural Material",
                          "SH_resin Concrete"
                      ]
                  },
                  "fields": [
                      "objectid",
                      "name",
                      "externalId",
                      "properties.Materials and Finishes"
                  ],
                  "pagination": {
                      "offset": 30,
                      "limit": 30
                  },
                  "payload": "text"
              }'
    
    Show More

    Response

    {
        "pagination": {
            "limit": 30,
            "offset": 30,
            "totalResults": 37
        },
        "data": {
            "type": "properties",
            "collection": [
                {
                    "objectid": 4269,
                    "name": "Generic 150mm",
                    "externalId": "e3e052f9-0156-11d5-9301-0000863f27ad-00000153",
                    "properties": {
                        "Materials and Finishes": {
                            "Structural Material": "SH_resin Floor"
                        }
                    }
                },
                {
                    "objectid": 4270,
                    "name": "Generic 300",
                    "externalId": "9c1f7993-9536-44bd-bedc-bf731228f65b-00072966",
                    "properties": {
                        "Materials and Finishes": {
                            "Structural Material": "SH_resin Floor"
                        }
                    }
                },
                {
                    "objectid": 4271,
                    "name": "Concrete-Domestic 425mm",
                    "externalId": "7f28cee1-b998-4a37-89e2-f58405cbbc56-0008df1d",
                    "properties": {
                        "Materials and Finishes": {
                            "Structural Material": "Concrete, Cast In Situ"
                        }
                    }
                },
                {
                    "objectid": 4273,
                    "name": "Insitu Concrete 225mm",
                    "externalId": "7f28cee1-b998-4a37-89e2-f58405cbbc56-0008defb",
                    "properties": {
                        "Materials and Finishes": {
                            "Structural Material": "Concrete, Cast In Situ"
                        }
                    }
                },
                {
                    "objectid": 4299,
                    "name": "Foundation - 300mm Concrete",
                    "externalId": "7f28cee1-b998-4a37-89e2-f58405cbbc56-0008df7c",
                    "properties": {
                        "Materials and Finishes": {
                            "Structural Material": "Concrete, Cast In Situ"
                        }
                    }
                },
                {
                    "objectid": 4300,
                    "name": "Retaining - 300mm Concrete",
                    "externalId": "1551350c-45e5-41b8-bdf1-bcfa6794dc6a-000adce2",
                    "properties": {
                        "Materials and Finishes": {
                            "Structural Material": "Concrete - Cast In Situ"
                        }
                    }
                },
                {
                    "objectid": 5264,
                    "name": "150mm Foundation Slab",
                    "externalId": "5adccf95-7ef8-4f40-aa7c-dd3dcfd6d307-00015129",
                    "properties": {
                        "Materials and Finishes": {
                            "Structural Material": "Concrete, Cast In Situ"
                        }
                    }
                }
            ]
        }
    }
    
    Show More

    Example 7

    This example queries objects whose Absorptance property is greater than or equal to 0.1. Absorptance is a property that contains a numeric value, but has no units.

    This example uses a Revit model translated to SVF/SVF2. Among the models you can produce with Autodesk products, Revit models contain the richest set of metadata.

    Request

    curl -X 'POST' \
         -H 'Authorization: Bearer PtnrvrtSRpWwUi3407QhgvqdUVKL'  \
         -H 'Content-Type: application/json' \
         -v 'https://developer.api.autodesk.com/modelderivative/v2/designdata/dXJuOmFkc2sub2JqZWN0czpvcy5vYmplY3Q6bW9kZWxfZGVyaXZhdGl2ZV9wcm9wX2VuaGFuY2VtZW50X3Rlc3RpbmcvcmFjX2Jhc2ljX3NhbXBsZV9wcm9qZWN0LnJ2dA/metadata/6bfb4886-f2ee-9ccb-8db0-c5c170220c40/properties:query' \
         -d '{
                  "query": {
                      "$ge": [
                          "properties.Analytical Properties.Absorptance",
                          0.1
                      ]
                  },
                  "fields": [
                      "objectid",
                      "name",
                      "externalId",
                      "properties.Analytical Properties"
                  ],
                  "pagination": {
                      "offset": 0,
                      "limit": 20
                  },
                  "payload": "unit"
              }'
    
    Show More

    Response

    {
        "pagination": {
            "limit": 20,
            "offset": 0,
            "totalResults": 79
        },
        "data": {
            "type": "properties",
            "collection": [
                {
                    "objectid": 169,
                    "name": "Floor [176804]",
                    "externalId": "203cff26-4c9d-4eb4-93e5-28d28a01f256-0002b2a4",
                    "properties": {
                        "Analytical Properties": {
                            "Heat Transfer Coefficient (U)": "##0{watt / (m^2 kelvin)}[4]{kg / (s^3 K)}",
                            "Thermal Resistance (R)": "##0{m^2 kelvin / watt}[4]{(s^3 K) / kg}",
                            "Thermal mass": "##0{kjoule / kelvin}[2]{(kg m^2) / (s^2 K)}",
                            "Absorptance": "##0.1{}[3]{}"
                        }
                    }
                },
                {
                    "objectid": 170,
                    "name": "Basic Wall [198749]",
                    "externalId": "ef57b02a-5e81-49e7-93bb-ae5f002d921c-0003085d",
                    "properties": {
                        "Analytical Properties": {
                            "Heat Transfer Coefficient (U)": "##0{watt / (m^2 kelvin)}[4]{kg / (s^3 K)}",
                            "Thermal Resistance (R)": "##0{m^2 kelvin / watt}[4]{(s^3 K) / kg}",
                            "Thermal mass": "##0{kjoule / kelvin}[2]{(kg m^2) / (s^2 K)}",
                            "Absorptance": "##0.1{}[3]{}"
                        }
                    }
                },
                {
                    "objectid": 172,
                    "name": "Basic Wall [418079]",
                    "externalId": "72678df9-14a3-4aee-a80e-94a8e55a0926-0006611f",
                    "properties": {
                        "Analytical Properties": {
                            "Heat Transfer Coefficient (U)": "##0{watt / (m^2 kelvin)}[4]{kg / (s^3 K)}",
                            "Thermal Resistance (R)": "##0{m^2 kelvin / watt}[4]{(s^3 K) / kg}",
                            "Thermal mass": "##0{kjoule / kelvin}[2]{(kg m^2) / (s^2 K)}",
                            "Absorptance": "##0.1{}[3]{}"
                        }
                    }
                },
                {
                    "objectid": 175,
                    "name": "Basic Wall [422243]",
                    "externalId": "59371552-5800-43eb-9ba3-609565158fc5-00067163",
                    "properties": {
                        "Analytical Properties": {
                            "Heat Transfer Coefficient (U)": "##0{watt / (m^2 kelvin)}[4]{kg / (s^3 K)}",
                            "Thermal Resistance (R)": "##0{m^2 kelvin / watt}[4]{(s^3 K) / kg}",
                            "Thermal mass": "##0{kjoule / kelvin}[2]{(kg m^2) / (s^2 K)}",
                            "Absorptance": "##0.1{}[3]{}"
                        }
                    }
                },
                {
                    "objectid": 193,
                    "name": "Basic Wall [424922]",
                    "externalId": "59371552-5800-43eb-9ba3-609565158fc5-00067bda",
                    "properties": {
                        "Analytical Properties": {
                            "Heat Transfer Coefficient (U)": "##0{watt / (m^2 kelvin)}[4]{kg / (s^3 K)}",
                            "Thermal Resistance (R)": "##0{m^2 kelvin / watt}[4]{(s^3 K) / kg}",
                            "Thermal mass": "##0{kjoule / kelvin}[2]{(kg m^2) / (s^2 K)}",
                            "Absorptance": "##0.1{}[3]{}"
                        }
                    }
                },
                {
                    "objectid": 195,
                    "name": "Basic Wall [425745]",
                    "externalId": "7fcc8dca-3132-4323-9d41-faf5184b4f26-00067f11",
                    "properties": {
                        "Analytical Properties": {
                            "Heat Transfer Coefficient (U)": "##0{watt / (m^2 kelvin)}[4]{kg / (s^3 K)}",
                            "Thermal Resistance (R)": "##0{m^2 kelvin / watt}[4]{(s^3 K) / kg}",
                            "Thermal mass": "##0{kjoule / kelvin}[2]{(kg m^2) / (s^2 K)}",
                            "Absorptance": "##0.1{}[3]{}"
                        }
                    }
                },
                {
                    "objectid": 196,
                    "name": "Basic Wall [427092]",
                    "externalId": "c85e5be0-d8d5-4148-836f-b55e711ef373-00068454",
                    "properties": {
                        "Analytical Properties": {
                            "Heat Transfer Coefficient (U)": "##0{watt / (m^2 kelvin)}[4]{kg / (s^3 K)}",
                            "Thermal Resistance (R)": "##0{m^2 kelvin / watt}[4]{(s^3 K) / kg}",
                            "Thermal mass": "##0{kjoule / kelvin}[2]{(kg m^2) / (s^2 K)}",
                            "Absorptance": "##0.1{}[3]{}"
                        }
                    }
                },
                {
                    "objectid": 197,
                    "name": "Basic Wall [493612]",
                    "externalId": "17836a3c-e764-47fa-a2e0-08216444f621-0007882c",
                    "properties": {
                        "Analytical Properties": {
                            "Heat Transfer Coefficient (U)": "##0.7499999999999999{watt / (m^2 kelvin)}[4]{kg / (s^3 K)}",
                            "Thermal Resistance (R)": "##1.3333333333333335{m^2 kelvin / watt}[4]{(s^3 K) / kg}",
                            "Thermal mass": "##12.673461104640001{kjoule / kelvin}[2]{(kg m^2) / (s^2 K)}",
                            "Absorptance": "##0.1{}[3]{}"
                        }
                    }
                },
                {
                    "objectid": 198,
                    "name": "Basic Wall [493697]",
                    "externalId": "17836a3c-e764-47fa-a2e0-08216444f621-00078881",
                    "properties": {
                        "Analytical Properties": {
                            "Heat Transfer Coefficient (U)": "##0.7499999999999999{watt / (m^2 kelvin)}[4]{kg / (s^3 K)}",
                            "Thermal Resistance (R)": "##1.3333333333333335{m^2 kelvin / watt}[4]{(s^3 K) / kg}",
                            "Thermal mass": "##12.673461104640001{kjoule / kelvin}[2]{(kg m^2) / (s^2 K)}",
                            "Absorptance": "##0.1{}[3]{}"
                        }
                    }
                },
                {
                    "objectid": 199,
                    "name": "Basic Wall [493790]",
                    "externalId": "17836a3c-e764-47fa-a2e0-08216444f621-000788de",
                    "properties": {
                        "Analytical Properties": {
                            "Heat Transfer Coefficient (U)": "##0.7499999999999999{watt / (m^2 kelvin)}[4]{kg / (s^3 K)}",
                            "Thermal Resistance (R)": "##1.3333333333333335{m^2 kelvin / watt}[4]{(s^3 K) / kg}",
                            "Thermal mass": "##12.673461104640001{kjoule / kelvin}[2]{(kg m^2) / (s^2 K)}",
                            "Absorptance": "##0.1{}[3]{}"
                        }
                    }
                },
                {
                    "objectid": 200,
                    "name": "Basic Wall [493879]",
                    "externalId": "17836a3c-e764-47fa-a2e0-08216444f621-00078937",
                    "properties": {
                        "Analytical Properties": {
                            "Heat Transfer Coefficient (U)": "##3.486666666666667{watt / (m^2 kelvin)}[4]{kg / (s^3 K)}",
                            "Thermal Resistance (R)": "##0.28680688336520077{m^2 kelvin / watt}[4]{(s^3 K) / kg}",
                            "Thermal mass": "##42.1157351232{kjoule / kelvin}[2]{(kg m^2) / (s^2 K)}",
                            "Absorptance": "##0.1{}[3]{}"
                        }
                    }
                },
                {
                    "objectid": 201,
                    "name": "Floor [495352]",
                    "externalId": "17836a3c-e764-47fa-a2e0-08216444f621-00078ef8",
                    "properties": {
                        "Analytical Properties": {
                            "Heat Transfer Coefficient (U)": "##0.6083921894474449{watt / (m^2 kelvin)}[4]{kg / (s^3 K)}",
                            "Thermal Resistance (R)": "##1.6436765910953293{m^2 kelvin / watt}[4]{(s^3 K) / kg}",
                            "Thermal mass": "##31.743853931520004{kjoule / kelvin}[2]{(kg m^2) / (s^2 K)}",
                            "Absorptance": "##0.1{}[3]{}"
                        }
                    }
                },
                {
                    "objectid": 202,
                    "name": "Pad [523064]",
                    "externalId": "7cce6b00-0763-4991-acce-01cfe02128f7-0007fb38",
                    "properties": {
                        "Analytical Properties": {
                            "Heat Transfer Coefficient (U)": "##0{watt / (m^2 kelvin)}[4]{kg / (s^3 K)}",
                            "Thermal Resistance (R)": "##0{m^2 kelvin / watt}[4]{(s^3 K) / kg}",
                            "Thermal mass": "##0{kjoule / kelvin}[2]{(kg m^2) / (s^2 K)}",
                            "Absorptance": "##0.1{}[3]{}"
                        }
                    }
                },
                {
                    "objectid": 204,
                    "name": "Basic Wall [627064]",
                    "externalId": "5b7ac240-e9a7-43b2-b6bf-246956549a40-00099178",
                    "properties": {
                        "Analytical Properties": {
                            "Heat Transfer Coefficient (U)": "##0.7499999999999999{watt / (m^2 kelvin)}[4]{kg / (s^3 K)}",
                            "Thermal Resistance (R)": "##1.3333333333333335{m^2 kelvin / watt}[4]{(s^3 K) / kg}",
                            "Thermal mass": "##12.673461104640001{kjoule / kelvin}[2]{(kg m^2) / (s^2 K)}",
                            "Absorptance": "##0.1{}[3]{}"
                        }
                    }
                },
                {
                    "objectid": 205,
                    "name": "Basic Wall [627729]",
                    "externalId": "5b7ac240-e9a7-43b2-b6bf-246956549a40-00099411",
                    "properties": {
                        "Analytical Properties": {
                            "Heat Transfer Coefficient (U)": "##0.7499999999999999{watt / (m^2 kelvin)}[4]{kg / (s^3 K)}",
                            "Thermal Resistance (R)": "##1.3333333333333335{m^2 kelvin / watt}[4]{(s^3 K) / kg}",
                            "Thermal mass": "##12.673461104640001{kjoule / kelvin}[2]{(kg m^2) / (s^2 K)}",
                            "Absorptance": "##0.1{}[3]{}"
                        }
                    }
                },
                {
                    "objectid": 206,
                    "name": "Basic Wall [628523]",
                    "externalId": "5b7ac240-e9a7-43b2-b6bf-246956549a40-0009972b",
                    "properties": {
                        "Analytical Properties": {
                            "Heat Transfer Coefficient (U)": "##0.7499999999999999{watt / (m^2 kelvin)}[4]{kg / (s^3 K)}",
                            "Thermal Resistance (R)": "##1.3333333333333335{m^2 kelvin / watt}[4]{(s^3 K) / kg}",
                            "Thermal mass": "##12.673461104640001{kjoule / kelvin}[2]{(kg m^2) / (s^2 K)}",
                            "Absorptance": "##0.1{}[3]{}"
                        }
                    }
                },
                {
                    "objectid": 207,
                    "name": "Floor [647908]",
                    "externalId": "66314231-2860-4f9f-87a8-f581c5b96b2f-0009e2e4",
                    "properties": {
                        "Analytical Properties": {
                            "Heat Transfer Coefficient (U)": "##4.648888888888889{watt / (m^2 kelvin)}[4]{kg / (s^3 K)}",
                            "Thermal Resistance (R)": "##0.21510516252390058{m^2 kelvin / watt}[4]{(s^3 K) / kg}",
                            "Thermal mass": "##31.586801342400005{kjoule / kelvin}[2]{(kg m^2) / (s^2 K)}",
                            "Absorptance": "##0.1{}[3]{}"
                        }
                    }
                },
                {
                    "objectid": 218,
                    "name": "Compound Ceiling [697612]",
                    "externalId": "f714ef06-3fa3-4b95-b3e7-bbbd1e6eda49-000aa50c",
                    "properties": {
                        "Analytical Properties": {
                            "Heat Transfer Coefficient (U)": "##0{watt / (m^2 kelvin)}[4]{kg / (s^3 K)}",
                            "Thermal Resistance (R)": "##0{m^2 kelvin / watt}[4]{(s^3 K) / kg}",
                            "Thermal mass": "##0{kjoule / kelvin}[2]{(kg m^2) / (s^2 K)}",
                            "Absorptance": "##0.1{}[3]{}"
                        }
                    }
                },
                {
                    "objectid": 271,
                    "name": "Basic Wall [845266]",
                    "externalId": "f565bef9-7d27-4781-b8d4-60f4a6034d87-000ce5d2",
                    "properties": {
                        "Analytical Properties": {
                            "Heat Transfer Coefficient (U)": "##0{watt / (m^2 kelvin)}[4]{kg / (s^3 K)}",
                            "Thermal Resistance (R)": "##0{m^2 kelvin / watt}[4]{(s^3 K) / kg}",
                            "Thermal mass": "##0{kjoule / kelvin}[2]{(kg m^2) / (s^2 K)}",
                            "Absorptance": "##0.1{}[3]{}"
                        }
                    }
                },
                {
                    "objectid": 274,
                    "name": "Basic Wall [849032]",
                    "externalId": "98e2f96c-ccbd-4abb-a697-e7e5136106ee-000cf488",
                    "properties": {
                        "Analytical Properties": {
                            "Heat Transfer Coefficient (U)": "##0{watt / (m^2 kelvin)}[4]{kg / (s^3 K)}",
                            "Thermal Resistance (R)": "##0{m^2 kelvin / watt}[4]{(s^3 K) / kg}",
                            "Thermal mass": "##0{kjoule / kelvin}[2]{(kg m^2) / (s^2 K)}",
                            "Absorptance": "##0.1{}[3]{}"
                        }
                    }
                }
            ]
        }
    }
    
    Show More