Class MetadataRequestBuilder

Namespace

Autodesk.ModelDerivative.Designdata.Item.Metadata

Assembly

Autodesk.ModelDerivative.dll

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

public class MetadataRequestBuilder : BaseRequestBuilder

Inheritance

object

BaseRequestBuilder

MetadataRequestBuilder

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

MetadataRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new MetadataRequestBuilder and sets the default values.

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

MetadataRequestBuilder(string, IRequestAdapter)

Instantiates a new MetadataRequestBuilder and sets the default values.

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

Properties

this[string]

Gets an item from the Autodesk.ModelDerivative.designdata.item.metadata.item collection

public WithModelGuItemRequestBuilder this[string position] { get; }

Parameters

position string

Unique model view ID. Call GET {urn}/metadata to get the ID

Property Value

WithModelGuItemRequestBuilder

A WithModelGuItemRequestBuilder

Methods

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

Returns a list of model views (Viewables) in the source design specified by the urn URI parameter. It also returns the ID that uniquely identifies the model view. You can use this ID with other metadata endpoints to obtain information about the objects within model view.Most design applications like Fusion 360 and Inventor contain only one model view per design. However, some applications like Revit allow multiple model views (e.g., HVAC, architecture, perspective) per design.Note: You can retrieve metadata only from an input file that has been translated to SVF or SVF2.

public Task<ModelViews?> GetAsync(Action<RequestConfiguration<MetadataRequestBuilder.MetadataRequestBuilderGetQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

requestConfiguration Action<RequestConfiguration<MetadataRequestBuilder.MetadataRequestBuilderGetQueryParameters>>

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

cancellationToken CancellationToken

Cancellation token to use when cancelling requests

Returns

Task<ModelViews>

A ModelViews

Exceptions

ModelViews400Error

When receiving a 400 status code

ModelViews401Error

When receiving a 401 status code

ModelViews403Error

When receiving a 403 status code

ModelViews404Error

When receiving a 404 status code

ModelViews500Error

When receiving a 500 status code

ToGetRequestInformation(Action<RequestConfiguration<MetadataRequestBuilderGetQueryParameters>>?)

Returns a list of model views (Viewables) in the source design specified by the urn URI parameter. It also returns the ID that uniquely identifies the model view. You can use this ID with other metadata endpoints to obtain information about the objects within model view.Most design applications like Fusion 360 and Inventor contain only one model view per design. However, some applications like Revit allow multiple model views (e.g., HVAC, architecture, perspective) per design.Note: You can retrieve metadata only from an input file that has been translated to SVF or SVF2.

public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<MetadataRequestBuilder.MetadataRequestBuilderGetQueryParameters>>? requestConfiguration = null)

Parameters

requestConfiguration Action<RequestConfiguration<MetadataRequestBuilder.MetadataRequestBuilderGetQueryParameters>>

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

Parameters

rawUrl string

The raw URL to use for the request builder.

Returns

MetadataRequestBuilder

A MetadataRequestBuilder