Class CompaniesRequestBuilder

Namespace

Autodesk.ACC.AccountAdmin.Accounts.Item.Companies

Assembly

Autodesk.ACC.AccountAdmin.dll

Builds and executes requests for operations under \accounts{accountId}\companies

public class CompaniesRequestBuilder : BaseRequestBuilder

Inheritance

object

BaseRequestBuilder

CompaniesRequestBuilder

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

CompaniesRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new CompaniesRequestBuilder and sets the default values.

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

CompaniesRequestBuilder(string, IRequestAdapter)

Instantiates a new CompaniesRequestBuilder and sets the default values.

public CompaniesRequestBuilder(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[Guid]

Gets an item from the Autodesk.ACC.AccountAdmin.accounts.item.companies.item collection

public WithCompanyItemRequestBuilder this[Guid position] { get; }

Parameters

position Guid

The company id.

Property Value

WithCompanyItemRequestBuilder

A WithCompanyItemRequestBuilder

this[string]

Gets an item from the Autodesk.ACC.AccountAdmin.accounts.item.companies.item collection

[Obsolete("This indexer is deprecated and will be removed in the next major version. Use the one with the typed parameter instead.")]
public WithCompanyItemRequestBuilder this[string position] { get; }

Parameters

position string

The company id.

Property Value

WithCompanyItemRequestBuilder

A WithCompanyItemRequestBuilder

Methods

GetAsCompaniesGetResponseAsync(Action<RequestConfiguration<CompaniesRequestBuilderGetQueryParameters>>?, CancellationToken)

Private Use - Returns a list of companies in an account. Can return up to 200 companies per request.

public Task<CompaniesGetResponse?> GetAsCompaniesGetResponseAsync(Action<RequestConfiguration<CompaniesRequestBuilder.CompaniesRequestBuilderGetQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

requestConfiguration Action<RequestConfiguration<CompaniesRequestBuilder.CompaniesRequestBuilderGetQueryParameters>>

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

cancellationToken CancellationToken

Cancellation token to use when cancelling requests

Returns

Task<CompaniesGetResponse>

A CompaniesGetResponse

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

Error

When receiving a 410 status code

Error

When receiving a 500 status code

Error

When receiving a 503 status code

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

Private Use - Returns a list of companies in an account. Can return up to 200 companies per request.

[Obsolete("This method is obsolete. Use GetAsCompaniesGetResponseAsync instead.")]
public Task<CompaniesResponse?> GetAsync(Action<RequestConfiguration<CompaniesRequestBuilder.CompaniesRequestBuilderGetQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

requestConfiguration Action<RequestConfiguration<CompaniesRequestBuilder.CompaniesRequestBuilderGetQueryParameters>>

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

cancellationToken CancellationToken

Cancellation token to use when cancelling requests

Returns

Task<CompaniesResponse>

A CompaniesResponse

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

Error

When receiving a 410 status code

Error

When receiving a 500 status code

Error

When receiving a 503 status code

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

Private Use - Create a company in an account.

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

Parameters

body Company

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

A Company

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 410 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<CompaniesRequestBuilderGetQueryParameters>>?)

Private Use - Returns a list of companies in an account. Can return up to 200 companies per request.

public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<CompaniesRequestBuilder.CompaniesRequestBuilderGetQueryParameters>>? requestConfiguration = null)

Parameters

requestConfiguration Action<RequestConfiguration<CompaniesRequestBuilder.CompaniesRequestBuilderGetQueryParameters>>

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

Returns

RequestInformation

A Microsoft.Kiota.Abstractions.RequestInformation

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

Private Use - Create a company in an account.

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

Parameters

body Company

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

Parameters

rawUrl string

The raw URL to use for the request builder.

Returns

CompaniesRequestBuilder

A CompaniesRequestBuilder