Title: New Update on GBS ADN API
Who is this for: Architects, engineers, vendors and developers involved with building energy analysis who have software development skills.
Takeaway: Introducing a new set of APIs to control mass run in our ADN environment. This article announces the availability of this API and provides REST guide to get user started on using these APIs. This also shows our continuous attention and investment on the API community and users.
Author: Barry Tsai - Software Development Manager, BPA, Autodesk, Inc.
A new set of features PES (Potential Energy Savings) chart, sensitivity analysis, and mass run was released recently as Beta . When user submits one base run to GBS server, GBS server automatically spins off about 40 design alternative runs (mass run) and creates all the results to guide user's design decision on making buildings more energy efficient (using sensitivity analysis). For details of these features, please reference an earlier posting on this topic. To provide flexibility on this feature, a set of new APIs are provided so user can turn on and off this feature the at user account and project level via API call. For example, if API users choose to use the classic base run workflow and do not want automatic generation of these 40+ additional design alternative runs, they can turn this feature off via one API call.
This is a follow up on my earlier post about GBS API that is still available through the Autodesk Developer Network, and if you are a member, the SDK can be downloaded here. Recall from the last post, GBS API follows the REST calling style. User can control the mass run on and off switch at either project or user account level via the API call. One can use the mass run API in the following REST form:
Get mass run right at user level:
Url: https://gbs-adn.autodesk.com/gbs/api/v1/User/MassRunRight
HTTP Method: GET
Update mass run right at user level:
Url: https://gbs-adn.autodesk.com/gbs/api/v1/User/MassRunRight
HTTP Method: PUT
Parameters: enabled (Boolean)
Get mass run right at project level:
Url:https://gbs-adn.autodesk.com/gbs/api/v1/Project/{projectId}/MassRunRight
HTTP Method: GET
Parameters: projectId (Integer)
Update mass run right at project level:
Url:https://gbs-adn.autodesk.com/gbs/api/v1/Project/{projectId}/MassRunRight
HTTP Method: PUT
Parameters: projectId (Integer)
enabled (Boolean)
Are you interested in using our API? Are you a developer who is interested in providing building performance analysis solutions that can potentially change this industry? To give us more feedback or to participate in this program, please submit a request with the title “GBS: interested in pilot program” via e-mail to mikako.harada@autodesk.com. In your email, please provide the following information:
▪ Company name
▪ Main contact person’s name
▪ E-mail address
▪ ADN Developer ID
▪ Brief description of intention
After receiving your request, we will contact you with more information.
Subscribe
Comments