POST /modelderivative/v2/designdata/{urn}/metadata/{modelGuid}/properties:query

The ID of the Model View you are querying. Use the List Model Views </en/docs/model-derivative/v2/reference/http/metadata/urn-metadata-GET>_ operation to get the IDs of the Model Views in the source design.

The URL-safe Base64 encoded URN of the source design.

Specifies what 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 parameter with one derivative (URN), you must use it consistently across the following:

   • Create Translation Job </en/docs/model-derivative/v2/reference/http/job-POST>_ (for OBJ output)
   • Fetch Object Tree </en/docs/model-derivative/v2/reference/http/urn-metadata-modelguid-GET>_
   • Fetch All Properties </en/docs/model-derivative/v2/reference/http/urn-metadata-guid-properties-GET>_
   • Fetch Specific Properties <en/docs/model-derivative/v2/reference/http/metadata/urn-metadata-guid-properties-query-POST>_

Valid values:

• "latest"
• "fallback"

Specifies the data center where the manifest and derivatives of the specified source design are stored. Possible values are:

• US - (Default) Data center for the US region.
• EMEA - Data center for the European Union, Middle East, and Africa.
• AUS - Data center for the Australia region.
• CAN - Data center for the Canada region.
• DEU - Data center for the Germany region.
• IND - Data center for the India region.
• JPN - Data center for the Japan region.
• GBR - Data center for the United Kingdom region.

Valid values:

• "US"
• "IND"
• "AUS"
• "EMEA"
• "CAN"
• "JPN"
• "GBR"
• "DEU"

Default value: "application/json"

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.

Specifies what objects to query. Contains the parameters to pass to the search service. You can use one of the following forms:

Specifies how to split the response into multiple pages, and return the response one page at a time.

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.

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.

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.

Valid values:

• "text"
• "unit"

Specifies what properties of the objects to return. If you do not specify this attribute, the response returns all properties.

Possible values are:

• 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.