Class PropertiesRequestBuilder

Namespace

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

Assembly

Autodesk.ModelDerivative.dll

Builds and executes requests for operations under \designdata{urn}\metadata{modelGuid}\properties

public class PropertiesRequestBuilder : BaseRequestBuilder

Inheritance

object

BaseRequestBuilder

PropertiesRequestBuilder

Inherited Members

BaseRequestBuilder.PathParameters

BaseRequestBuilder.RequestAdapter

BaseRequestBuilder.UrlTemplate

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PropertiesRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new PropertiesRequestBuilder and sets the default values.

public PropertiesRequestBuilder(Dictionary<string, object> pathParameters, IRequestAdapter requestAdapter)

Parameters

pathParameters Dictionary<string, object>

Path parameters for the request

requestAdapter IRequestAdapter

The request adapter to use to execute the requests.

PropertiesRequestBuilder(string, IRequestAdapter)

Instantiates a new PropertiesRequestBuilder and sets the default values.

public PropertiesRequestBuilder(string rawUrl, IRequestAdapter requestAdapter)

Parameters

rawUrl string

The raw URL to use for the request builder.

requestAdapter IRequestAdapter

The request adapter to use to execute the requests.

Methods

GetAsync(Action<RequestConfiguration<PropertiesRequestBuilderGetQueryParameters>>?, CancellationToken)

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 Task<AllProperties?> GetAsync(Action<RequestConfiguration<PropertiesRequestBuilder.PropertiesRequestBuilderGetQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

requestConfiguration Action<RequestConfiguration<PropertiesRequestBuilder.PropertiesRequestBuilderGetQueryParameters>>

Configuration for the request such as headers, query parameters, and middleware options.

cancellationToken CancellationToken

Cancellation token to use when cancelling requests

Returns

Task<AllProperties>

A AllProperties

Exceptions

AllProperties400Error

When receiving a 400 status code

AllProperties401Error

When receiving a 401 status code

AllProperties403Error

When receiving a 403 status code

AllProperties404Error

When receiving a 404 status code

AllProperties406Error

When receiving a 406 status code

AllProperties409Error

When receiving a 409 status code

AllProperties413Error

When receiving a 413 status code

AllProperties429Error

When receiving a 429 status code

AllProperties500Error

When receiving a 500 status code

ToGetRequestInformation(Action<RequestConfiguration<PropertiesRequestBuilderGetQueryParameters>>?)

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 RequestInformation ToGetRequestInformation(Action<RequestConfiguration<PropertiesRequestBuilder.PropertiesRequestBuilderGetQueryParameters>>? requestConfiguration = null)

Parameters

requestConfiguration Action<RequestConfiguration<PropertiesRequestBuilder.PropertiesRequestBuilderGetQueryParameters>>

Configuration for the request such as headers, query parameters, and middleware options.

Returns

RequestInformation

A Microsoft.Kiota.Abstractions.RequestInformation

WithUrl(string)

Returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored.

public PropertiesRequestBuilder WithUrl(string rawUrl)

Parameters

rawUrl string

The raw URL to use for the request builder.

Returns

PropertiesRequestBuilder

A PropertiesRequestBuilder