Rooms can be created, updated, and deleted using CSV Imports. Please Note that the Building to house the rooms must already exist before creating room via import.
The fields requested for the update are identical to those requested for create, with the exception of needing the Room ID for making updates.
Generating a Room Export will provide all the data you need for an Update-action or Delete-action import.
A Delete-action import requires only the system ID for the Rooms you want to delete.
IMPORTED FILES MUST HAVE ALL FIELDS/COLUMNS REQUESTED: If the Update-import example contains a field, that field MUST be included in the final import, even if you are not making changes to the values for that field. As cited below, if a value is blank for an optional field, the value is removed for that item. Similarly, if the FIELD itself is missing from the import file for an optional field, that value will be removed from ALL of the items in the update file. If the field is required, it must both exist in the import file and must have a value in it.
Removing or Appending Field Values on update
Since you can copy existing values from an export into an update-action import file, we expect that if you wish to retain the existing values, those will be resident in the import. This means that for updates:
- To REMOVE the value(s) for a field where the value is optional, remove the existing value and leave the field blank.
- If the value is required and the field is blank, the row will be rejected.
- If the value is optional and the field is blank, the value will be removed from the object's properties.
- If the value is optional and the field is missing (the column is not resident) from the import, that value will be removed from ALL of the items in the update.
- To REPLACE the value for a field, remove the existing value and replace it with the new/updated value.
- To APPEND the values in a field where multiple values are allowed, retain the existing values but add the new values into the field (separating with a semi-colon.
Create Room
Download a sample CSV file and enter the necessary data into the fields (columns) provided. Generate a Building Export to obtain the Building ID to house the rooms you want to create. Then import your new file.
Field Name | Description | Example |
---|---|---|
Building ID (required) | ID of the building where the room is located | 38151b-015-4de-8cc-f98d91 |
Name (required) | Name of the room. Must be unique within the building | Grant Hall-201 |
Device ID (optional) | MAC address (ID) of the device to be assigned to the room | 00-1C-08-00-83-40 |
External Id (optional) | External system identifier of the room | Determined by the external system |
Update Room
Generate a Room Export, then select and update the necessary information for the import file. Then import your new file.
If you are changing the Building ID for your rooms, you may need a Building Export instead, to copy the new Building ID.
IMPORTED FILES MUST HAVE ALL FIELDS/COLUMNS REQUESTED: If the Update-import example contains a field, that field MUST be included in the final import, even if you are not making changes to the values for that field. As cited above, if a value is blank for an optional field, the value is removed for that item. Similarly, if the FIELD itself is missing from the import file for an optional field, that value will be removed from ALL of the items in the update file. If the field is required, it must both exist in the import file and must have a value in it.
Field Name | Description | Example |
---|---|---|
Room ID (required) | System ID of the room being updated | 69324a-315-4de-8dg-g75d42 |
Building ID (required) | ID of the building where the room is located | 38151b-015-4de-8cc-f98d91 |
Name (required) | Name of the room. Must be unique within the building | Grant Hall-201 |
Device ID (optional) | MAC address (ID) of the device to be assigned to the room | 00-1C-08-00-83-40 |
External Id (optional) | External system identifier of the room | Determined by the external system |
Delete Room
Generate a Room Export, then select and copy the rows for the rooms you want to delete into a new file for the Delete-action import. You can retain additional fields in the file; all except ID are ignored. Then import your new file.
Field Name | Description | Example |
---|---|---|
Room ID (required) | System ID of the room being deleted | 69324a-315-4de-8dg-g75d42 |