Class ModelDerivativeClientHelper

Namespace

Autodesk.ModelDerivative.Helpers

Assembly

Autodesk.ModelDerivative.dll

public class ModelDerivativeClientHelper

Inheritance

object

ModelDerivativeClientHelper

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Api

The Model Derivative API client

public BaseModelDerivativeClient Api { get; init; }

Property Value

BaseModelDerivativeClient

Methods

GetObjectTreeAsync(string, string?, int)

Returns the model tree, regardless of whether the model is in US or EMEA region. The ForceGet flag is used to retrieve large models tree.

public Task<ObjectTree?> GetObjectTreeAsync(string fileVersionUrn, string? modelGuid = null, int timeout = 3000)

Parameters

fileVersionUrn string

FileUrn like: 'urn:adsk.wipprod:fs.file:vf.Efx_JwkDQkuOHB21T2k30w?version=1' or encoded in Base64 safe-URL

modelGuid string

Optional: ModelGuid of the view to use. If not set, the first view is used

timeout int

Default: 5 minutes

Returns

Task<ObjectTree>

The model tree

Remarks

The server location is defined with the client instantiation

Exceptions

InvalidOperationException

Unable to retrieve the tree before the timeout

GetSpecificPropertiesAsync(string, UntypedObject, List<string>?, string?, int)

Return a specific set of properties of a specific set of objects in the model

public Task<ParsedSpecificProperties?> GetSpecificPropertiesAsync(string fileVersionUrn, UntypedObject query, List<string>? fields = null, string? modelGuid = null, int timeout = 3000)

Parameters

fileVersionUrn string

FileUrn like: 'urn:adsk.wipprod:fs.file:vf.Efx_JwkDQkuOHB21T2k30w?version=1' or encoded in Base64 safe-URL

query UntypedObject

Filter the objects to return

fields List<string>

Filter the properties to return

modelGuid string

Optional: ModelGuid of the view to use. If not set, the first view is used

timeout int

Default: 5 minutes

Returns

Task<ParsedSpecificProperties>

Properties of objects in the model

Remarks

The server location is defined with the client instantiation

Exceptions

InvalidOperationException

Unable to retrieve the tree before the timeout

IsBase64UrlSafeString(string)

public static bool IsBase64UrlSafeString(string input)

Parameters

input string

Returns

bool

ToBase64UrlSafeString(string, bool)

Returns a Base64 URL-safe encoded string

public static string ToBase64UrlSafeString(string input, bool forceConversion = false)

Parameters

input string

Input string to convert

forceConversion bool

Optional: If 'true' doesn't check if the string is a compatible Base64 string; Default: False

Returns

string