Class ReferencesRequestBuilder
- Namespace
- Autodesk.ModelDerivative.Designdata.Item.References
- Assembly
- Autodesk.ModelDerivative.dll
Builds and executes requests for operations under \designdata{urn}\references
public class ReferencesRequestBuilder : BaseRequestBuilder
- Inheritance
-
BaseRequestBuilderReferencesRequestBuilder
- Inherited Members
-
BaseRequestBuilder.PathParametersBaseRequestBuilder.RequestAdapterBaseRequestBuilder.UrlTemplate
Constructors
ReferencesRequestBuilder(Dictionary<string, object>, IRequestAdapter)
Instantiates a new ReferencesRequestBuilder and sets the default values.
public ReferencesRequestBuilder(Dictionary<string, object> pathParameters, IRequestAdapter requestAdapter)
Parameters
pathParameters
Dictionary<string, object>Path parameters for the request
requestAdapter
IRequestAdapterThe request adapter to use to execute the requests.
ReferencesRequestBuilder(string, IRequestAdapter)
Instantiates a new ReferencesRequestBuilder and sets the default values.
public ReferencesRequestBuilder(string rawUrl, IRequestAdapter requestAdapter)
Parameters
rawUrl
stringThe raw URL to use for the request builder.
requestAdapter
IRequestAdapterThe request adapter to use to execute the requests.
Methods
PostAsReferencesPostResponseAsync(ReferencesPostRequestBody, Action<RequestConfiguration<DefaultQueryParameters>>?, CancellationToken)
To create references for a composite design in Model Derivative. The description of references is stored in Model Derivative. To use it with the POST job endpoint, you need to set checkReferences to true.
public Task<ReferencesPostResponse?> PostAsReferencesPostResponseAsync(ReferencesPostRequestBody body, Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)
Parameters
body
ReferencesPostRequestBodyThe request body
requestConfiguration
Action<RequestConfiguration<DefaultQueryParameters>>Configuration for the request such as headers, query parameters, and middleware options.
cancellationToken
CancellationTokenCancellation token to use when cancelling requests
Returns
Exceptions
- References400Error
When receiving a 400 status code
- References401Error
When receiving a 401 status code
- References403Error
When receiving a 403 status code
- References404Error
When receiving a 404 status code
- References500Error
When receiving a 500 status code
PostAsync(ReferencesPostRequestBody, Action<RequestConfiguration<DefaultQueryParameters>>?, CancellationToken)
To create references for a composite design in Model Derivative. The description of references is stored in Model Derivative. To use it with the POST job endpoint, you need to set checkReferences to true.
[Obsolete("This method is obsolete. Use PostAsReferencesPostResponseAsync instead.")]
public Task<ReferencesResponse?> PostAsync(ReferencesPostRequestBody body, Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)
Parameters
body
ReferencesPostRequestBodyThe request body
requestConfiguration
Action<RequestConfiguration<DefaultQueryParameters>>Configuration for the request such as headers, query parameters, and middleware options.
cancellationToken
CancellationTokenCancellation token to use when cancelling requests
Returns
Exceptions
- References400Error
When receiving a 400 status code
- References401Error
When receiving a 401 status code
- References403Error
When receiving a 403 status code
- References404Error
When receiving a 404 status code
- References500Error
When receiving a 500 status code
ToPostRequestInformation(ReferencesPostRequestBody, Action<RequestConfiguration<DefaultQueryParameters>>?)
To create references for a composite design in Model Derivative. The description of references is stored in Model Derivative. To use it with the POST job endpoint, you need to set checkReferences to true.
public RequestInformation ToPostRequestInformation(ReferencesPostRequestBody body, Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null)
Parameters
body
ReferencesPostRequestBodyThe 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 ReferencesRequestBuilder WithUrl(string rawUrl)
Parameters
rawUrl
stringThe raw URL to use for the request builder.