Class PropertiesQueryRequestBuilder

Namespace

Autodesk.ModelDerivative.Designdata.Item.Metadata.Item.PropertiesQuery

Assembly

Autodesk.ModelDerivative.dll

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

public class PropertiesQueryRequestBuilder : BaseRequestBuilder

Inheritance

object

BaseRequestBuilder

PropertiesQueryRequestBuilder

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

PropertiesQueryRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new PropertiesQueryRequestBuilder and sets the default values.

public PropertiesQueryRequestBuilder(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.

PropertiesQueryRequestBuilder(string, IRequestAdapter)

Instantiates a new PropertiesQueryRequestBuilder and sets the default values.

public PropertiesQueryRequestBuilder(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

PostAsync(SpecificPropertiesPayload, Action<RequestConfiguration<DefaultQueryParameters>>?, CancellationToken)

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 in the request body.Before you call this endpoint use the GET {urn}/metadata endpoint, to obtain the IDs of the model views (Viewables) contained in the design. After that, specify the ID of the model view you want to query as the modelGuid URI parameter.Note: Before you query a model view for properties, the design must be translated to SVF or SVF2.

public Task<SpecificProperties?> PostAsync(SpecificPropertiesPayload body, Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

body SpecificPropertiesPayload

The request body

requestConfiguration Action<RequestConfiguration<DefaultQueryParameters>>

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

cancellationToken CancellationToken

Cancellation token to use when cancelling requests

Returns

Task<SpecificProperties>

A SpecificProperties

Exceptions

SpecificProperties400Error

When receiving a 400 status code

SpecificProperties404Error

When receiving a 404 status code

SpecificProperties429Error

When receiving a 429 status code

SpecificProperties500Error

When receiving a 500 status code

ToPostRequestInformation(SpecificPropertiesPayload, Action<RequestConfiguration<DefaultQueryParameters>>?)

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 in the request body.Before you call this endpoint use the GET {urn}/metadata endpoint, to obtain the IDs of the model views (Viewables) contained in the design. After that, specify the ID of the model view you want to query as the modelGuid URI parameter.Note: Before you query a model view for properties, the design must be translated to SVF or SVF2.

public RequestInformation ToPostRequestInformation(SpecificPropertiesPayload body, Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null)

Parameters

body SpecificPropertiesPayload

The request body

requestConfiguration Action<RequestConfiguration<DefaultQueryParameters>>

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 PropertiesQueryRequestBuilder WithUrl(string rawUrl)

Parameters

rawUrl string

The raw URL to use for the request builder.

Returns

PropertiesQueryRequestBuilder

A PropertiesQueryRequestBuilder