Class IssuesRequestBuilder.IssuesRequestBuilderGetQueryParameters
Retrieves information about all the issues in a project, including details about their associated comments and attachments.We support retrieving file-related (pushpin) issues. However, we do not currently support retrieving sheet-related issues from the ACC Build Sheets tool... include:: ../../../../_snippets/not-backward-compatible.rst
public class IssuesRequestBuilder.IssuesRequestBuilderGetQueryParameters- Inheritance
-
IssuesRequestBuilder.IssuesRequestBuilderGetQueryParameters
- Inherited Members
Properties
Fields
Return only specific fields in issue object. Separate multiple values with commas. Fields which will be returned in any case: id, title, status, issueTypeId. Possible values: id, displayId, title, description, issueTypeId, issueSubtypeId, status, assignedTo, assignedToType, dueDate, startDate, locationId, locationDetails, rootCauseTitle, rootCauseId, permittedStatuses, permittedAttributes, permittedActions, published, commentCount, openedBy, openedAt, closedBy, closedAt, createdBy, createdAt, updatedBy, updatedAt, customAttributes.
[Obsolete("This property is deprecated, use FieldsAsGetFieldsQueryParameterType instead")]
[QueryParameter("fields")]
public string[]? Fields { get; set; }Property Value
- string[]
FieldsAsGetFieldsQueryParameterType
Return only specific fields in issue object. Separate multiple values with commas. Fields which will be returned in any case: id, title, status, issueTypeId. Possible values: id, displayId, title, description, issueTypeId, issueSubtypeId, status, assignedTo, assignedToType, dueDate, startDate, locationId, locationDetails, rootCauseTitle, rootCauseId, permittedStatuses, permittedAttributes, permittedActions, published, commentCount, openedBy, openedAt, closedBy, closedAt, createdBy, createdAt, updatedBy, updatedAt, customAttributes.
[QueryParameter("fields")]
public GetFieldsQueryParameterType[]? FieldsAsGetFieldsQueryParameterType { get; set; }Property Value
FilterassignedTo
Filter issues by the unique Autodesk ID of the User/Company/Role identifier of the current assignee of this issue. Separate multiple values with commas. For Example: A3RGM375QTZ7.
[QueryParameter("filter%5BassignedTo%5D")]
public string[]? FilterassignedTo { get; set; }Property Value
- string[]
FilterassignedToType
Filter issues by the type of the current assignee of this issue. Separate multiple values with commas. Possible values: Possible values: user, company, role, null. For Example: user.
[QueryParameter("filter%5BassignedToType%5D")]
public string? FilterassignedToType { get; set; }Property Value
FilterclosedAt
Filter issues closed at the specified date and time, in one of the following URL-encoded formats: YYYY-MM-DDThh:mm:ss.sz or YYYY-MM-DD. Separate multiple values with commas. We support the following filtering options: - Date range: e.g., 2022-03-02..2022-03-03 or 2022-02-28T22:00:00.000Z..2022-03-28T22:00:00.000Z- Specific day: e.g., 2022-03-02 or 2022-02-28T22:00:00.000Z- Specific start date: e.g., 2022-03-02.. or 2022-02-28T22:00:00.000Z..- Specific end date: e.g., ..2022-03-02 or ..2022-02-28T22:00:00.000ZFor more details, see JSON API Filtering <http://jsonapi.org/format/#fetching-filtering>_.
[QueryParameter("filter%5BclosedAt%5D")]
public DateTimeOffset? FilterclosedAt { get; set; }Property Value
FilterclosedBy
Filter issues by the unique identifier of the user who closed the issue. Separate multiple values with commas. For Example: A3RGM375QTZ7.
[QueryParameter("filter%5BclosedBy%5D")]
public string[]? FilterclosedBy { get; set; }Property Value
- string[]
FiltercreatedAt
Filter issues created at the specified date and time, in one of the following URL-encoded formats: YYYY-MM-DDThh:mm:ss.sz or YYYY-MM-DD. Separate multiple values with commas. We support the following filtering options:- Date range: e.g., 2022-03-02..2022-03-03 or 2022-02-28T22:00:00.000Z..2022-03-28T22:00:00.000Z- Specific day: e.g., 2022-03-02 or 2022-02-28T22:00:00.000Z- Specific start date: e.g., 2022-03-02.. or 2022-02-28T22:00:00.000Z..- Specific end date: e.g., ..2022-03-02 or ..2022-02-28T22:00:00.000ZFor more details, see JSON API Filtering <http://jsonapi.org/format/#fetching-filtering>_.
[QueryParameter("filter%5BcreatedAt%5D")]
public DateTimeOffset? FiltercreatedAt { get; set; }Property Value
FiltercreatedBy
Filter issues by the unique identifier of the user who created the issue. Separate multiple values with commas. For Example: A3RGM375QTZ7.
[QueryParameter("filter%5BcreatedBy%5D")]
public string[]? FiltercreatedBy { get; set; }Property Value
- string[]
FiltercustomAttributes
Filter issues by the custom attributes. Each custom attribute filter should be defined by it's uuid. For example: filter[customAttributes][f227d940-ae9b-4722-9297-389f4411f010]=1,2,3. Separate multiple values with commas.
[QueryParameter("filter%5BcustomAttributes%5D")]
public string[]? FiltercustomAttributes { get; set; }Property Value
- string[]
FilterdisplayId
Filter issues by the chronological user-friendly identifier. Separate multiple values with commas.
[QueryParameter("filter%5BdisplayId%5D")]
public int? FilterdisplayId { get; set; }Property Value
- int?
FilterdueDate
Filter issues by due date, in one of the following URL-encoded format: YYYY-MM-DD. Separate multiple values with commas. We support the following filtering options:- Date range: e.g., 2022-03-02..2022-03-03- Specific day: e.g., 2022-03-02- Specific start date: e.g., 2022-03-02..- Specific end date: e.g., ..2022-03-02For more details, see JSON API Filtering <http://jsonapi.org/format/#fetching-filtering>_.
[QueryParameter("filter%5BdueDate%5D")]
public Date? FilterdueDate { get; set; }Property Value
- Date?
Filterid
Filter issues by the unique issue ID. Separate multiple values with commas.
[QueryParameter("filter%5Bid%5D")]
public Guid?[]? Filterid { get; set; }Property Value
- Guid?[]
FilterissueSubtypeId
Filter issues by the unique identifier of the type of the issue. Note that the API name for type is subtype. Separate multiple values with commas.
[QueryParameter("filter%5BissueSubtypeId%5D")]
public Guid?[]? FilterissueSubtypeId { get; set; }Property Value
- Guid?[]
FilterissueTypeId
Filter issues by the unique identifier of the category of the issue. Note that the API name for category is type. Separate multiple values with commas.
[QueryParameter("filter%5BissueTypeId%5D")]
public Guid?[]? FilterissueTypeId { get; set; }Property Value
- Guid?[]
FilterlinkedDocumentUrn
Retrieves pushpin issues associated with the specified files. We support all file types that are compatible with the Files tool. You need to specify the URL-encoded file item IDs. To find the file item IDs, use the Data Management <en/docs/data/v2/developers_guide/overview/>_ API. Note that you need to specify the 3D model item ID, which retrieves all pushpins associated with all 2D sheets and views associated with the 3D model. Similarly, if you specify a specific PDF file it retrieves all the pushpin issues associated with all the PDF file pages. We do not currently support retrieving pushpin issues associated with a specific 2D sheet or view.By default, it returns pushpins for the latest version of the file. To retrieve pushpins for a specific version of a file together with pushpins for all previous versions of the specified file version, specify the version number, in the following format: @[version-number].For example, filter[linkedDocument]=urn%3Aadsk.wipprod%3Adm.lineage%3AtFbo9zuDTW-nPh45gnM4gA@2. Separate multiple values with commas.Note that we do not currently support filtering sheets from the ACC Build Sheets tool.
[QueryParameter("filter%5BlinkedDocumentUrn%5D")]
public string[]? FilterlinkedDocumentUrn { get; set; }Property Value
- string[]
FilterlocationId
Retrieves issues associated with the specified location but not the location's sublocations. To also retrieve issues that relate to the locations's sublocations use the sublocationId filter. Separate multiple values with commas.
[QueryParameter("filter%5BlocationId%5D")]
public Guid?[]? FilterlocationId { get; set; }Property Value
- Guid?[]
Filterpublished
Filter issues by published status (true/false). Default value: undefined (meaning both published and unpublished issues will return).
[QueryParameter("filter%5Bpublished%5D")]
public bool? Filterpublished { get; set; }Property Value
- bool?
FilterrootCauseId
Filter issues by the unique identifier of the type of root cause for the issue. Separate multiple values with commas.
[QueryParameter("filter%5BrootCauseId%5D")]
public Guid?[]? FilterrootCauseId { get; set; }Property Value
- Guid?[]
Filtersearch
Filter issues using 'search' criteria. this will filter both title and issues display ID. For example, use filter[search]=300
[QueryParameter("filter%5Bsearch%5D")]
public string? Filtersearch { get; set; }Property Value
FilterstartDate
Filter issues by start date, in one of the following URL-encoded format: YYYY-MM-DD. Separate multiple values with commas. We support the following filtering options:- Date range: e.g., 2022-03-02..2022-03-03- Specific day: e.g., 2022-03-02- Specific start date: e.g., 2022-03-02..- Specific end date: e.g., ..2022-03-02For more details, see JSON API Filtering <http://jsonapi.org/format/#fetching-filtering>_.
[QueryParameter("filter%5BstartDate%5D")]
public Date? FilterstartDate { get; set; }Property Value
- Date?
Filterstatus
Filter issues by their status. Separate multiple values with commas.
[QueryParameter("filter%5Bstatus%5D")]
public string? Filterstatus { get; set; }Property Value
FiltersubLocationId
Retrieves issues associated with the specified unique LBS (Location Breakdown Structure) identifier, as well as issues associated with the sub locations of the LBS identifier. Separate multiple values with commas.
[QueryParameter("filter%5BsubLocationId%5D")]
public Guid?[]? FiltersubLocationId { get; set; }Property Value
- Guid?[]
FilterupdatedAt
Filter issues updated at the specified date and time, in one of the following URL-encoded formats: YYYY-MM-DDThh:mm:ss.sz or YYYY-MM-DD. Separate multiple values with commas. We support the following filtering options:- Date range: e.g., 2022-03-02..2022-03-03 or 2022-02-28T22:00:00.000Z..2022-03-28T22:00:00.000Z- Specific day: e.g., 2022-03-02 or 2022-02-28T22:00:00.000Z- Specific start date: e.g., 2022-03-02.. or 2022-02-28T22:00:00.000Z..- Specific end date: e.g., ..2022-03-02 or ..2022-02-28T22:00:00.000ZFor more details, see JSON API Filtering <http://jsonapi.org/format/#fetching-filtering>_.
[QueryParameter("filter%5BupdatedAt%5D")]
public DateTimeOffset? FilterupdatedAt { get; set; }Property Value
FilterupdatedBy
Filter issues by the unique identifier of the user who updated the issue. Separate multiple values with commas. For Example: A3RGM375QTZ7.
[QueryParameter("filter%5BupdatedBy%5D")]
public string[]? FilterupdatedBy { get; set; }Property Value
- string[]
Filtervalid
Only return valid issues (=no empty type/subtype). Default value: undefined (meaning will return both valid & invalid issues).
[QueryParameter("filter%5Bvalid%5D")]
public bool? Filtervalid { get; set; }Property Value
- bool?
Filterviewable
JSON-encoded string: array of viewable criteria filters. Each viewable criteria is an object of type {viewableId, guid, name}. Must be provided only with linkedDocumentUrn filter.
[QueryParameter("filter%5Bviewable%5D")]
public string? Filterviewable { get; set; }Property Value
Limit
Return specified number of issues. Acceptable values are 1-100. Default value: 100.
[QueryParameter("limit")]
public int? Limit { get; set; }Property Value
- int?
Offset
Return issues starting from the specified offset number. Default value: 0.
[QueryParameter("offset")]
public int? Offset { get; set; }Property Value
- int?
SortBy
Sort issues by specified fields. Separate multiple values with commas. To sort in descending order add a - (minus sign) before the sort criteria. Possible values: displayId, title, description, status, assignedTo, assignedToType, dueDate, locationDetails, published, closedBy, closedAt, createdBy, createdAt, updatedAt, issueSubType, issueType, customAttributes, startDate, rootCause. For example: sortBy=status,-displayId,-dueDate,customAttributes[5c07cbe2-256a-48f1-b35b-2e5e00914104].
[Obsolete("This property is deprecated, use SortByAsGetSortByQueryParameterType instead")]
[QueryParameter("sortBy")]
public string[]? SortBy { get; set; }Property Value
- string[]
SortByAsGetSortByQueryParameterType
Sort issues by specified fields. Separate multiple values with commas. To sort in descending order add a - (minus sign) before the sort criteria. Possible values: displayId, title, description, status, assignedTo, assignedToType, dueDate, locationDetails, published, closedBy, closedAt, createdBy, createdAt, updatedAt, issueSubType, issueType, customAttributes, startDate, rootCause. For example: sortBy=status,-displayId,-dueDate,customAttributes[5c07cbe2-256a-48f1-b35b-2e5e00914104].
[QueryParameter("sortBy")]
public GetSortByQueryParameterType[]? SortByAsGetSortByQueryParameterType { get; set; }