Table of Contents

Class CostItemsRequestBuilder.CostItemsRequestBuilderGetQueryParameters

Namespace
Autodesk.ACC.CostManagement.V1.Projects.Item.CostItems
Assembly
Autodesk.ACC.CostManagement.dll

Lists all the cost items in a specified project.

public class CostItemsRequestBuilder.CostItemsRequestBuilderGetQueryParameters
Inheritance
CostItemsRequestBuilder.CostItemsRequestBuilderGetQueryParameters
Inherited Members

Properties

FilterbudgetId

The ID of the budget. Separate multiple IDs with commas. For example, filter[budgetId]=id1,id2, or filter these items that are not linked to any budget filter[budgetId]=blank.

[QueryParameter("filter%5BbudgetId%5D")]
public string[]? FilterbudgetId { get; set; }

Property Value

string[]

FilterbudgetStatus

The status code. Separate multiple codes with commas. For example, filter[budgetStatus]=draft,open.

[QueryParameter("filter%5BbudgetStatus%5D")]
public string[]? FilterbudgetStatus { get; set; }

Property Value

string[]

FilterchangeOrderId

The change order ID. Separate multiple IDs with commas. For example,filter[changeOrderId]=id1,id2.

[QueryParameter("filter%5BchangeOrderId%5D")]
public string[]? FilterchangeOrderId { get; set; }

Property Value

string[]

FiltercontractId

The Contract ID. Separate multiple IDs with commas. For example, filter[contractId]=id1,id2, or filter these items that are not linked to any contract filter[contractId]=blank.

[QueryParameter("filter%5BcontractId%5D")]
public string[]? FiltercontractId { get; set; }

Property Value

string[]

FiltercostStatus

The status code. Separate multiple codes with commas. For example, filter[costStatus]=draft,open.

[QueryParameter("filter%5BcostStatus%5D")]
public string[]? FiltercostStatus { get; set; }

Property Value

string[]

FilterexternalId

The ID of the item in its original external system. This ID can be used to track the source of truth or to look up the data in an integrated system. Separate multiple IDs with commas. For example, filter[externalId]=id1,id2.

[QueryParameter("filter%5BexternalId%5D")]
public string[]? FilterexternalId { get; set; }

Property Value

string[]

FilterexternalSystem

The name of the external system. This name can be used to track the source of truth or to search in an integrated system. For example, filter[externalSystem]=Sage300.

[QueryParameter("filter%5BexternalSystem%5D")]
public string? FilterexternalSystem { get; set; }

Property Value

string

Filterid

The item's primary identifier. Separate multiple IDs with commas. For example, filter[id]=id1,id2.

[QueryParameter("filter%5Bid%5D")]
public string[]? Filterid { get; set; }

Property Value

string[]

FilterlastModifiedSince

Retrieves items that were modified from the specified date and time, in the following format, YYYY-MM-DDThh:mm:ss.sz. For example, filter[lastModifiedSince]=2020-03-01T13:00:00Z.

[QueryParameter("filter%5BlastModifiedSince%5D")]
public string? FilterlastModifiedSince { get; set; }

Property Value

string

Filternumber

The item's number. For example, filter[number]=0001,0002.

[QueryParameter("filter%5Bnumber%5D")]
public string[]? Filternumber { get; set; }

Property Value

string[]

Include

Include nested resources in the response. For example, include=changeOrders will return the related change orders with the cost item. include=attributes will return custom attributes which represents the "properties" in the response. Possible values: budget, changeOrders, subCostItems, attributes.

[QueryParameter("include")]
public string[]? Include { get; set; }

Property Value

string[]

InternalLimit

The maximum number of items to return, this is for internal use, and the default maximum internal limit is 5000.

[QueryParameter("internalLimit")]
public int? InternalLimit { get; set; }

Property Value

int?

Limit

The maximum number of items to return, default maximum limit is 100.

[QueryParameter("limit")]
public int? Limit { get; set; }

Property Value

int?

Offset

The number of items to skip before starting to collect the result set.

[QueryParameter("offset")]
public int? Offset { get; set; }

Property Value

int?

Q

The conditions to query against items, such as id=0 or (id>2 and id<4). This parameter is deprecated in favor of the filter[] based syntax.

[QueryParameter("q")]
public string? Q { get; set; }

Property Value

string

Scope

The scope of the cost item, usually by change order type.

[Obsolete("This property is deprecated, use ScopeAsGetScopeQueryParameterType instead")]
[QueryParameter("scope")]
public string? Scope { get; set; }

Property Value

string

ScopeAsGetScopeQueryParameterType

The scope of the cost item, usually by change order type.

[QueryParameter("scope")]
public GetScopeQueryParameterType? ScopeAsGetScopeQueryParameterType { get; set; }

Property Value

GetScopeQueryParameterType?

Sort

The sort order for items. Each attribute can be sorted in either asc (default) or desc order. For example, sort=name, updatedAt desc or sort=name + updatedAt desc sorts the results first by name in ascending order, then by date updated in descending order.

[QueryParameter("sort")]
public string? Sort { get; set; }

Property Value

string
Edit this page