Class CompaniesRequestBuilder.CompaniesRequestBuilderGetQueryParameters
Private Use - Return a list of companies in a project. Can return up to 200 companies per request.
public class CompaniesRequestBuilder.CompaniesRequestBuilderGetQueryParameters- Inheritance
-
CompaniesRequestBuilder.CompaniesRequestBuilderGetQueryParameters
- Inherited Members
Properties
Fields
List of fields to return in the response. Defaults to all fields. Valid list of fields are accountId, name, trade, addresses, websiteUrl, description, erpId, taxId, imageUrl, status, createdAt, updatedAt, originalName, projectId, memberGroupId and memberCount.
[Obsolete("This property is deprecated, use FieldsAsGetFieldsQueryParameterType instead")]
[QueryParameter("fields")]
public string[]? Fields { get; set; }Property Value
- string[]
FieldsAsGetFieldsQueryParameterType
List of fields to return in the response. Defaults to all fields. Valid list of fields are accountId, name, trade, addresses, websiteUrl, description, erpId, taxId, imageUrl, status, createdAt, updatedAt, originalName, projectId, memberGroupId and memberCount.
[QueryParameter("fields")]
public GetFieldsQueryParameterType[]? FieldsAsGetFieldsQueryParameterType { get; set; }Property Value
FilterTextMatch
When filtering on a text based field this indicates how to do the matching. Valid values are contains, startsWith, endsWith and equals. Default is contains.
[Obsolete("This property is deprecated, use FilterTextMatchAsGetFilterTextMatchQueryParameterType instead")]
[QueryParameter("filterTextMatch")]
public string? FilterTextMatch { get; set; }Property Value
FilterTextMatchAsGetFilterTextMatchQueryParameterType
When filtering on a text based field this indicates how to do the matching. Valid values are contains, startsWith, endsWith and equals. Default is contains.
[QueryParameter("filterTextMatch")]
public GetFilterTextMatchQueryParameterType? FilterTextMatchAsGetFilterTextMatchQueryParameterType { get; set; }Property Value
FiltererpId
Filter companies by ERP Id. Can be a partial match based on the value of filterTextMatch provided.
[QueryParameter("filter%5BerpId%5D")]
public string? FiltererpId { get; set; }Property Value
Filterid
Filter project companies by one or several IDs. For example filter[id]=883e1a66-6775-4045-b3cc-cf0e614ff7b5, ..., ....
[QueryParameter("filter%5Bid%5D")]
public Guid?[]? Filterid { get; set; }Property Value
- Guid?[]
FiltermemberGroupId
Filter project companies by one or several Autodesk id. For example filter[memberGroupId]=O2ID1,O2ID2,....
[QueryParameter("filter%5BmemberGroupId%5D")]
public string[]? FiltermemberGroupId { get; set; }Property Value
- string[]
Filtername
Filter project companies by name. Can be a partial match based on the value of filterTextMatch provided.
[QueryParameter("filter%5Bname%5D")]
public string? Filtername { get; set; }Property Value
FiltertaxId
Filter companies by tax Id. Can be a partial match based on the value of filterTextMatch provided.
[QueryParameter("filter%5BtaxId%5D")]
public string? FiltertaxId { get; set; }Property Value
Filtertrade
Filter project companies by trade. Can be a partial match based on the value of filterTextMatch provided.
[QueryParameter("filter%5Btrade%5D")]
public string? Filtertrade { get; set; }Property Value
FilterupdatedAt
Filter companies by updated at date range. The range must be specified with dates in an ISO-8601 format with time required. The start and end dates of the range should be separated by .. One of the dates in the range may be omitted. For example, to get everything on or before June 1, 2019 the range would be ..2019-06-01T23:59:59.999Z. To get everything after June 1, 2019 the range would be 2019-06-01T00:00:00.000Z...
[QueryParameter("filter%5BupdatedAt%5D")]
public string? FilterupdatedAt { get; set; }Property Value
Limit
The maximum number of records to return in a single request. Possible range: 1-200. Default Can be a number between 1 and 200. Default value: 20. If a number greater than 200 is provided 200 will be returned.
[QueryParameter("limit")]
public int? Limit { get; set; }Property Value
- int?
Offset
The number of records to skip before returning the result records. Increase this value in subsequent requests to continue getting results when the number of records exceeds the requested limit.
[QueryParameter("offset")]
public int? Offset { get; set; }Property Value
- int?
OrFilters
List of filtered fields to apply an "or" operator. Valid list of fields are erpId, id, memberGroupId, name, taxId, trade, updatedAt.
[Obsolete("This property is deprecated, use OrFiltersAsGetOrFiltersQueryParameterType instead")]
[QueryParameter("orFilters")]
public string[]? OrFilters { get; set; }Property Value
- string[]
OrFiltersAsGetOrFiltersQueryParameterType
List of filtered fields to apply an "or" operator. Valid list of fields are erpId, id, memberGroupId, name, taxId, trade, updatedAt.
[QueryParameter("orFilters")]
public GetOrFiltersQueryParameterType[]? OrFiltersAsGetOrFiltersQueryParameterType { get; set; }Property Value
Sort
The list of fields to sort by. When multiple fields are listed the later property is used to sort the resources where the previous fields have the same value. Each property can be followed by a direction modifier of either asc (ascending) or desc (descending). If no direction is specified then asc is assumed. Valid fields for sorting are name, trade, erpId, taxId, status, createdAt and updatedAt. Default sort is name.
[Obsolete("This property is deprecated, use SortAsGetSortQueryParameterType instead")]
[QueryParameter("sort")]
public string[]? Sort { get; set; }Property Value
- string[]
SortAsGetSortQueryParameterType
The list of fields to sort by. When multiple fields are listed the later property is used to sort the resources where the previous fields have the same value. Each property can be followed by a direction modifier of either asc (ascending) or desc (descending). If no direction is specified then asc is assumed. Valid fields for sorting are name, trade, erpId, taxId, status, createdAt and updatedAt. Default sort is name.
[QueryParameter("sort")]
public GetSortQueryParameterType[]? SortAsGetSortQueryParameterType { get; set; }