ONUMA Web Service Examples AEC Hackathon

ONUMA RESTful Webservices

Samples for the Healthcare BIMStorm and the AEC Hackathon 2015

Get all buildings on a specified site

https://www.onuma.com/rest/aec-hack/aec-2015/sites/S161_520/

Building Attribute Value Lists:

for a specific value list number (1):

https://www.onuma.com/rest/aec-hack/aec-2015/sites/S161_520/BuildingValueLists/1/

Space Attributes Value Lists:

for a specific value list number (1):
https://www.onuma.com/rest/aec-hack/aec-2015/sites/S161_520/SpaceValueLists/1/

Get list of departments:

https://www.onuma.com/rest/aec-hack/aec-2015/sites/S161_520/Departments/

Get Spaces of a building:

https://www.onuma.com/rest/aec-hack/aec-2015/buildings/B161_597/

Get Components of a building:

https://www.onuma.com/rest/aec-hack/aec-2015/buildings/B161_597/Components/

Get Floors of a building:

https://www.onuma.com/rest/aec-hack/aec-2015/buildings/B161_597/Floors/

List Documents attached to a building with the URL:

https://www.onuma.com/rest/aec-hack/aec-2015/buildings/B161_597/documents/

Get Excel of Spaces with Attributes:

https://www.onuma.com/rest/aec-hack/aec-2015/buildings/B161_597/SpaceAttributes/

Get Revit BIMXML:

https://www.onuma.com/rest/aec-hack/aec-2015/buildings/B161_597/BIMXML/

Individual Components including "Type" information:

by ifc_GUID
https://www.onuma.com/rest/aec-hack/aec-2015/buildings/B161_597/components/0zZCBIJy2ojgTcfuTV5_gi
by bar code
https://www.onuma.com/rest/aec-hack/aec-2015/buildings/B161_597/components/BIMStorm-0008
by unique instance name (also called "Component Name")
https://www.onuma.com/rest/aec-hack/aec-2015/buildings/B161_597/components/D3320-1
by component ID
https://www.onuma.com/rest/aec-hack/aec-2015/buildings/B161_597/components/1229108

Individual Spaces including extra Attributes:

by ifc_GUID
https://www.onuma.com/rest/aec-hack/aec-2015/buildings/B161_597/Spaces/2n_kaCoe1sUfiHDQhVaL0K
by unique space number
https://www.onuma.com/rest/aec-hack/aec-2015/buildings/B161_597/Spaces/BRIT1
by space ID
https://www.onuma.com/rest/aec-hack/aec-2015/buildings/B161_597/Spaces/120126

Space Use Schedule for a building

https://www.onuma.com/rest/aec-hack/aec-2015/buildings/B161_597/spaceschedule/
for a specific Schedule
https://www.onuma.com/rest/aec-hack/aec-2015/buildings/B161_597/spaceschedule/Dental%20Offices/

Work Orders

all work orders in a building
https://www.onuma.com/rest/aec-hack/aec-2015/buildings/B161_597/workorders
a specific work order in a building by work order ID
https://www.onuma.com/rest/aec-hack/aec-2015/buildings/B161_597/workorders/1
completed tasks associated with work orders
https://www.onuma.com/rest/aec-hack/aec-2015/buildings/B161_597/workordertasks
material cost associated with tasks
https://www.onuma.com/rest/aec-hack/aec-2015/buildings/B161_597/workordercosts

all 3 operations above can be used to find work orders for specific spaces (by spaceID, GUID, or SpaceNumber)
and for specific equipment (by componentID, GUID, or unique ComponentName) by adding the key identifier in between like this:

https://www.onuma.com/rest/aec-hack/aec-2015/buildings/B161_597/spaces/DAYR1/workorders
or
https://www.onuma.com/rest/aec-hack/aec-2015/buildings/B161_597/components/M1801-2/workorders

Or one can find all work orders for a specific technician (by email):
https://www.onuma.com/rest/aec-hack/aec-2015/sites/S161_520/technicians/azevedo@onuma.com

Plan Views from ONUMA

Can be integrated into 3rd party applications

Site Plan

&selectBldgs= -> Building ID shows specific building selected in plan (can be multiple with comma between ID's)
&bldgColorCoding= -> color code based on value lists customInt1, customInt2, etc.
&w= and &h= specify size of plan in pixels (if left off, plan fills screen)

Sample of Site Plan with color coding "Construction Type" (first value list)
https://www.onuma.com/plan/OPS/viewPlan.php?sysID=161&siteID=520&u=aec-hack&p=aec-2015&bldgColorCoding=customInt1&w=800&h=400
Sample of Site Plan with building highlighted and limited size 800 by 400 pixels
https://www.onuma.com/plan/OPS/viewPlan.php?sysID=161&siteID=520&selectBldgs=597&u=aec-hack&p=aec-2015&w=800&h=400

Floor Plan:

&selectSpaces= -> similar to above. Multiple spaces can be highlighted with comma delineated space ID's
&spaceColorCoding= -> similar to above
&w= and &h= -> same as above

Sample of Floor Plan with selected Spaces and limited window
https://www.onuma.com/plan/OPS/viewPlan.php?sysID=161&floorID=1879&selectSpaces=120126,120136&u=aec-hack&p=aec-2015&w=800&h=400
Sample of Floor Plan with color coded Spaces (Project Functional Area Name) and full window
https://www.onuma.com/plan/OPS/viewPlan.php?sysID=161&floorID=1879&u=aec-hack&p=aec-2015&spaceColorCoding=customInt1

Space Plan:

&w= and &h= -> same as above

Sample of Space Plan
https://www.onuma.com/plan/OPS/viewPlan.php?sysID=161&spaceID=120136&u=aec-hack&p=aec-2015&w=595&h=575