BIM360 Issues API Field Guide
This field guide describes the key attributes of the BIM 360 Issues service and shows how they work together. It also provides key concepts to help you successfully use the Issues API. You should already be familiar with the Issues service. For more informtion, see the BIM 360 Issues Overview.
Note that the BIM 360 Issues API is not compatible with ACC projects. Use the ACC API for ACC projects.
The Autodesk BIM 360 Issues API creates and updates issues in your BIM 360 projects. An issue is an item that is created in BIM 360 for tracking, managing and communicating problems and other points of concern through to resolution. You can manage different types of issues, such as design, safety, and commissioning.
The Issues API includes the following features:
- Create and update project-related BIM 360 issues.
- Retrieve a user’s basic issue permissions.
- Retrieve issue project settings, such as custom attribute (field) definitions and mappings, issue types, and root cause categories.
- Add and retrieve issue comments.
- Update issue statuses (draft/open/answered/closed).
- Retrieve and create attachments.
Issue Entities
Below are a list of key Issue entities that would help you understand the Issues Api:
Entity | Definition |
---|---|
Due date | The timestamp of the issue’s specified due date |
Assignee | Users can always view issues that they created or are assigned to them. They can be assigned either directly or because an issue was assigned to their role or company. Issues cannot be assigned to more than one specific individual. |
Issue Type | Each issue on a project can be labeled with an issue type. Each type is organized under an issue category. This makes sorting and filtering issues easier. |
Root Cause | When working with issues, understanding root causes helps prevent them from recurring. Root causes fall under categories, which helps you find and filter root causes. |
Comment | Each issue on a project has its own comments section where information can be shared. |
Attachment | An issue can be associated with documents such as PDFs, photos, or RVT files. |
Status | The current status of the issue. Possible values: draft , open , work_complete , ready_to_inspect , not_approved , closed , in_dispute , void . |
Custom Attributes | Custom attributes can be added to issue types or to subtypes for issue entries beyond the default attributes. |
Location | Locations appear in issue reports exported from your project, and you are can filter issues by location as well. |
Permissions | Permissions can be assigned to individual team members or applied to them through their roles or companies. |
Limitations
The following list details known limitations for the BIM 360 Issues API release:
- Currently, you can only check permissions for the “current” user. You cannot retrieve permission levels for all users.
- We do not support endpoints that configure permissions.
- We do not support endpoints that configure issue types or custom attributes.
- When creating issues,
assignTo
does not validate the input string. Any string is accepted. We recommend using the GET project users endpoint to get a list of valid project member IDs. - We do not currently support retrieving issue activities.
- We do not currently expose webhooks for issues.
In order to read or create references with RFIs or assets, use the Relationships API.