Table of Contents

Class WithModelGuItemRequestBuilder

Namespace
Autodesk.ModelDerivative.Designdata.Item.Metadata.Item
Assembly
Autodesk.ModelDerivative.dll

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

public class WithModelGuItemRequestBuilder : BaseRequestBuilder
Inheritance
BaseRequestBuilder
WithModelGuItemRequestBuilder
Inherited Members
BaseRequestBuilder.PathParameters
BaseRequestBuilder.RequestAdapter
BaseRequestBuilder.UrlTemplate

Constructors

WithModelGuItemRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new WithModelGuItemRequestBuilder and sets the default values.

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

WithModelGuItemRequestBuilder(string, IRequestAdapter)

Instantiates a new WithModelGuItemRequestBuilder and sets the default values.

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

Properties

The properties property

public PropertiesRequestBuilder Properties { get; }

Property Value

PropertiesRequestBuilder

PropertiesQuery

The propertiesQuery property

public PropertiesQueryRequestBuilder PropertiesQuery { get; }

Property Value

PropertiesQueryRequestBuilder

Methods

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

Returns a hierarchical list of objects (object tree) in the model view specified by the modelGuid URI parameter.Before you call this endpoint you must call GET {urn}/metadata to obtain the ID (modelGuid) of the model view you want to get the object tree of.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 a design that has been translated to SVF or SVF2.

public Task<ObjectTree?> GetAsync(Action<RequestConfiguration<WithModelGuItemRequestBuilder.WithModelGuItemRequestBuilderGetQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

requestConfiguration Action<RequestConfiguration<WithModelGuItemRequestBuilder.WithModelGuItemRequestBuilderGetQueryParameters>>

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

cancellationToken CancellationToken

Cancellation token to use when cancelling requests

Returns

Task<ObjectTree>

A ObjectTree

Exceptions

ObjectTree400Error

When receiving a 400 status code

ObjectTree401Error

When receiving a 401 status code

ObjectTree403Error

When receiving a 403 status code

ObjectTree404Error

When receiving a 404 status code

ObjectTree406Error

When receiving a 406 status code

ObjectTree409Error

When receiving a 409 status code

ObjectTree413Error

When receiving a 413 status code

ObjectTree429Error

When receiving a 429 status code

ObjectTree500Error

When receiving a 500 status code

ToGetRequestInformation(Action<RequestConfiguration<WithModelGuItemRequestBuilderGetQueryParameters>>?)

Returns a hierarchical list of objects (object tree) in the model view specified by the modelGuid URI parameter.Before you call this endpoint you must call GET {urn}/metadata to obtain the ID (modelGuid) of the model view you want to get the object tree of.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 a design that has been translated to SVF or SVF2.

public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<WithModelGuItemRequestBuilder.WithModelGuItemRequestBuilderGetQueryParameters>>? requestConfiguration = null)

Parameters

requestConfiguration Action<RequestConfiguration<WithModelGuItemRequestBuilder.WithModelGuItemRequestBuilderGetQueryParameters>>

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

Parameters

rawUrl string

The raw URL to use for the request builder.

Returns

WithModelGuItemRequestBuilder

A WithModelGuItemRequestBuilder