Class PropertiesRequestBuilder.PropertiesRequestBuilderGetQueryParameters

Namespace

Autodesk.ModelDerivative.Designdata.Item.Metadata.Item.Properties

Assembly

Autodesk.ModelDerivative.dll

Returns a list of properties of objects contained in the model view specified by the modelGuid URI parameter. This request returns all properties for all objects by default. However, you can use the objectid query string parameter to return all properties of a specified object.Properties are returned as a flat list ordered, by their objectid. The objectid is a non-persistent ID assigned to an object when a design file is translated to the SVF or SVF2 format. This means that:A design file must be translated to SVF or SVF2 before you can retrieve properties.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.Note: Before you call this endpoint:Use the GET {urn}/metadata endpoint.Obtain the ID of the model view (Viewable) you want to check.Use the ID you obtained as the modelGuid URI parameter.Note: POST {urn}/metadata/{modelGuid}/properties:query provides greater flexibility to retrieve only the properties you are interested in. What’s more the response is paginated. So, when the number of properties returned is large, it can getz you the results faster.

public class PropertiesRequestBuilder.PropertiesRequestBuilderGetQueryParameters

Inheritance

object

PropertiesRequestBuilder.PropertiesRequestBuilderGetQueryParameters

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Forceget

true: Forcibly gets large resources even if they exceed the expected maximum size (20 MB). If the resource is larger than 800 MB, the server behaves as though forceget is false. In such a case, use the objectid query string parameter to download resources by Object ID one object at a time. Alternatively, you can use POST {urn}/metadata/{modelGuid}/properties:query to fetch only the properties you are interested in. false: (Default) Does not get resources if they exceed the expected maximum size (20 MB).

[QueryParameter("forceget")]
public bool? Forceget { get; set; }

Property Value

bool?

Objectid

he Object ID of the object you want to query properties for. If objectid is omitted, the server returns properties for all objects.

[QueryParameter("objectid")]
public int? Objectid { get; set; }

Property Value

int?