Embed Size (px)
Citation preview
Galia Traub
Senior Software EngineerBIM 360, Autodesk
Extend BIM 360 Docs with the Issues API
Mikako Harada
AEC Technical Lead & Americas Manager Developer Technical Services, Autodesk
Session Goals
• Preview API’s for BIM 360 Docs
• Give overview of API structure and design
• Get ready for the beta
Agenda
• BIM 360 Docs - Product Overview
• BIM 360 Docs - API• Overview
• Data Management API
• Issues API
• Q&A
BIM 360 Docs – Product Overview
BIM 360 Docs – Product Demo
Why BIM 360 Docs?
• Docs as data at center
• Seamless, unified future
DocsHQ
Glue FieldDocsLayout Plan
BIM 360 Docs - API
BIM 360 Docs – API Overview
• Authentication (OAuth)
• BIM 360 API (Account/HQ Mgmt)
• Data Management API
• Model Derivative API
• Viewer
• Issues API
BIM 360 Docs – API Overview
• Authentication (OAuth)
• BIM 360 API (Account/HQ Mgmt)
• Data Management API
• Model Derivative API
• Viewer
• Issues API
BIM 360 Docs – API Overview
• Authentication (OAuth)
• BIM 360 API (Account/HQ Mgmt)
• Data Management API
• Model Derivative API
• Viewer
• Issues API
BIM 360 Docs – API Overview
• Authentication (OAuth)
• BIM 360 API (Account/HQ Mgmt)I
• Data Management API
• Model Derivative API
• Viewer
• Issues API
BIM 360 Docs – API Overview
• Authentication (OAuth)
• BIM 360 API (Account/HQ Mgmt)
• Data Management API
• Model Derivative API
• Viewer
• Issues API
BIM 360 Docs – API Overview
• Authentication (OAuth)
• BIM 360 API (Account/HQ Mgmt)
• Data Management API
• Model Derivative API
• Viewer
• Issues API
Authentication Methods for BIM 360 Docs
• OAuth2• 2-legged
• Application-only
• 3-legged• User context
• Re-direct to accounts.autodesk.com
https://developer.autodesk.com/en/docs/oauth/v2/overview/
Data Management API
Data Management API – Overview
• Document Management
• Common across Autodesk products• A360
• Fusion/Life Cycle
• BIM 360 Docs
• Consumer products (Tinker CAD)
• …
Data Management API – Service Groups
• Project service
• Data service
• Object storageservice (OSS)
• Schema services
https://developer.autodesk.com/en/docs/data/v2/overview/
Data Management API
• JSON API{json:api}http://jsonapi.org/format/
Data Management API
• Drill down withTest Harness
Learn more: Data Management & Related API Classes
Time Title Focus
Wednesday
2:25 PM Visual Reporting with Connected Design Data Platform, Viewing
3:55 PM Increasing Supply Chain and Manufacturing Capacity with Forge Manufacturing, partner
Thursday
10:50 AM The Path to Forge Platform, Overview
10:50 AM Cloud PDM Demystified – The Future of File Management Manufacturing, PLM
1:00 PM Free Your BIM Data AEC, Model Derivative
2:05 PM Building Data Centric Applications on Forge Manufacturing, partner
3:35 PM Collaborating with Design Data Platform, DM basics
4:40 PM Free Your Design Data Platform, Model Derivative
Issues API
Outline
• Product demo
• API Intro
• hello world – GET issues
• JSON API
• Demo
• Future work
Issues API in Docs
Issue Created
POST https://developer.api.autodesk.com/
issues/v1/containers/:container_id/issues*
*internal for now
Issue Created
POST https://developer.api.autodesk.com/
issues/v1/containers/:container_id/issues*
*internal for now
Issue Created
POST https://developer.api.autodesk.com/
issues/v1/containers/:container_id/issues
Container lets us map this issue to a BIM360 Project
Issue Created
Lets go find it
{json:api}
• Open standard
• Consistency - shared conventions
• Clear & detailed specification
• 50+ Clients & Implementations
• Details: jsonapi.org
{json:api}{
data: […],
meta: { record_count: 186 },
links: {
first: "https…",
last: "https…",
next: "https…"
}
}
{json:api}data: [{
id: "<issue_id>",type: "issues",links: {self: "https …/<issue_id>"
},attributes: {title: "Grade of parapet is not to
code",status: "open"…
},}…
]
{json:api}{
data: […],
meta: { record_count: 186 },
links: {
first: "https…",
last: "https…",
next: "https…"
}
}
Demo
issue.status
assigned_to & assigned_to_type
• Company
• Role
• Individual User
assign & open the issue
GET (open, company ) issues
https://developer.api.autodesk.com/issues/v1/containers/:container_id/issues?
filter[status]=open&
filter[assigned_to_type]=company
Paging
https://developer.api.autodesk.com/issues/v1/containers/:container_id/issues?
filter[status]=open&
filter[assigned_to_type]=company
page[limit]=100&
page[offset]=0
Sparse fields
https://developer.api.autodesk.com/issues/v1/containers/:container_id/issues?
filter[status]=open&
filter[assigned_to_type]=company
page[limit]=100&
page[offset]=0&
fields[issues]=assigned_to
Demo
Issues Vision
• Provides a toolset to track issues
• Data in the middle approach
• Leverages Forge APIs & BIM 360 Docs’ powerful permissions system
Future Capabilities
• Bulk updates for syncing & importing
• Issue creation & updating
• Association to location
• Linking to 3D element
• New Issue types• Quality Issues
• RFIs
• Beyond BIM 360 (A360 & External)
• What else?
@AutodeskForge
#ForgeDevCon
