Namespace Autodesk.ACC.Issues.Models
Classes
- CreateIssueDefinition_assignedTo
The Autodesk ID of the member, role or company you want to assign to the issue. Note that if you select an assignee ID, you also need to select a type (
assignedToType
). We do not currently provide endpoints to programmatically find the member, role, or company IDs that you are permitted to assign to the issue. We recommend using the Data Connector API to extract the permitted IDs. See theRetrieve Available Members Roles and Companies </en/docs/acc/v1/tutorials/issues/retrieve-available-members-roles-companies>
_ tutorial for more details. Note that if an assigner with Manage Issues permissions attempts to assign the issue to an invalid Autodesk ID the call will still complete successfully.
- CreateIssueDefinition_status
The current status of the issue, should be set only to an Active status.To get all active statuses within the project, call GET users/me </en/docs/acc/v1/reference/http/issues-me-GET> and check the issue.new.permittedStatuses list.
- CreateIssueDefinition_watchers
The Autodesk ID of the member you want to assign as a watcher for the issue. We do not currently provide endpoints to programmatically find the member IDs that you are permitted to assign as watchers for the issue. We recommend using the Data Connector API to extract the permitted IDs. See the
Retrieve Available Members </en/docs/acc/v1/tutorials/issues/retrieve-available-members-roles-companies>
_ tutorial for more details. Note that if a user with Manage Issues permissions attempts to assign an issue watcher to an invalid Autodesk ID the call will still complete successfully.
- CustomAttributeDefinition_value
Custom attribute value. Possible value types:
string
,number
,null
.
- ErrorResponseDefinition
The response in case of an error
- IssueAttributeDefinitionDefinition
The results object.
- IssueAttributeDefinitionDefinition_metadata
The metadata object; only relevant for
list
custom attributes.
- IssueAttributeDefinitionDefinition_metadata_list
The list object.
- IssueDefinition_gpsCoordinates
A GPS Coordinate which represents the geo location of the issue.
- IssueDefinition_linkedDocuments_details
Information about the individual viewable.
- IssueDefinition_linkedDocuments_details_position
The position of the pushpin in the viewable.
- IssueDefinition_linkedDocuments_details_viewable
The individual viewable associated with the issue (pushpin). This is relevant for both individual 2D sheets and views within a 3D model, and individual PDF sheets within a multi-sheet PDF file. It is only relevant if the issue is associated with a file.
- IssueDefinition_linkedDocuments_details_viewerState
The viewer state at the time the pushpin was created. Maximum length: 2,500,000 characters. You can get the viewer state object by calling ViewerState.getState(). To restore the viewer instance use ViewerState.restoreState(). See the
Viewer API documentation https://developer.autodesk.com/en/docs/viewer/v2/reference/javascript/viewerstate/
_ for more details.
- IssueDefinition_permittedActions
The list of actions permitted for the user for this issue in its current state.Note that if a user with Create for my company permissions attempts to assign a user from a another company to the issue, it will return an error.Possible Values:
assign_all
(can assign another user from another company to the issue),assign_same_company
(can only assign another user from the same company to the issue),clear_assignee
,delete
,add_comment
,add_attachment
,remove_attachment
.The following values are not relevant:add_attachment
,remove_attachment
.
- IssuesDefinition_pagination
The pagination object defining the limit, offset, total number of issues, next and previous URL
- PaginationMetaDefinition
The pagination object.
- UpdateIssueDefinition_assignedTo
The Autodesk ID of the member, role, or company you want to assign to the issue. Note that if you select an assignee ID, you also need to select a type (
assignedToType
).We do not currently provide endpoints to programmatically find the member, role, or company IDs that you are permitted to assign to the issue. We recommend using the Data Connector API to extract the permitted IDs. See theRetrieve Available Members Roles and Companies </en/docs/acc/v1/tutorials/issues/retrieve-available-members-roles-companies>
_ tutorial for more details.Note that if an assigner with Manage Issues permissions attempts to assign the issue to an invalid Autodesk ID the call will still complete successfully.
- UpdateIssueDefinition_status
The current status of the issue, should be set only to an Active status. To get all active statuses within the project, call GET users/me </en/docs/acc/v1/reference/http/issues-me-GET> and check the issue.new.permittedStatuses list.
- UpdateIssueDefinition_watchers
The Autodesk ID of the member you want to assign as a watcher for the issue.We do not currently provide endpoints to programmatically find the member IDs that you are permitted to assign as watchers for the issue. We recommend using the Data Connector API to extract the permitted IDs. See the
Retrieve Available Members </en/docs/acc/v1/tutorials/issues/retrieve-available-members-roles-companies>
_ tutorial for more details.Note that if a user with Manage Issues permissions attempts to assign an issue watcher to an invalid Autodesk ID the call will still complete successfully.
- UsersMeDefinition_issues_filter
Contains filtering restrictions
- UsersMeDefinition_issues_new
If this object appears in the response, it indicates that the user can create and modify issues.
Enums
- CustomAttributeDefinition_type
The type of attribute. Possible values:
numeric
,paragraph
,list
(this corresponds todropdown
in the UI),text
.
- IssueAttributeDefinitionDefinition_dataType
The type of custom attribute. Possible values:
list
,text
,paragraph
,numeric
.
- IssueAttributeMappingDefinition_mappedItemType
The type of item the custom attribute is mapped to.Possible values:
issueType
- this corresponds toIssue Category
in the UI.issueSubtype
- this corresponds toIssue Type
in the UI.Note thatissueSubtype
's inheritissueType
's.
- IssueDefinition_linkedDocuments_type
The type of file. Possible values:
TwoDVectorPushpin
(3D models)TwoDRasterPushpin
(2D sheets and views)
- IssueDefinition_status
The current status of the issue.Possible values:
draft
,open
,pending
,in_progress
,completed
,in_review
,not_approved
,in_dispute
,closed
.