Class UsersRequestBuilder

Namespace

Autodesk.ACC.AccountAdmin.Projects.Item.Users

Assembly

Autodesk.ACC.AccountAdmin.dll

Builds and executes requests for operations under \projects{projectId}\users

public class UsersRequestBuilder : BaseRequestBuilder

Inheritance

object

BaseRequestBuilder

UsersRequestBuilder

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

UsersRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new UsersRequestBuilder and sets the default values.

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

UsersRequestBuilder(string, IRequestAdapter)

Instantiates a new UsersRequestBuilder and sets the default values.

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

this[string]

Gets an item from the Autodesk.ACC.AccountAdmin.projects.item.users.item collection

public WithUserItemRequestBuilder this[string position] { get; }

Parameters

position string

The ID of the user. You can use either the user ID (id) or the autodesk ID (autodeskId).

Property Value

WithUserItemRequestBuilder

A WithUserItemRequestBuilder

Methods

GetAsUsersGetResponseAsync(Action<RequestConfiguration<UsersRequestBuilderGetQueryParameters>>?, CancellationToken)

Retrieves information about all the users in a project. To get information about all the users in an account, see GET accounts/users </en/docs/bim360/v1/reference/http/users-GET/>_.

public Task<UsersGetResponse?> GetAsUsersGetResponseAsync(Action<RequestConfiguration<UsersRequestBuilder.UsersRequestBuilderGetQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

requestConfiguration Action<RequestConfiguration<UsersRequestBuilder.UsersRequestBuilderGetQueryParameters>>

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

cancellationToken CancellationToken

Cancellation token to use when cancelling requests

Returns

Task<UsersGetResponse>

A UsersGetResponse

Exceptions

ValidationError

When receiving a 400 status code

Error

When receiving a 401 status code

Error

When receiving a 403 status code

Error

When receiving a 404 status code

Error

When receiving a 406 status code

ValidationError

When receiving a 409 status code

Error

When receiving a 410 status code

Error

When receiving a 500 status code

Error

When receiving a 503 status code

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

Retrieves information about all the users in a project. To get information about all the users in an account, see GET accounts/users </en/docs/bim360/v1/reference/http/users-GET/>_.

[Obsolete("This method is obsolete. Use GetAsUsersGetResponseAsync instead.")]
public Task<UsersResponse?> GetAsync(Action<RequestConfiguration<UsersRequestBuilder.UsersRequestBuilderGetQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

requestConfiguration Action<RequestConfiguration<UsersRequestBuilder.UsersRequestBuilderGetQueryParameters>>

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

cancellationToken CancellationToken

Cancellation token to use when cancelling requests

Returns

Task<UsersResponse>

A UsersResponse

Exceptions

ValidationError

When receiving a 400 status code

Error

When receiving a 401 status code

Error

When receiving a 403 status code

Error

When receiving a 404 status code

Error

When receiving a 406 status code

ValidationError

When receiving a 409 status code

Error

When receiving a 410 status code

Error

When receiving a 500 status code

Error

When receiving a 503 status code

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

Private Use - Add a user to a project.

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

Parameters

body ProjectUser

The request body

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

A ProjectUserResponse

Exceptions

ValidationError

When receiving a 400 status code

Error

When receiving a 401 status code

Error

When receiving a 403 status code

Error

When receiving a 404 status code

ValidationError

When receiving a 409 status code

Error

When receiving a 410 status code

Error

When receiving a 412 status code

Error

When receiving a 415 status code

Error

When receiving a 500 status code

Error

When receiving a 503 status code

ToGetRequestInformation(Action<RequestConfiguration<UsersRequestBuilderGetQueryParameters>>?)

Retrieves information about all the users in a project. To get information about all the users in an account, see GET accounts/users </en/docs/bim360/v1/reference/http/users-GET/>_.

public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<UsersRequestBuilder.UsersRequestBuilderGetQueryParameters>>? requestConfiguration = null)

Parameters

requestConfiguration Action<RequestConfiguration<UsersRequestBuilder.UsersRequestBuilderGetQueryParameters>>

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

Returns

RequestInformation

A Microsoft.Kiota.Abstractions.RequestInformation

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

Private Use - Add a user to a project.

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

Parameters

body ProjectUser

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

Parameters

rawUrl string

The raw URL to use for the request builder.

Returns

UsersRequestBuilder

A UsersRequestBuilder