Class RefsRequestBuilder

Namespace

Autodesk.DataManagement.Data.V1.Projects.Item.Items.Item.Relationships.Refs

Assembly

Autodesk.DataManagement.dll

Builds and executes requests for operations under \data\v1\projects{project_id}\items{item_id}\relationships\refs

public class RefsRequestBuilder : BaseRequestBuilder

Inheritance

object

BaseRequestBuilder

RefsRequestBuilder

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

RefsRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new RefsRequestBuilder and sets the default values.

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

RefsRequestBuilder(string, IRequestAdapter)

Instantiates a new RefsRequestBuilder and sets the default values.

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

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

Returns the custom relationships that are associated with the given item_id. Custom relationships can be established between an item and other resources within the data domain service (folders, items, and versions).Notes:Each relationship is defined by the id of the object at the other end of the relationship, together with type, specific reference meta including extension data.Callers will typically use a filter parameter to restrict the response to the custom relationship types (filter[meta.refType]) they are interested in.The response body will have an included array which contains the resources that are involved in the relationship, which is essentially the GET projects/:project_id/items/:item_id/refs endpoint.New! Autodesk Construction Cloud platform (ACC). Note that this endpoint is compatible with ACC projects. For more information about the Autodesk Construction Cloud APIs, see the Autodesk Construction Cloud documentation.

public Task<RelationshipRefs?> GetAsync(Action<RequestConfiguration<RefsRequestBuilder.RefsRequestBuilderGetQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

requestConfiguration Action<RequestConfiguration<RefsRequestBuilder.RefsRequestBuilderGetQueryParameters>>

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

cancellationToken CancellationToken

Cancellation token to use when cancelling requests

Returns

Task<RelationshipRefs>

A RelationshipRefs

Exceptions

RelationshipRefs400Error

When receiving a 400 status code

RelationshipRefs403Error

When receiving a 403 status code

RelationshipRefs404Error

When receiving a 404 status code

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

Creates a custom relationship between an item and another resource within the data domain service (folder, item, or version)

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

Parameters

body RelationshipRefsRequest

Describe the ref to be created.

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

Exceptions

Refs400Error

When receiving a 400 status code

Refs403Error

When receiving a 403 status code

Refs404Error

When receiving a 404 status code

ToGetRequestInformation(Action<RequestConfiguration<RefsRequestBuilderGetQueryParameters>>?)

Returns the custom relationships that are associated with the given item_id. Custom relationships can be established between an item and other resources within the data domain service (folders, items, and versions).Notes:Each relationship is defined by the id of the object at the other end of the relationship, together with type, specific reference meta including extension data.Callers will typically use a filter parameter to restrict the response to the custom relationship types (filter[meta.refType]) they are interested in.The response body will have an included array which contains the resources that are involved in the relationship, which is essentially the GET projects/:project_id/items/:item_id/refs endpoint.New! Autodesk Construction Cloud platform (ACC). Note that this endpoint is compatible with ACC projects. For more information about the Autodesk Construction Cloud APIs, see the Autodesk Construction Cloud documentation.

public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<RefsRequestBuilder.RefsRequestBuilderGetQueryParameters>>? requestConfiguration = null)

Parameters

requestConfiguration Action<RequestConfiguration<RefsRequestBuilder.RefsRequestBuilderGetQueryParameters>>

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

Returns

RequestInformation

A Microsoft.Kiota.Abstractions.RequestInformation

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

Creates a custom relationship between an item and another resource within the data domain service (folder, item, or version)

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

Parameters

body RelationshipRefsRequest

Describe the ref to be created.

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

Parameters

rawUrl string

The raw URL to use for the request builder.

Returns

RefsRequestBuilder

A RefsRequestBuilder