Class UsersRequestBuilder.UsersRequestBuilderGetQueryParameters
Retrieves information about all the users in a project. To get information about all the users in an account, see GET accounts/users </en/docs/bim360/v1/reference/http/users-GET/>_.
public class UsersRequestBuilder.UsersRequestBuilderGetQueryParameters- Inheritance
-
UsersRequestBuilder.UsersRequestBuilderGetQueryParameters
- Inherited Members
Properties
Fields
List of fields to return in the response. Defaults to all fields. Valid list of fields are name, email, firstName, lastName, autodeskId, analyticsId, addressLine1, addressLine2, city, stateOrProvince, postalCode, country, imageUrl, phone, jobTitle, industry, aboutMe, companyId, accessLevels, roleIds, services, status, addedOn and products.
[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 name, email, firstName, lastName, autodeskId, analyticsId, addressLine1, addressLine2, city, stateOrProvince, postalCode, country, imageUrl, phone, jobTitle, industry, aboutMe, companyId, accessLevels, roleIds, services, status, addedOn and products.
[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
FilteraccessLevels
Filter project users by access level. Possible values are accountAdmin, projectAdmin and executive. For example filter[accessLevels]=accountAdmin,executive.
[Obsolete("This property is deprecated, use FilteraccessLevelsAsGetFilterAccessLevelsQueryParameterType instead")]
[QueryParameter("filter%5BaccessLevels%5D")]
public string[]? FilteraccessLevels { get; set; }Property Value
- string[]
FilteraccessLevelsAsGetFilterAccessLevelsQueryParameterType
Filter project users by access level. Possible values are accountAdmin, projectAdmin and executive. For example filter[accessLevels]=accountAdmin,executive.
[QueryParameter("filter%5BaccessLevels%5D")]
public GetFilterAccessLevelsQueryParameterType[]? FilteraccessLevelsAsGetFilterAccessLevelsQueryParameterType { get; set; }Property Value
FilterautodeskId
Filter project users by one or several Autodesk ids. For example filter[autodeskId]=LR3JVSFPDEAB, ....
[QueryParameter("filter%5BautodeskId%5D")]
public string[]? FilterautodeskId { get; set; }Property Value
- string[]
FiltercompanyId
Filter project users by company id or for null values. For examplefilter[companyId]=003e1a66-6775-4045-b3cc-cf0e614ff7b5 or filter[companyId]=.
[QueryParameter("filter%5BcompanyId%5D")]
public string? FiltercompanyId { get; set; }Property Value
Filteremail
Filter project users by email. Can be a partial match based on the value of filterTextMatch provided.
[QueryParameter("filter%5Bemail%5D")]
public string? Filteremail { get; set; }Property Value
Filterid
Filter project users 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 users who are members of the list of Autodesk groups. For example filter[memberGroupId]=3456542.
[QueryParameter("filter%5BmemberGroupId%5D")]
public string[]? FiltermemberGroupId { get; set; }Property Value
- string[]
Filtername
Filter project users 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
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
FilterroleId
Filter project users by role id. For example filter[roleId]=883e1a66-6775-4045-b3cc-cf0e614ff7b5.
[QueryParameter("filter%5BroleId%5D")]
public Guid? FilterroleId { get; set; }Property Value
- Guid?
FilterserviceNames
Filter project users by the services they have access to. Valid values are costManagement, designCollaboration, documentManagement, fieldManagement, assets, workshopxr,insight, modelCoordination, projectAdministration, projectManagement, 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, projectAdministration, projectManagement, field, glue and plan. For example filter[serviceNames]=glue,plan,sheets.
[QueryParameter("filter%5BserviceNames%5D")]
public GetFilterServiceNamesQueryParameterType[]? FilterserviceNamesAsGetFilterServiceNamesQueryParameterType { get; set; }Property Value
Filterstatus
Filter project users by their status. Valid values are active, pending, disabled and deleted. Defaults to active, pending and disabled.
[Obsolete("This property is deprecated, use FilterstatusAsGetFilterStatusQueryParameterType instead")]
[QueryParameter("filter%5Bstatus%5D")]
public string[]? Filterstatus { get; set; }Property Value
- string[]
FilterstatusAsGetFilterStatusQueryParameterType
Filter project users by their status. Valid values are active, pending, disabled and deleted. Defaults to active, pending and disabled.
[QueryParameter("filter%5Bstatus%5D")]
public GetFilterStatusQueryParameterType[]? FilterstatusAsGetFilterStatusQueryParameterType { 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 id, name, email, autodeskId, status and accessLevels.
[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 id, name, email, autodeskId, status and accessLevels.
[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 ascending (asc) or descending (desc). Possible values: name, email, firstName, lastName, addressLine1, addressLine2, city, stateOrProvince, postalCode, country and addedOn. 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 ascending (asc) or descending (desc). Possible values: name, email, firstName, lastName, addressLine1, addressLine2, city, stateOrProvince, postalCode, country and addedOn. Default sort is name.
[QueryParameter("sort")]
public GetSortQueryParameterType[]? SortAsGetSortQueryParameterType { get; set; }