Logo Onuma Inc.
 ONUMA Web Services
Architecture Services - Solutons Products


Products > 'REST' Web Services > Onuma Web Services POST
Onuma Web Services POST

Onuma Web Services API ('POST' - V2)
Note: Updating data through Web Services is only authorized
for owned Schemes or Teamwork Schemes.


  1. The base URL for POST is the same as for GET at building level:
    https://www.onuma.com/rest/<username>/<password>/buildings/
    B<Studio ID>_<Building ID>/

  2. POST - Update Space Data:
    Use the above base URL
    and add the word /spaces/ plus a key for the space.
    The space key can be one of the following:
    • the internal ONUMA spaceID
    • the ifcGUID
    • the space number (needs to be unique to update the correct space)
    • the external ID
    (Note: It is up to the user to guarantee the uniqueness of the space number or the external ID otherwise an incorrect space might be updated.)
    The following is a sample URL to get and update data for a space with the number=1B03
    https://www.onuma.com/rest/dummy/dummy/buildings/B57_226/Spaces/1B03
    (Note: the POST has to be the full data set that is retrieved with a GET with the same URL)

  3. POST - Update Equipment Data:
    Use the base URL in 1.
    and add the word /components/ plus a key for the component/equipment.
    The component key can be one of the following:
    • the internal ONUMA componentID
    • the ifcGUID
    • the compoent name (also called "unique identifier" or "Mark")
    • the external ID
    • the bar code
    (Note: It is up to the user to guarantee the uniqueness of the component name, the bar code, or the external ID otherwise an incorrect componentmight be updated.)
    The following is a sample URL to get and update data for a component with the bar code=226-13647
    https://www.onuma.com/rest/dummy/dummy/buildings/B57_226/components/226-13647
    (Note: the POST has to be the full data set that is retrieved with a GET with the same URL)

The username and passwords used above are not authorized to update the data but it is possible to use them to read the sample data.

If you are interested to test updating your own schemes with the POST web service, you may use the following free website to run the tests:
https://www.hurl.it