Class WithFolder_ItemRequestBuilder

Namespace

Autodesk.DataManagement.Data.V1.Projects.Item.Folders.Item

Assembly

Autodesk.DataManagement.dll

Builds and executes requests for operations under \data\v1\projects{project_id}\folders{folder_id}

public class WithFolder_ItemRequestBuilder : BaseRequestBuilder

Inheritance

object

BaseRequestBuilder

WithFolder_ItemRequestBuilder

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

WithFolder_ItemRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new WithFolder_ItemRequestBuilder and sets the default values.

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

WithFolder_ItemRequestBuilder(string, IRequestAdapter)

Instantiates a new WithFolder_ItemRequestBuilder and sets the default values.

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

Contents

The contents property

public ContentsRequestBuilder Contents { get; }

Property Value

ContentsRequestBuilder

Parent

The parent property

public ParentRequestBuilder Parent { get; }

Property Value

ParentRequestBuilder

Refs

The refs property

public RefsRequestBuilder Refs { get; }

Property Value

RefsRequestBuilder

Relationships

The relationships property

public RelationshipsRequestBuilder Relationships { get; }

Property Value

RelationshipsRequestBuilder

Search

The search property

public SearchRequestBuilder Search { get; }

Property Value

SearchRequestBuilder

Methods

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

Returns the folder by ID for any folder within a given project. All folders or sub-folders within a project are associated with their own unique ID, including the root folder.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<Folder?> GetAsync(Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

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<Folder>

A Folder

Exceptions

Folder400Error

When receiving a 400 status code

Folder403Error

When receiving a 403 status code

Folder404Error

When receiving a 404 status code

PatchAsync(ModifyFolder, Action<RequestConfiguration<DefaultQueryParameters>>?, CancellationToken)

Modifies folder names. You can also use this endpoint to delete and restore BIM 360 Docs folders by using the hidden attribute, or move BIM 360 Docs folders by using parent relationships.Note that you cannot permanently delete BIM 360 Docs folders. They are tagged as hidden folders and are removed from the BIM 360 Docs UI and from regular Data Management API responses until you restore them. You can use the hidden filter (filter[hidden]=true) to get a list of deleted folders with the GET projects/:project_id/folders/:folder_id/contents endpoint.Note that to access BIM 360 Docs folders using the Data Management API you need to provision your app in the BIM 360 Account Administrator portal. For more details, see the Manage Access to Docs tutorial.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<Folder?> PatchAsync(ModifyFolder body, Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

body ModifyFolder

Modifies folder names

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<Folder>

A Folder

Exceptions

Folder400Error

When receiving a 400 status code

Folder403Error

When receiving a 403 status code

Folder404Error

When receiving a 404 status code

Folder423Error

When receiving a 423 status code

ToGetRequestInformation(Action<RequestConfiguration<DefaultQueryParameters>>?)

Returns the folder by ID for any folder within a given project. All folders or sub-folders within a project are associated with their own unique ID, including the root folder.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<DefaultQueryParameters>>? requestConfiguration = null)

Parameters

requestConfiguration Action<RequestConfiguration<DefaultQueryParameters>>

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

Returns

RequestInformation

A Microsoft.Kiota.Abstractions.RequestInformation

ToPatchRequestInformation(ModifyFolder, Action<RequestConfiguration<DefaultQueryParameters>>?)

Modifies folder names. You can also use this endpoint to delete and restore BIM 360 Docs folders by using the hidden attribute, or move BIM 360 Docs folders by using parent relationships.Note that you cannot permanently delete BIM 360 Docs folders. They are tagged as hidden folders and are removed from the BIM 360 Docs UI and from regular Data Management API responses until you restore them. You can use the hidden filter (filter[hidden]=true) to get a list of deleted folders with the GET projects/:project_id/folders/:folder_id/contents endpoint.Note that to access BIM 360 Docs folders using the Data Management API you need to provision your app in the BIM 360 Account Administrator portal. For more details, see the Manage Access to Docs tutorial.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 ToPatchRequestInformation(ModifyFolder body, Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null)

Parameters

body ModifyFolder

Modifies folder names

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

Parameters

rawUrl string

The raw URL to use for the request builder.

Returns

WithFolder_ItemRequestBuilder

A WithFolder_ItemRequestBuilder