Class SegmentsRequestBuilder

Namespace

Autodesk.ACC.CostManagement.V1.Projects.Item.Templates.Item.Segments

Assembly

Autodesk.ACC.CostManagement.dll

Builds and executes requests for operations under \v1\projects{projectId}\templates{templateId}\segments

public class SegmentsRequestBuilder : BaseRequestBuilder

Inheritance

object

BaseRequestBuilder

SegmentsRequestBuilder

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

SegmentsRequestBuilder(Dictionary<string, object>, IRequestAdapter)

Instantiates a new SegmentsRequestBuilder and sets the default values.

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

SegmentsRequestBuilder(string, IRequestAdapter)

Instantiates a new SegmentsRequestBuilder and sets the default values.

public SegmentsRequestBuilder(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.CostManagement.v1.projects.item.templates.item.segments.item collection

public WithSegmentItemRequestBuilder this[Guid position] { get; }

Parameters

position Guid

The segment ID. To obtain a segment ID, use GET templates/:templateId/segments </en/docs/bim360/v1/reference/http/cost-segments-GET/>_.

Property Value

WithSegmentItemRequestBuilder

A WithSegmentItemRequestBuilder

this[string]

Gets an item from the Autodesk.ACC.CostManagement.v1.projects.item.templates.item.segments.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 WithSegmentItemRequestBuilder this[string position] { get; }

Parameters

position string

The segment ID. To obtain a segment ID, use GET templates/:templateId/segments </en/docs/bim360/v1/reference/http/cost-segments-GET/>_.

Property Value

WithSegmentItemRequestBuilder

A WithSegmentItemRequestBuilder

Methods

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

Retrieves all the segments in a budget code template.

public Task<SegmentListResponse?> GetAsync(Action<RequestConfiguration<SegmentsRequestBuilder.SegmentsRequestBuilderGetQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

requestConfiguration Action<RequestConfiguration<SegmentsRequestBuilder.SegmentsRequestBuilderGetQueryParameters>>

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

cancellationToken CancellationToken

Cancellation token to use when cancelling requests

Returns

Task<SegmentListResponse>

A SegmentListResponse

Exceptions

DefinedError

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 500 status code

Error

When receiving a 503 status code

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

Creates a new segment in the budget code template.

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

Parameters

body SegmentCreate

The segment composing the budget code. For example, Job Number, CSI, Cost Type.

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

A Segment

Exceptions

DefinedError

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 500 status code

Error

When receiving a 503 status code

PutAsync(SegmentsPutRequestBody, Action<RequestConfiguration<DefaultQueryParameters>>?, CancellationToken)

Updates the segments in a specific budget code template, currently only to re-order the positions.

public Task<List<Segment>?> PutAsync(SegmentsPutRequestBody body, Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null, CancellationToken cancellationToken = default)

Parameters

body SegmentsPutRequestBody

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<List<Segment>>

A List<global::Autodesk.ACC.CostManagement.Models.Segment>

Exceptions

DefinedError

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 500 status code

Error

When receiving a 503 status code

ToGetRequestInformation(Action<RequestConfiguration<SegmentsRequestBuilderGetQueryParameters>>?)

Retrieves all the segments in a budget code template.

public RequestInformation ToGetRequestInformation(Action<RequestConfiguration<SegmentsRequestBuilder.SegmentsRequestBuilderGetQueryParameters>>? requestConfiguration = null)

Parameters

requestConfiguration Action<RequestConfiguration<SegmentsRequestBuilder.SegmentsRequestBuilderGetQueryParameters>>

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

Returns

RequestInformation

A Microsoft.Kiota.Abstractions.RequestInformation

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

Creates a new segment in the budget code template.

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

Parameters

body SegmentCreate

The segment composing the budget code. For example, Job Number, CSI, Cost Type.

requestConfiguration Action<RequestConfiguration<DefaultQueryParameters>>

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

Returns

RequestInformation

A Microsoft.Kiota.Abstractions.RequestInformation

ToPutRequestInformation(SegmentsPutRequestBody, Action<RequestConfiguration<DefaultQueryParameters>>?)

Updates the segments in a specific budget code template, currently only to re-order the positions.

public RequestInformation ToPutRequestInformation(SegmentsPutRequestBody body, Action<RequestConfiguration<DefaultQueryParameters>>? requestConfiguration = null)

Parameters

body SegmentsPutRequestBody

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

Parameters

rawUrl string

The raw URL to use for the request builder.

Returns

SegmentsRequestBuilder

A SegmentsRequestBuilder