[Index]

API Reference for data/MeetingRoomUnifiedRoom

Unified view of meeting rooms across Microsoft Teams Rooms and Webex Workspaces, with identity, location, attributes, capabilities, inventory, health, utilization, quality, and telemetry lineage.

Model ref.: data/MeetingRoomUnifiedRoom

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For [auth_token]:
1. The VOSS portal will extract the [auth_token] from the URLs and send these as an Authorization header.
2. Model schemas show that the auth_token parameter is still supported.

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

GET http://[host-proxy]/api/data/MeetingRoomUnifiedRoom/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema",
     "type": "object",
     "properties": {
          "unified_room_id": {
               "title": "Unified Room ID",
               "description": "Internal stable ID for the physical room.",
               "type": "string",
               "format": "uuid",
               "maxLength": 1024
          },
          "display_name": {
               "title": "Display Name",
               "description": "Preferred room name.",
               "type": "string",
               "maxLength": 1024
          },
          "email": {
               "title": "Email",
               "description": "Primary room mailbox email.",
               "type": "string",
               "maxLength": 1024
          },
          "sip_address": {
               "title": "SIP Address",
               "description": "Workspace or device SIP URI.",
               "type": "string",
               "maxLength": 1024
          },
          "phone_number": {
               "title": "Phone Number",
               "description": "Direct dial room phone number, if any.",
               "type": "string",
               "maxLength": 1024
          },
          "vendor": {
               "title": "Vendor",
               "description": "Primary platform/vendor (e.g., Microsoft, Cisco).",
               "type": "string",
               "choices": [
                    {
                         "value": "Microsoft",
                         "title": "Microsoft"
                    },
                    {
                         "value": "Cisco",
                         "title": "Cisco"
                    }
               ],
               "maxLength": 1024
          },
          "calendar_type": {
               "title": "Calendar Type",
               "description": "Calendar integration type.",
               "type": "string",
               "maxLength": 1024
          },
          "calling_plan_type": {
               "title": "Calling Plan Type",
               "description": "Calling plan or PSTN service type.",
               "type": "string",
               "maxLength": 1024
          },
          "site": {
               "title": "Site",
               "description": "Highest-level site or campus.",
               "type": "string",
               "maxLength": 1024
          },
          "building": {
               "title": "Building",
               "description": "Building name or identifier.",
               "type": "string",
               "maxLength": 1024
          },
          "floor_label": {
               "title": "Floor Label",
               "description": "Human-readable floor label (e.g., L5, 5F).",
               "type": "string",
               "maxLength": 1024
          },
          "floor_number": {
               "title": "Floor Number",
               "description": "Numeric floor number, when applicable.",
               "type": "integer"
          },
          "geo_lat": {
               "title": "Geo Lat",
               "description": "Latitude if available.",
               "type": "number"
          },
          "geo_lon": {
               "title": "Geo Lon",
               "description": "Longitude if available.",
               "type": "number"
          },
          "capacity": {
               "title": "Capacity",
               "description": "Seating capacity.",
               "type": "integer"
          },
          "size_category_key": {
               "title": "Size Category Key",
               "description": "Stable size key (e.g., small, medium, large, xl).",
               "type": "string",
               "maxLength": 1024
          },
          "size_category_title": {
               "title": "Size Category Title",
               "description": "Display label for size category.",
               "type": "string",
               "maxLength": 1024
          },
          "room_type": {
               "title": "Room Type",
               "description": "Normalized room type (e.g., huddle, meetingRoom).",
               "type": "string",
               "maxLength": 1024
          },
          "occupancy_supported": {
               "title": "Occupancy Supported",
               "description": "People/occupancy sensing supported.",
               "type": "boolean"
          },
          "presence_supported": {
               "title": "Presence Supported",
               "description": "Presence detection supported.",
               "type": "boolean"
          },
          "temperature_supported": {
               "title": "Temperature Supported",
               "description": "Temperature sensing supported.",
               "type": "boolean"
          },
          "humidity_supported": {
               "title": "Humidity Supported",
               "description": "Relative humidity sensing supported.",
               "type": "boolean"
          },
          "air_quality_supported": {
               "title": "Air Quality Supported",
               "description": "Air quality sensing supported.",
               "type": "boolean"
          },
          "ambient_noise_supported": {
               "title": "Ambient Noise Supported",
               "description": "Ambient/sound level sensing supported.",
               "type": "boolean"
          },
          "tags": {
               "title": "Tags",
               "description": "List of labels/tags for this room.",
               "type": "array",
               "items": {
                    "type": "string",
                    "maxLength": 1024
               }
          },
          "source_system": {
               "title": "Source System",
               "description": "Originating source system for this record.",
               "type": "string",
               "maxLength": 1024
          },
          "source_updated_at": {
               "title": "Source Updated At",
               "description": "Timestamp when the source last updated this record.",
               "type": "string",
               "format": "date-time",
               "maxLength": 1024
          },
          "s_health_score": {
               "title": "Health Score",
               "description": "0\u2013100 composite health score.",
               "type": "integer"
          },
          "s_health_band": {
               "title": "Health Band",
               "description": "Band mapped from health score.",
               "type": "string",
               "choices": [
                    {
                         "value": "Healthy",
                         "title": "Healthy"
                    },
                    {
                         "value": "Minor",
                         "title": "Minor"
                    },
                    {
                         "value": "Degraded",
                         "title": "Degraded"
                    },
                    {
                         "value": "Critical",
                         "title": "Critical"
                    }
               ],
               "maxLength": 1024
          },
          "s_has_critical_issue": {
               "title": "Has Critical Issue",
               "description": "True if any critical issue is open.",
               "type": "boolean"
          },
          "s_device_count_total": {
               "title": "Device Count Total",
               "description": "Total devices linked to this room.",
               "type": "integer"
          },
          "s_devices_online": {
               "title": "Devices Online",
               "description": "Devices online/connected now.",
               "type": "integer"
          },
          "s_devices_offline": {
               "title": "Devices Offline",
               "description": "Devices offline/disconnected.",
               "type": "integer"
          },
          "s_devices_other": {
               "title": "Devices Other",
               "description": "Devices in other/non-binary states.",
               "type": "integer"
          },
          "s_status_updated_at": {
               "title": "Status Updated At",
               "description": "Timestamp of latest status/health computation.",
               "type": "string",
               "format": "date-time",
               "maxLength": 1024
          },
          "r7d_used_util_pct": {
               "title": "Used Util % 7d",
               "description": "Actual occupied percent over last 7 days.",
               "type": "number"
          },
          "r7d_scheduled_util_pct": {
               "title": "Scheduled Util % 7d",
               "description": "% of business minutes booked over last 7 days.",
               "type": "number"
          },
          "r7d_no_show_rate": {
               "title": "No Show Rate 7d",
               "description": "(Booked not occupied) / Booked over 7 days.",
               "type": "number"
          },
          "r7d_avg_headcount": {
               "title": "Avg Headcount 7d",
               "description": "Average in-room headcount when occupied over 7 days.",
               "type": "number"
          },
          "r7d_peak_hour_local": {
               "title": "Peak Hour Local 7d",
               "description": "Local hour with highest occupancy/use over 7 days.",
               "type": "integer"
          },
          "r30d_used_util_pct": {
               "title": "Used Util % 30d",
               "description": "Actual occupied percent over last 30 days.",
               "type": "number"
          },
          "r30d_scheduled_util_pct": {
               "title": "Scheduled Util % 30d",
               "description": "% booked over last 30 days.",
               "type": "number"
          },
          "r30d_no_show_rate": {
               "title": "No Show Rate 30d",
               "description": "(Booked not occupied) / Booked over 30 days.",
               "type": "number"
          },
          "r30d_max_headcount": {
               "title": "Max Headcount 30d",
               "description": "Peak headcount last 30 days.",
               "type": "integer"
          },
          "r30d_poor_meeting_rate": {
               "title": "Poor Meeting Rate 30d",
               "description": "% of meetings flagged poor over last 30 days.",
               "type": "number"
          },
          "r30d_quality_score": {
               "title": "Quality Score 30d",
               "description": "Composite experience score last 30 days.",
               "type": "number"
          },
          "rollup_last_computed_at": {
               "title": "Rollup Last Computed At",
               "description": "Timestamp when rollups were last computed.",
               "type": "string",
               "format": "date-time",
               "maxLength": 1024
          },
          "licenses": {
               "title": "Licenses",
               "description": "List of licenses associated with this room.",
               "type": "array",
               "items": {
                    "type": "string",
                    "maxLength": 1024
               }
          },
          "r7d_total_calls": {
               "title": "Total Calls 7d",
               "description": "Total calls over last 7 days.",
               "type": "number",
               "minimum": 0
          },
          "r30d_total_calls": {
               "title": "Total Calls 30d",
               "description": "Total calls over last 30 days.",
               "type": "number",
               "minimum": 0
          },
          "r7d_active_hours": {
               "title": "Active Hours 7d",
               "description": "Active hours over last 7 days.",
               "type": "number",
               "minimum": 0
          },
          "r30d_active_hours": {
               "title": "Active Hours 30d",
               "description": "Active hours over last 30 days.",
               "type": "number",
               "minimum": 0
          },
          "r7d_total_duration_seconds": {
               "title": "Total Duration (s) 7d",
               "description": "Total duration in seconds over last 7 days.",
               "type": "number",
               "minimum": 0
          },
          "r7d_total_duration_minutes": {
               "title": "Total Duration (minutes) 7d",
               "description": "Total duration in minutes over last 7 days.",
               "type": "number",
               "minimum": 0
          },
          "r7d_total_duration_hours": {
               "title": "Total Duration (hours) 7d",
               "description": "Total duration in hours over last 7 days.",
               "type": "number",
               "minimum": 0
          },
          "r30d_total_duration_seconds": {
               "title": "Total Duration (s) 30d",
               "description": "Total duration in seconds over last 30 days.",
               "type": "number",
               "minimum": 0
          },
          "r30d_total_duration_minutes": {
               "title": "Total Duration (minutes) 30d",
               "description": "Total duration in minutes over last 30 days.",
               "type": "number",
               "minimum": 0
          },
          "r30d_total_duration_hours": {
               "title": "Total Duration (hours) 30d",
               "description": "Total duration in hours over last 30 days.",
               "type": "number",
               "minimum": 0
          },
          "r7d_total_participants": {
               "title": "Total Participants 7d",
               "description": "Total participants over last 7 days.",
               "type": "number",
               "minimum": 0
          },
          "r30d_total_participants": {
               "title": "Total Participants 30d",
               "description": "Total participants over last 30 days.",
               "type": "number",
               "minimum": 0
          },
          "r7d_audio_calls": {
               "title": "Audio Calls 7d",
               "description": "Audio calls over last 7 days.",
               "type": "number",
               "minimum": 0
          },
          "r7d_video_calls": {
               "title": "Video Calls 7d",
               "description": "Video calls over last 7 days.",
               "type": "number",
               "minimum": 0
          },
          "r7d_vbss_calls": {
               "title": "Sharing Calls 7d",
               "description": "Sharing calls over last 7 days.",
               "type": "number",
               "minimum": 0
          },
          "r30d_audio_calls": {
               "title": "Audio Calls 30d",
               "description": "Audio calls over last 30 days.",
               "type": "number",
               "minimum": 0
          },
          "r30d_video_calls": {
               "title": "Video Calls 30d",
               "description": "Video calls over last 30 days.",
               "type": "number",
               "minimum": 0
          },
          "r30d_vbss_calls": {
               "title": "Sharing Calls 30d",
               "description": "Sharing calls over last 30 days.",
               "type": "number",
               "minimum": 0
          },
          "r7d_audio_poor_calls": {
               "title": "Audio Poor Calls 7d",
               "description": "Audio poor calls over last 7 days.",
               "type": "number",
               "minimum": 0
          },
          "r7d_audio_good_calls": {
               "title": "Audio Good Calls 7d",
               "description": "Audio good calls over last 7 days.",
               "type": "number",
               "minimum": 0
          },
          "r7d_video_poor_calls": {
               "title": "Video Poor Calls 7d",
               "description": "Video poor calls over last 7 days.",
               "type": "number",
               "minimum": 0
          },
          "r7d_video_good_calls": {
               "title": "Video Good Calls 7d",
               "description": "Video good calls over last 7 days.",
               "type": "number",
               "minimum": 0
          },
          "r7d_vbss_poor_calls": {
               "title": "Sharing Poor Calls 7d",
               "description": "Sharing poor calls over last 7 days.",
               "type": "number",
               "minimum": 0
          },
          "r7d_vbss_good_calls": {
               "title": "Sharing Good Calls 7d",
               "description": "Sharing good calls over last 7 days.",
               "type": "number",
               "minimum": 0
          },
          "r30d_audio_poor_calls": {
               "title": "Audio Poor Calls 30d",
               "description": "Audio poor calls over last 30 days.",
               "type": "number",
               "minimum": 0
          },
          "r30d_audio_good_calls": {
               "title": "Audio Good Calls 30d",
               "description": "Audio good calls over last 30 days.",
               "type": "number",
               "minimum": 0
          },
          "r30d_video_poor_calls": {
               "title": "Video Poor Calls 30d",
               "description": "Video poor calls over last 30 days.",
               "type": "number",
               "minimum": 0
          },
          "r30d_video_good_calls": {
               "title": "Video Good Calls 30d",
               "description": "Video good calls over last 30 days.",
               "type": "number",
               "minimum": 0
          },
          "r30d_vbss_poor_calls": {
               "title": "Sharing Poor Calls 30d",
               "description": "Sharing poor calls over last 30 days.",
               "type": "number",
               "minimum": 0
          },
          "r30d_vbss_good_calls": {
               "title": "Sharing Good Calls 30d",
               "description": "Sharing good calls over last 30 days.",
               "type": "number",
               "minimum": 0
          },
          "total_active_hours": {
               "title": "Total Active Hours",
               "description": "Total active hours across all time.",
               "type": "number",
               "minimum": 0
          },
          "total_calls": {
               "title": "Total Calls",
               "description": "Total calls across all time.",
               "type": "number",
               "minimum": 0
          },
          "total_duration_seconds": {
               "title": "Total Duration (s)",
               "description": "Total duration in seconds across all time.",
               "type": "number",
               "minimum": 0
          },
          "total_duration_minutes": {
               "title": "Total Duration (minutes)",
               "description": "Total duration in minutes across all time.",
               "type": "number",
               "minimum": 0
          },
          "total_duration_hours": {
               "title": "Total Duration (hours)",
               "description": "Total duration in hours across all time.",
               "type": "number",
               "minimum": 0
          },
          "total_participants": {
               "title": "Total Participants",
               "description": "Total participants across all time.",
               "type": "number",
               "minimum": 0
          },
          "total_hours_utilized": {
               "title": "Total Hours Utilized",
               "description": "Total hours utilized across all time.",
               "type": "number",
               "minimum": 0
          },
          "total_audio_calls": {
               "title": "Total Audio Calls",
               "description": "Total audio calls across all time.",
               "type": "number",
               "minimum": 0
          },
          "total_video_calls": {
               "title": "Total Video Calls",
               "description": "Total video calls across all time.",
               "type": "number",
               "minimum": 0
          },
          "total_vbss_calls": {
               "title": "Total Sharing Calls",
               "description": "Total sharing calls across all time.",
               "type": "number",
               "minimum": 0
          },
          "total_audio_poor_calls": {
               "title": "Total Audio Poor Calls",
               "description": "Total audio poor calls across all time.",
               "type": "number",
               "minimum": 0
          },
          "total_audio_good_calls": {
               "title": "Total Audio Good Calls",
               "description": "Total audio good calls across all time.",
               "type": "number",
               "minimum": 0
          },
          "total_video_poor_calls": {
               "title": "Total Video Poor Calls",
               "description": "Total video poor calls across all time.",
               "type": "number",
               "minimum": 0
          },
          "total_video_good_calls": {
               "title": "Total Video Good Calls",
               "description": "Total video good calls across all time.",
               "type": "number",
               "minimum": 0
          },
          "total_vbss_poor_calls": {
               "title": "Total Sharing Poor Calls",
               "description": "Total sharing poor calls across all time.",
               "type": "number",
               "minimum": 0
          },
          "total_vbss_good_calls": {
               "title": "Total Sharing Good Calls",
               "description": "Total sharing good calls across all time.",
               "type": "number",
               "minimum": 0
          },
          "total_poor_calls": {
               "title": "Total Poor Calls",
               "description": "Total poor calls across all time.",
               "type": "number",
               "minimum": 0
          },
          "total_good_calls": {
               "title": "Total Good Calls",
               "description": "Total good calls across all time.",
               "type": "number",
               "minimum": 0
          },
          "avg_quality_score": {
               "title": "Avg Quality Score",
               "description": "Average quality score across all time.",
               "type": "number",
               "minimum": 0,
               "maximum": 100
          },
          "max_headcount": {
               "title": "Max Headcount",
               "description": "Maximum headcount across all time.",
               "type": "number",
               "minimum": 0
          },
          "utilization_band_7d": {
               "title": "Utilization Band 7d",
               "description": "Utilization band over last 7 days.",
               "type": "string",
               "maxLength": 1024
          },
          "quality_band_30d": {
               "title": "Quality Band 30d",
               "description": "Quality band over last 30 days.",
               "type": "string",
               "maxLength": 1024
          },
          "7d_meeting_usage_category_title": {
               "title": "Meeting Usage Category Title 7d",
               "description": "Display label for meeting usage category over last 7 days.",
               "type": "string",
               "maxLength": 1024
          },
          "30d_meeting_usage_category_title": {
               "title": "Meeting Usage Category Title 30d",
               "description": "Display label for meeting usage category over last 30 days.",
               "type": "string",
               "maxLength": 1024
          }
     },
     "schema_version": "1.1"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/data/MeetingRoomUnifiedRoom/add/	hierarchy=[hierarchy] format=json	The GUI Add form of data/MeetingRoomUnifiedRoom as JSON

The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.

Task	Call	URL	Parameters	Payload
Create	POST	/api/data/MeetingRoomUnifiedRoom	hierarchy=[hierarchy]	(For payload specification)

Response is a transaction pkid for the create action.

Use the GET call to

tool/Transaction/[trans pkid]

to inspect the created resource and its instance pkid.

Task	Call	URL	Parameters	Payload
Bulk delete [pkid1],[pkid2]...	DELETE	/api/data/MeetingRoomUnifiedRoom/	hierarchy=[hierarchy]	{"hrefs":["/api/data/MeetingRoomUnifiedRoom/[pkid1]", "/api/data/MeetingRoomUnifiedRoom/[pkid2]", ...]}

For the instance pkids [pkid1],[pkid2], ... that can be added to the DELETE call (the instance pkids to delete), refer to the List GET call for: data/MeetingRoomUnifiedRoom
```
GET http://[host-proxy]/api/data/MeetingRoomUnifiedRoom/?hierarchy=[hierarchy]&format=json
```

Task	Call	URL	Parameters	Response
Bulk Modify	GET	/api/data/MeetingRoomUnifiedRoom/bulk_update/?schema=&schema_rules=true	hierarchy=[hierarchy] format=json pkids=pkid1,pkid2,...	In JSON format: POST call to update the instances of data/MeetingRoomUnifiedRoom data/MeetingRoomUnifiedRoom schema to create POST payload.

Task	Call	URL	Parameters	Payload
Bulk Modify	POST	/api/data/MeetingRoomUnifiedRoom/bulk_update/	hierarchy=[hierarchy] format=json	For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/MeetingRoomUnifiedRoom/[pkid1]", "/api/v0/data/MeetingRoomUnifiedRoom/[pkid2]",...]}}

To get a list of model instance pkids that are available to Bulk Modify, use the GET call:

GET http://[host-proxy]/api/data/MeetingRoomUnifiedRoom/?hierarchy=[hierarchy]&format=json

The POST payload is in JSON format (refer to the Payload example) and contains:
- data in name-value update pairs according to the returned schema
- meta (empty - for a valid payload)
- request_meta with the hrefs list of instances to update

Task	Call	URL	Parameters	Payload
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/MeetingRoomUnifiedRoom; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/data/MeetingRoomUnifiedRoom/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/data/MeetingRoomUnifiedRoom/[pkid1]", "/api/data/MeetingRoomUnifiedRoom/[pkid2]",...]}}

For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:

        Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
        Content-Language:en
        Content-Type:application/x-zip

For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

The XLSX format can be used to bulk load instances of data/MeetingRoomUnifiedRoom and the JSON format can be used to import instances of data/MeetingRoomUnifiedRoom.

To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for data/MeetingRoomUnifiedRoom:

 GET http://[host-proxy]/api/data/MeetingRoomUnifiedRoom/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get a compressed format of the Bulk Load spreadsheet template for data/MeetingRoomUnifiedRoom	POST	/api/data/MeetingRoomUnifiedRoom/export_bulkload_template/	hierarchy=[hierarchy] modeltype=data/MeetingRoomUnifiedRoom	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
Tag	PATCH	/api/data/MeetingRoomUnifiedRoom/+tag/	hierarchy=[hierarchy] format=json

Task	Call	URL	Parameters	Response
Tag Version	PATCH	/api/data/MeetingRoomUnifiedRoom/+tag_version/	hierarchy=[hierarchy] format=json

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/data/MeetingRoomUnifiedRoom/configuration_template/	hierarchy=[hierarchy]	POST call to create the Configuration Template Configuration Template schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Field Display Policy	GET	/api/data/MeetingRoomUnifiedRoom/field_display_policy/	hierarchy=[hierarchy]	POST call to create the Field Display Policy Field Display Policy schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Migration Template	GET	/api/data/MeetingRoomUnifiedRoom/migration/	hierarchy=[hierarchy] format=json

Task	Call	URL	Parameters	Response
List	GET	/api/data/MeetingRoomUnifiedRoom/	hierarchy=[hierarchy] format=json schema=true	The data/MeetingRoomUnifiedRoom schema and all instances as JSON.

(The list will return 0 to 3 data/MeetingRoomUnifiedRoom instances)

GET http://[host]/api/data/MeetingRoomUnifiedRoom/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "pagination": {
          "skip": 0,
          "limit": 3,
          "maximum_limit": 2000,
          "total": 0,
          "total_limit": null,
          "order_by": "display_name",
          "direction": "asc",
          "current": "/api/data/MeetingRoomUnifiedRoom/?skip=0&limit=3&order_by=display_name&direction=asc&traversal=down"
     },
     "operations": [
          "add",
          "bulk_update_form",
          "list",
          "update",
          "transform",
          "migration",
          "remove",
          "move",
          "export",
          "help",
          "configuration_template",
          "field_display_policy",
          "get",
          "export_bulkload_template"
     ],
     "meta": {
          "model_type": "data/MeetingRoomUnifiedRoom",
          "summary_attrs": [
               {
                    "name": "display_name",
                    "title": "Display Name"
               },
               {
                    "name": "email",
                    "title": "Email"
               },
               {
                    "name": "site",
                    "title": "Site"
               },
               {
                    "name": "building",
                    "title": "Building"
               },
               {
                    "name": "room_type",
                    "title": "Room Type"
               },
               {
                    "name": "capacity",
                    "title": "Capacity"
               },
               {
                    "name": "vendor",
                    "title": "Vendor"
               },
               {
                    "name": "s_health_band",
                    "title": "Health Band"
               },
               {
                    "name": "s_device_count_total",
                    "title": "Device Count Total"
               },
               {
                    "name": "s_devices_online",
                    "title": "Devices Online"
               },
               {
                    "name": "s_devices_offline",
                    "title": "Devices Offline"
               },
               {
                    "name": "r7d_scheduled_util_pct",
                    "title": "Scheduled Util % 7d"
               },
               {
                    "name": "r7d_used_util_pct",
                    "title": "Used Util % 7d"
               },
               {
                    "name": "rollup_last_computed_at",
                    "title": "Rollup Last Computed At"
               },
               {
                    "name": "hierarchy_friendly_name",
                    "title": "Located At",
                    "allow_filtering": true
               }
          ],
          "tagged_versions": [],
          "tags": [],
          "title": "?",
          "business_key": {
               "unique": [
                    "unified_room_id"
               ]
          },
          "api_version": "21.2",
          "cached": true,
          "references": {
               "children": [],
               "parent": [
                    {
                         "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
                         "pkid": "6t0ggef2c0deab00hb595101"
                    }
               ],
               "device": [
                    {
                         "href": "",
                         "pkid": ""
                    }
               ],
               "foreign_key": []
          },
          "model_specific_actions": [
               "add",
               "bulk_update_form",
               "clone",
               "configuration_template",
               "export",
               "export_bulkload_template",
               "field_display_policy",
               "get",
               "help",
               "list",
               "migration",
               "transform",
               "remove",
               "tag",
               "tag_version",
               "update"
          ],
          "schema_version": "1.1",
          "actions": [
               {
                    "add": {
                         "method": "GET",
                         "class": "add",
                         "href": "/api/data/MeetingRoomUnifiedRoom/add/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Add"
                    }
               },
               {
                    "remove": {
                         "method": "DELETE",
                         "class": "delete",
                         "href": "/api/data/MeetingRoomUnifiedRoom/?hierarchy=[hierarchy]",
                         "support_async": true,
                         "title": "Delete"
                    }
               },
               {
                    "bulk_update_form": {
                         "method": "GET",
                         "class": "update",
                         "href": "/api/data/MeetingRoomUnifiedRoom/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
                         "support_async": false,
                         "title": "Bulk Modify"
                    }
               },
               {
                    "export": {
                         "method": "POST",
                         "class": "export",
                         "href": "/api/data/MeetingRoomUnifiedRoom/export/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Export",
                         "view": "/api/view/ExportData/add/?auth_token=[authtoken],
                         "submit": "payload"
                    }
               },
               {
                    "export_bulkload_template": {
                         "method": "POST",
                         "class": "bulkload_template",
                         "href": "/api/data/MeetingRoomUnifiedRoom/export_bulkload_template/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Export Bulk Load Template"
                    }
               },
               {
                    "tag": {
                         "method": "PATCH",
                         "class": "tag",
                         "href": "/api/data/MeetingRoomUnifiedRoom/+tag/?hierarchy=[hierarchy]",
                         "support_async": true,
                         "title": "Tag",
                         "view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
                    }
               },
               {
                    "tag_version": {
                         "method": "PATCH",
                         "class": "tag_version",
                         "href": "/api/data/MeetingRoomUnifiedRoom/+tag_version/?hierarchy=[hierarchy]",
                         "support_async": true,
                         "title": "Tag Version",
                         "view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
                    }
               },
               {
                    "configuration_template": {
                         "method": "GET",
                         "class": "config",
                         "href": "/api/data/MeetingRoomUnifiedRoom/configuration_template/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Configuration Template"
                    }
               },
               {
                    "field_display_policy": {
                         "method": "GET",
                         "class": "display_policy",
                         "href": "/api/data/MeetingRoomUnifiedRoom/field_display_policy/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Field Display Policy"
                    }
               },
               {
                    "migration": {
                         "method": "GET",
                         "class": "migration",
                         "href": "/api/data/MeetingRoomUnifiedRoom/migration/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Migration Template"
                    }
               },
               {
                    "list": {
                         "method": "GET",
                         "class": "list",
                         "href": "/api/data/MeetingRoomUnifiedRoom/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "List"
                    }
               },
               {
                    "help": {
                         "method": "GET",
                         "class": "help",
                         "href": "/api/data/MeetingRoomUnifiedRoom/help?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Help"
                    }
               },
               {
                    "transform": {
                         "method": "GET",
                         "class": "transform",
                         "href": "/api/data/MeetingRoomUnifiedRoom/transform/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Transform Template"
                    }
               }
          ]
     },
     "resources": []
}

Task	Call	URL	Parameters	Response
Get the on-line Help for data/MeetingRoomUnifiedRoom.	GET	/api/data/MeetingRoomUnifiedRoom/help	hierarchy=[hierarchy]	On-line help of Model ref.: data/MeetingRoomUnifiedRoom as HTML

Task	Call	URL	Parameters	Response
Transform Template	GET	/api/data/MeetingRoomUnifiedRoom/transform/	hierarchy=[hierarchy] format=json

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Payload
Modify	PUT	/api/data/MeetingRoomUnifiedRoom/[pkid]	hierarchy=[hierarchy]	(For payload specification)

For Bulk modification, refer to the Bulk Modify section.

Task	Call	URL	Parameters	Response
Delete	DELETE	/api/data/MeetingRoomUnifiedRoom/[pkid]	hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Clone instance with [pkid]. The schema rules are applied.	GET	/api/data/MeetingRoomUnifiedRoom/[pkid]/clone/?schema=&schema_rules=true	hierarchy=[hierarchy]	A JSON payload with: A POST action URL. The unchanged model [pkid] payload to be modified to create a new instance.

For the instance pkids that can cloned, refer to the List GET call for data/MeetingRoomUnifiedRoom

GET http://[host-proxy]/api/data/MeetingRoomUnifiedRoom/?hierarchy=[hierarchy]&format=json

Use the POST action in the response with a modification of the response payload to create the clone.

Task	Call	URL	Parameters	Response
Get a selected [export_format] of the schema and a single instance with [pkid] of data/MeetingRoomUnifiedRoom; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/data/MeetingRoomUnifiedRoom/[pkid]/export	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	The response is an attachment. Refer to the list below.

For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=json, the response is a time stamped zip file of data in JSON and a response format:

        Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
        Content-Language:en
        Content-Type:application/x-zip

The XLSX format can be used to bulk load instances of data/MeetingRoomUnifiedRoom and the JSON format can be used to import instances of data/MeetingRoomUnifiedRoom.

For Bulk Export, refer to the Bulk Export section.

Task	Call	URL	Parameters	Payload
Tag	PATCH	/api/data/MeetingRoomUnifiedRoom/[pkid]/+tag	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Response
Get	GET	/api/data/MeetingRoomUnifiedRoom/[pkid]	hierarchy=[hierarchy]	The data/MeetingRoomUnifiedRoom instance with [pkid].

Task	Call	URL	Parameters	Response
Help	GET	/api/data/MeetingRoomUnifiedRoom/[pkid]/help	hierarchy=[hierarchy]	The on-line Help for data/MeetingRoomUnifiedRoom.

API Reference for data/MeetingRoomUnifiedRoom

GET http://[host-proxy]/api/data/MeetingRoomUnifiedRoom/schema/?hierarchy=[hierarchy]&format=json&schema=1

Get the Add form

Create

Bulk Delete

Bulk Modify

Bulk Export

Export Bulk Load Template

Tag

Tag Version

Configuration Template

Field Display Policy

Migration Template

List

GET http://[host]/api/data/MeetingRoomUnifiedRoom/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Transform Template

Instance API Reference

Modify

Delete

Clone

Export

Tag

Get

Help