Class ProjectsRequestBuilder.ProjectsRequestBuilderGetQueryParameters
Private Use - Returns a list of projects in an account. Can return up to 200 projects per request. Will only return the list of projects that the user has access to. If the user is an account admin then all projects will be returned otherwise only projects that the user participates in will be returned
public class ProjectsRequestBuilder.ProjectsRequestBuilderGetQueryParameters- Inheritance
-
ProjectsRequestBuilder.ProjectsRequestBuilderGetQueryParameters
- Inherited Members
Properties
Fields
List of fields to return in the response. Defaults to all fields. Valid list of fields are accountId, addressLine1, addressLine2, adminGroupId, businessUnitId, city, companyCount, constructionType, country, createdAt, deliveryMethod, endDate, imageUrl, isAcsUnified, jobNumber, lastSignIn, latitude, longitude, memberCount, memberGroupId, name, platform, postalCode, products, projectSize, projectValue, services, sheetCount,startDate, stateOrProvince, status, thumbnailImageUrl, timezone, type and updatedAt.
[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, addressLine1, addressLine2, adminGroupId, businessUnitId, city, companyCount, constructionType, country, createdAt, deliveryMethod, endDate, imageUrl, isAcsUnified, jobNumber, lastSignIn, latitude, longitude, memberCount, memberGroupId, name, platform, postalCode, products, projectSize, projectValue, services, sheetCount,startDate, stateOrProvince, status, thumbnailImageUrl, timezone, type and updatedAt.
[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
FilterbusinessUnitId
Filter the projects by Business Unit id.
[QueryParameter("filter%5BbusinessUnitId%5D")]
public Guid? FilterbusinessUnitId { get; set; }Property Value
- Guid?
FilterdataServiceId
Find the project associated to the provided data service identifier.
[QueryParameter("filter%5BdataServiceId%5D")]
public Guid? FilterdataServiceId { get; set; }Property Value
- Guid?
FilterjobNumber
Filter projects by job number. Can be a partial match based on the value of filterTextMatch provided.
[QueryParameter("filter%5BjobNumber%5D")]
public string? FilterjobNumber { get; set; }Property Value
Filtername
Filter projects 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
Filterplatform
Filter resource by platform. Valid values are acc and bim360.
[Obsolete("This property is deprecated, use FilterplatformAsGetFilterPlatformQueryParameterType instead")]
[QueryParameter("filter%5Bplatform%5D")]
public string[]? Filterplatform { get; set; }Property Value
- string[]
FilterplatformAsGetFilterPlatformQueryParameterType
Filter resource by platform. Valid values are acc and bim360.
[QueryParameter("filter%5Bplatform%5D")]
public GetFilterPlatformQueryParameterType[]? FilterplatformAsGetFilterPlatformQueryParameterType { get; set; }Property Value
Filterproducts
Filter resource by provided list of products. Valid values are assets, build, capitalPlanning, cost, costManagement, designCollaboration, docs, documentManagement, field, fieldManagement, financials, glue,workshopxr, insight, modelCoordination, plan, projectAdministration, projectManagement, quantification, and takeoff.
[Obsolete("This property is deprecated, use FilterproductsAsGetFilterProductsQueryParameterType instead")]
[QueryParameter("filter%5Bproducts%5D")]
public string[]? Filterproducts { get; set; }Property Value
- string[]
FilterproductsAsGetFilterProductsQueryParameterType
Filter resource by provided list of products. Valid values are assets, build, capitalPlanning, cost, costManagement, designCollaboration, docs, documentManagement, field, fieldManagement, financials, glue,workshopxr, insight, modelCoordination, plan, projectAdministration, projectManagement, quantification, and takeoff.
[QueryParameter("filter%5Bproducts%5D")]
public GetFilterProductsQueryParameterType[]? FilterproductsAsGetFilterProductsQueryParameterType { get; set; }Property Value
FilterserviceName
Filter the list of projects based on the provided service. Valid values include documentManagement, projectManagement, costManagement, quantification, designCollaboration, fieldManagement, assets, workshopxr, insight,modelCoordination, documents, sheets, field, glue and plan.
[Obsolete("This property is deprecated, use FilterserviceNameAsGetFilterServiceNameQueryParameterType instead")]
[QueryParameter("filter%5BserviceName%5D")]
public string? FilterserviceName { get; set; }Property Value
FilterserviceNameAsGetFilterServiceNameQueryParameterType
Filter the list of projects based on the provided service. Valid values include documentManagement, projectManagement, costManagement, quantification, designCollaboration, fieldManagement, assets, workshopxr, insight,modelCoordination, documents, sheets, field, glue and plan.
[QueryParameter("filter%5BserviceName%5D")]
public GetFilterServiceNameQueryParameterType? FilterserviceNameAsGetFilterServiceNameQueryParameterType { get; set; }Property Value
FilterserviceNames
Filter project users by the services they have access to. Valid values are costManagement, designCollaboration, documentManagement, fieldManagement, assets,workshopxr, insight, modelCoordination, accountAdministration, projectAdministration, projectManagement, projectHome, documents, sheets, field, glue and plan. For example filter[serviceNames]=glue,plan,sheets.
[Obsolete("This property is deprecated, use FilterserviceNamesAsGetFilterServiceNamesQueryParameterType instead")]
[QueryParameter("filter%5BserviceNames%5D")]
public string[]? FilterserviceNames { get; set; }Property Value
- string[]
FilterserviceNamesAsGetFilterServiceNamesQueryParameterType
Filter project users by the services they have access to. Valid values are costManagement, designCollaboration, documentManagement, fieldManagement, assets,workshopxr, insight, modelCoordination, accountAdministration, projectAdministration, projectManagement, projectHome, documents, sheets, field, glue and plan. For example filter[serviceNames]=glue,plan,sheets.
[QueryParameter("filter%5BserviceNames%5D")]
public GetFilterServiceNamesQueryParameterType[]? FilterserviceNamesAsGetFilterServiceNamesQueryParameterType { get; set; }Property Value
Filtersource
Filter the list of projects based on the source system it was created for. Can be an the value acsUnified or empty.
[Obsolete("This property is deprecated, use FiltersourceAsGetFilterSourceQueryParameterType instead")]
[QueryParameter("filter%5Bsource%5D")]
public string[]? Filtersource { get; set; }Property Value
- string[]
FiltersourceAsGetFilterSourceQueryParameterType
Filter the list of projects based on the source system it was created for. Can be an the value acsUnified or empty.
[QueryParameter("filter%5Bsource%5D")]
public GetFilterSourceQueryParameterType[]? FiltersourceAsGetFilterSourceQueryParameterType { get; set; }Property Value
Filterstatus
Filter the list of projects based on the provided statuses. Can be an array of values including active, pending, archived and suspended.
[Obsolete("This property is deprecated, use FilterstatusAsGetFilterStatusQueryParameterType instead")]
[QueryParameter("filter%5Bstatus%5D")]
public string[]? Filterstatus { get; set; }Property Value
- string[]
FilterstatusAsGetFilterStatusQueryParameterType
Filter the list of projects based on the provided statuses. Can be an array of values including active, pending, archived and suspended.
[QueryParameter("filter%5Bstatus%5D")]
public GetFilterStatusQueryParameterType[]? FilterstatusAsGetFilterStatusQueryParameterType { get; set; }Property Value
Filtertype
Filter projects by type. To exclude a type, prefix with a hyphen -. GET v1/accounts/:a_id/project-types lists all possible project types.
[QueryParameter("filter%5Btype%5D")]
public string[]? Filtertype { get; set; }Property Value
- string[]
FilterupdatedAt
Filter the list of projects by a range of dates when the project was last updated at. 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?
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, startDate, endDate, type, status, jobNumber, constructionType, deliveryMethod, contractType, currentPhase, companyCount, memberCount, 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, startDate, endDate, type, status, jobNumber, constructionType, deliveryMethod, contractType, currentPhase, companyCount, memberCount, createdAt and updatedAt. Default sort is name.
[QueryParameter("sort")]
public GetSortQueryParameterType[]? SortAsGetSortQueryParameterType { get; set; }