BIM 360 Issues API Changes

Attention BIM 360 Issues API developers –

Around AU (Autodesk University) time frame, there will be a semantic change introduced to the current BIM 360 Issues API. Field Issues and Document Issues will be consolidated as a single set of Issues; i.e., Field Issues will include Document Issues, and Document Issues will be deprecated.

This change is expected to take place alongside of product’s Issues data migration and UI changes. At AU, you will hear the product team announcing the change and describe the detail. This is a part of enhancement that BIM 360 team is making in the effort to expand Issues functionalities to other modules and to provide a consistent, unified Issues feature.

What does this mean for BIM 360 developer? 

As a BIM 360 developer, first, be aware of the following changes:

  1. The endpoints for Document Issues (/issues/) will be deprecated. (*1)
    i.e., https://developer.api.autodesk.com/issues/v1/containers/:container_id/issues/xxx 

*1) Document Issues endpoints will stop working after April 30, 2019.

2. The endpoints for Field Issues (/quality-issues/) will remain. However, the semantic of Field Issues will be the consolidated Issues after the new unified Issues are introduced.
i.e.,
https://developer.api.autodesk.com/issues/v1/containers/:container_id/quality-issues/yyy

When you call
GET https://developer.api.autodesk.com/issues/v1/containers/:container_id/quality-issues,

you will get a combined list of Document and Field Issues. To distinguish between Document and Field Issues, you will need to check the following attribute value:

data.attributes.ng_issue_type_id = “<issue-type-GUID>”

where you obtain the definition of issue-type-GUID, using the following REST call:

GET https://developer.api.autodesk.com/issues/v1/containers/:container_id/ng-issue-types

This call also returns issue-subtype-GUID.

Document Issues will have ng-issue-type of “Design”. This type should be added to the above call after the change took place.

To obtain a list of Document Issues, you can use a following query parameter:

filter[ng_issue_type_id] = “<issue-type-GUID-for-design>”

To obtain a list of Field Issues, you can to use a concatenated form of all the ng-issue-types except the one for Design:

filter[ng_issue_type_id] = 
    “<issue-type-GUID-for-quality>,<issue-type-GUID-for-safty>,
    <issue-type-GUID-for-punch-list>, … “

Alternatively, you may obtain the entire list, and filter yourself.

Q&A

Below is a list of questions and answers that might help understand the changes further.

Q1. What happens if I keep using POST document-issues or anything that tried to POST/PATCH with document-issues, including command and attachments?

A1. POST will create a new issue with type “Design”. GET issues/issue will return issues only with type “Design”.

Q2. Is there a way for us as a 3rd party developer to get an early hands to test this change?

A2. No. Changes will apply when the product side moves to the new unified Issues. As Issues API itself is relative new (it was released a few month ago), we are not providing test period. Those who we know are using Issues APIs endpoints have been informed about the changes individually.

Q3. What happens to permission and locations. They are different between Document Issues and Field Issues.

A3. New permissions rules will apply to existing Document Issues. As a result, you may notice different set of issues being returned for some users. Create Document Issues will fail if the user has no “Create” or “Full Control” permissions. There will be also “Answered” permit status added. These change will be analogous to the UI.

The documentation should be updated after the change. For more detail, please check here:

https://forge.autodesk.com/en/docs/bim360/v1/overview/introduction/

Mikako

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google+ photo

You are commenting using your Google+ account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s