ONUMA API - Geospatial Lab

This is a sample collection of API requests for the ONUMA System API.
Any ONUMA System user with access to a specific site can get a Bearer token to use with the API.
A small set of data from a few of the GET requests can be seen with this Google Sheets link: https://docs.google.com/spreadsheets/d/1WGJeYjTV4DuNlx8UgBYKAoI925l8PqjvoMZfZOxnbpg/edit?usp=sharing
Please contact Onuma, Inc. for further information.

1-GET 14

01-Site10-SanJoseAirport | GET https://system.onuma.com/80/api/items/building

Query

Key	Value	Description
fields	site.name,site.latitude,site.longitude,site.area,site.unit,id,name,number,placement_x,placement_y,placement_x,placement_angle,net_area,gross_area,floors.name,floors.number	?fields=site.name,site.latitude,site.longitude,site.area,site.unit,id,name,number,placement_x,placement_y,placement_x,placement_angle,net_area,gross_area,floors.name,floors.number&filter[site][eq]=10
filter[site][eq]	10

02-Site11-Stanford | GET https://system.onuma.com/80/api/items/building

Query

Key	Value	Description
fields	site.name,site.latitude,site.longitude,site.area,site.unit,id,name,number,placement_x,placement_y,placement_x,placement_angle,net_area,gross_area,floors.name,floors.number	?fields=site.name,site.latitude,site.longitude,site.area,site.unit,id,name,number,placement_x,placement_y,placement_x,placement_angle,net_area,gross_area,floors.name,floors.number&filter[site][eq]=11
filter[site][eq]	11

03-Site12-Clinic | GET https://system.onuma.com/80/api/items/building

Query

Key	Value	Description
fields	site.name,site.latitude,site.longitude,site.area,site.unit,id,name,number,placement_x,placement_y,placement_x,placement_angle,net_area,gross_area,floors.name,floors.number	?fields=site.name,site.latitude,site.longitude,site.area,site.unit,id,name,number,placement_x,placement_y,placement_x,placement_angle,net_area,gross_area,floors.name,floors.number&filter[site][eq]=12
filter[site][eq]	12

11-Building31-Fairchild | GET https://system.onuma.com/80/api/items/building/31

Query

Key	Value	Description
fields	,.*	?fields=,.*

12-Building31-floor-slabs | GET https://system.onuma.com/80/api/items/building/31

Query

Key	Value	Description
fields	floors,floors.slabs.*	?fields=floors,floors.slabs.*

13-Building31-spaces | GET https://system.onuma.com/80/api/items/space

Query

Key	Value	Description
limit	9999
fields	floor.building.id,floor.building.name,floor.number,floor.name,floor.id,id,number,name,area,height,placement_x,placement_y,placement_angle,modified_by,modified_on	?limit=9999&fields=floor.building.id,floor.building.name,floor.number,floor.name,floor.id,id,number,name,area,height,placement_x,placement_y,placement_angle,modified_by,modified_on&filter[floor.building]=31
filter[floor.building]	31

14-Building31-spaces-shape | GET https://system.onuma.com/80/api/items/space

Query

Key	Value	Description
limit	9999
fields	floor.building.id,floor.building.name,floor.number,floor.name,floor.id,id,number,name,area,height,profile,placement_x,placement_y,placement_angle,lazy_attribute.*,modified_by,modified_on	?limit=9999&fields=floor.building.id,floor.building.name,floor.number,floor.name,floor.id,id,number,name,area,height,profile,placement_x,placement_y,placement_angle,lazy_attribute.*,modified_by,modified_on&filter[floor.building]=31
filter[floor.building]	31

15-Building31-floor54-floorSlabs | GET https://system.onuma.com/80/api/items/building/31

Query

Key	Value	Description
fields	floors.name,floors.number,floors.slabs.floor,floors.slabs.placement_x,floors.slabs.placement_y,floors.slabs.placement_angle,floors.slabs.thickness,floors.slabs.profile	?fields=floors.name,floors.number,floors.slabs.floor,floors.slabs.placement_x,floors.slabs.placement_y,floors.slabs.placement_angle,floors.slabs.thickness,floors.slabs.profile&filter[floors.slabs.floor]=54
filter[floors.slabs.floor]	54

16-Building31-searchDoors | GET https://system.onuma.com/80/api/items/space_component

Query

Key	Value	Description
fields	component.id,component.name,component.placement_x,component.placement_y,component.placement_angle,component.mirror_y,component.int_lib,component.space_component.space.id,component.space_component.space.name,component.space_component.space.number,component.space_component.space.floor.name, component.space_component.space.floor.number	?fields=component.id,component.name,component.placement_x,component.placement_y,component.placement_angle,component.mirror_y,component.int_lib,component.space_component.space.id,component.space_component.space.name,component.space_component.space.number,component.space_component.space.floor.name, component.space_component.space.floor.number&filter[space.floor.building.id]=31&filter[component.name][contains]=door&filter[component.int_lib][contains]=door&filter[component.int_lib][logical]=or
filter[space.floor.building.id]	31
filter[component.name][contains]	door
filter[component.int_lib][contains]	door
filter[component.int_lib][logical]	or

31-Space1087-Components | GET https://system.onuma.com/80/api/items/space/1087

Query

Key	Value	Description
fields	id,number,name,components.component.name,components.component.id,components.component.placement_x,components.component.placement_y,components.component.placement_angle,components.component.mirror_y,components.component.int_lib	?fields=id,number,name,components.component.name,components.component.id,components.component.placement_x,components.component.placement_y,components.component.placement_angle,components.component.mirror_y,components.component.int_lib

41-Workorders-Site11 | GET https://api.onuma.com/80/items/workorder

Query

Key	Value	Description
fields	*,building.id,building.name,floor.id,floor.name,space.id,space.number,space.name	?fields=*,building.id,building.name,floor.id,floor.name,space.id,space.number,space.name&filter[building.site]=11
filter[building.site]	11

42-WorkorderTechnicians-SiteGroup1 | GET https://system.onuma.com/80/api/items/technician

Query

Key	Value	Description
filter[site_group.id]	1	?filter[site_group.id]=1&fields=*
fields	*

43-Workorder1-Components | GET https://system.onuma.com/80/api/items/component_workorder

Query

Key	Value	Description
fields	component.name,component.id	?fields=component.name,component.id&filter[workorder]=1
filter[workorder]	1

44-TechnicianInformation | GET https://system.onuma.com/80/api/items/technician

Query

Key	Value	Description
fields	*	?fields=*&filter[email]=sail@dalbert.us
filter[email]	sail@dalbert.us

2-PATCH 2

PATCH requests update data.

raw

31-Space1087-Update | PATCH https://system.onuma.com/80/api/items/space/1087

Query

Key	Value	Description
fields	id,name,number	?fields=id,name,number

Body

{ "id": 1087, "name": "Office", "number": "D138A" }

raw

41-Workorder1-Assign | PATCH https://system.onuma.com/80/api/items/workorder/1

Query

Key	Value	Description
fields	id,title,assigned_technician,status,administrator	?fields=id,title,assigned_technician,status,administrator

Body

{ "id": 1, "administrator": 5, "status": "Assigned", "assigned_technician": 1, "assigned_date": "2021-09-08 07:20:00", "assigned_priority": 2 }

3-DEL 1

raw

41-Workorder-DeleteComponent | DELETE https://system.onuma.com/80/api/items/component_workorder/2

4-POST 2

raw

41-TechnicianAdd | POST https://system.onuma.com/80/api/items/technician

Body

{ "id": 1, "site": 11, "site_group": 1, "first_name": "Sail", "last_name": "Dalbert", "email": "sail@dalbert.us", "cc": "", "company": "", "phone": "", "department": "", "organization": "", "shop": "Plumbing", "active": true, "rate": 50, "overtime_rate": 730 }

raw

42-Workorder-AddComponent | POST https://system.onuma.com/80/api/items/component_workorder

Body

{ "component": 10416, "workorder": 2 }

Available Variables 1

Key	Value	Type
sysID	80