Class BudgetsRequestBuilder.BudgetsRequestBuilderGetQueryParameters
- Assembly
- Autodesk.ACC.CostManagement.dll
Returns all the budgets in a specific project.
public class BudgetsRequestBuilder.BudgetsRequestBuilderGetQueryParameters
- Inheritance
-
BudgetsRequestBuilder.BudgetsRequestBuilderGetQueryParameters
- Inherited Members
Properties
Filtercode
The item's codes. For example, filter[code]=01,02
. The code in number format needs to be enclosed in double quotes if you do filter like filter[code]="1" / filter[code]="122.221"
.
[QueryParameter("filter%5Bcode%5D")]
public string[]? Filtercode { 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
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
FilterrootId
Query related sub-items for the given root item ID. Separate multiple IDs with commas. For example, filter[rootId]=id1,id2
.
[QueryParameter("filter%5BrootId%5D")]
public string[]? FilterrootId { get; set; }
Property Value
- string[]
Include
Include nested resources in the response. For example, include=subitems
will return the sub budget items. include=attributes
will return custom attributes which represents the "properties" in the response. Possible values: subitems
, attributes
, contract
, mainContract
, mainContractItem
, segments
.
[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
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; }