capabilities.work

Open, Comment On, and Close a BIM 360 Issue

A 5-step recipe with Autodesk. We can help you get access.

Recipe · 5 steps

Open, Comment On, and Close a BIM 360 Issue

with Autodesk · Construction Quality Management

Take a BIM 360 quality issue from open to closed with an audit trail.

  1. List the issue types and subtypes configured in the container. Both ids are container-scoped, so an issue cannot be created without resolving them first.
  2. Create the issue against the resolved type and subtype, pinned to the target model and assigned to a user. The issues API speaks JSON:API.
  3. Comment on the issue. Comments are the audit trail an integration writes back when field context arrives from another system.
  4. Close the issue with an answer recording how it was resolved. Patching status alone without an answer leaves the record unexplained.
  5. Read the issue back to confirm it is closed and that the comment was recorded against it.
What you'll need to have ready
  • containerId: The issues container id for the BIM 360 project.
  • title: Short title of the issue.
  • description: Full description of what was observed.
  • assignedTo: The Autodesk id of the user the issue is assigned to.
  • dueDate: Due date for the issue (YYYY-MM-DD).
  • priority: Issue priority.
  • locationDescription: Where in the building the issue was observed.
  • targetUrn: URN of the model or sheet the issue is pinned to.
  • commentBody: The comment to add to the issue.
  • resolution: The answer recorded when the issue is closed.
For your developer

Arazzo workflow autodesk:triage-quality-issue, 5 operations: getIssueTypes → postIssuesV1ContainersByContainerIdQualityIssues → createIssueComment → updateIssue → getIssue. Specs on APIs.io.