[Index]

API Reference for data/MeetingRoomUtilization

Unified hourly meeting room utilization, quality, and remote presence across platforms.

Model ref.: data/MeetingRoomUtilization

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/MeetingRoomUtilization/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema",
     "type": "object",
     "properties": {
          "timestamp_interval": {
               "title": "Timestamp Interval",
               "description": "Hour bucket start (UTC).",
               "type": "string",
               "format": "date-time",
               "required": true,
               "maxLength": 1024
          },
          "timestamp_epoch": {
               "title": "Timestamp Epoch",
               "description": "Unix time for the hour bucket (UTC).",
               "type": "integer"
          },
          "arbitrator_ip": {
               "title": "Arbitrator IP",
               "description": "Vendor media/arbitrator IP when available.",
               "type": "string",
               "maxLength": 1024
          },
          "year": {
               "title": "Year",
               "description": "Calendar year (UTC) of bucket.",
               "type": "integer"
          },
          "month": {
               "title": "Month",
               "description": "Calendar month (UTC) of bucket.",
               "type": "integer"
          },
          "day": {
               "title": "Day",
               "description": "Day of month (UTC) of bucket.",
               "type": "integer"
          },
          "hour": {
               "title": "Hour",
               "description": "Hour of day (0\u201323, UTC) of bucket.",
               "type": "integer",
               "minimum": 0,
               "maximum": 23
          },
          "vendor": {
               "title": "Vendor",
               "description": "Platform family (e.g., microsoft, cisco).",
               "type": "string",
               "maxLength": 1024
          },
          "source_platform": {
               "title": "Source Platform",
               "description": "Session type (e.g., teams_meeting, webex_meeting, webex_call).",
               "type": "string",
               "maxLength": 1024
          },
          "room_name": {
               "title": "Room Name",
               "description": "Human name of the room/workspace.",
               "type": "string",
               "maxLength": 1024
          },
          "room_email": {
               "title": "Room Email",
               "description": "Room mailbox address used for mapping.",
               "type": "string",
               "maxLength": 1024
          },
          "unified_room_id": {
               "title": "Unified Room ID",
               "description": "Internal canonical room ID.",
               "type": "string",
               "maxLength": 1024
          },
          "site": {
               "title": "Site",
               "description": "Site/campus identifier.",
               "type": "string",
               "maxLength": 1024
          },
          "building": {
               "title": "Building",
               "description": "Building identifier.",
               "type": "string",
               "maxLength": 1024
          },
          "capacity": {
               "title": "Capacity",
               "description": "Seating capacity.",
               "type": "integer",
               "minimum": 0
          },
          "size_category_key": {
               "title": "Size Category Key",
               "description": "Stable size band key (e.g., small, medium, large).",
               "type": "string",
               "maxLength": 1024
          },
          "size_category_title": {
               "title": "Size Category Title",
               "description": "Display label for size band.",
               "type": "string",
               "maxLength": 1024
          },
          "total_calls": {
               "title": "Total Calls",
               "description": "Distinct sessions overlapping the hour.",
               "type": "integer",
               "minimum": 0
          },
          "total_participants": {
               "title": "Total Participants",
               "description": "Sum of per-session participant counts in the hour.",
               "type": "integer",
               "minimum": 0
          },
          "total_duration_seconds": {
               "title": "Total Duration (s)",
               "description": "Sum of per-session overlap seconds in the hour.",
               "type": "integer",
               "minimum": 0
          },
          "audio_calls": {
               "title": "Audio Calls",
               "description": "Sessions using audio.",
               "type": "integer",
               "minimum": 0
          },
          "video_calls": {
               "title": "Video Calls",
               "description": "Sessions using video.",
               "type": "integer",
               "minimum": 0
          },
          "vbss_calls": {
               "title": "Sharing Calls",
               "description": "Sessions with content sharing.",
               "type": "integer",
               "minimum": 0
          },
          "audio_poor_calls": {
               "title": "Audio Poor Calls",
               "description": "Audio sessions flagged poor.",
               "type": "integer",
               "minimum": 0
          },
          "audio_good_calls": {
               "title": "Audio Good Calls",
               "description": "Audio sessions not flagged poor.",
               "type": "integer",
               "minimum": 0
          },
          "video_poor_calls": {
               "title": "Video Poor Calls",
               "description": "Video sessions flagged poor.",
               "type": "integer",
               "minimum": 0
          },
          "video_good_calls": {
               "title": "Video Good Calls",
               "description": "Video sessions not flagged poor.",
               "type": "integer",
               "minimum": 0
          },
          "vbss_poor_calls": {
               "title": "Sharing Poor Calls",
               "description": "Sharing sessions flagged poor.",
               "type": "integer",
               "minimum": 0
          },
          "vbss_good_calls": {
               "title": "Sharing Good Calls",
               "description": "Sharing sessions not flagged poor.",
               "type": "integer",
               "minimum": 0
          },
          "is_room_meeting": {
               "title": "Is Room Meeting",
               "description": "True if any session maps to a unified_room_id.",
               "type": "boolean"
          },
          "is_non_room_meeting": {
               "title": "Is Non-room Meeting",
               "description": "True if any session lacks a room mapping.",
               "type": "boolean"
          },
          "audio_poor_rate": {
               "title": "Audio Poor Rate",
               "description": "audio_poor_calls / NULLIF(audio_calls, 0).",
               "type": "number",
               "minimum": 0
          },
          "video_poor_rate": {
               "title": "Video Poor Rate",
               "description": "video_poor_calls / NULLIF(video_calls, 0).",
               "type": "number",
               "minimum": 0
          },
          "vbss_poor_rate": {
               "title": "Sharing Poor Rate",
               "description": "vbss_poor_calls / NULLIF(vbss_calls, 0).",
               "type": "number",
               "minimum": 0
          },
          "quality_score": {
               "title": "Quality Score",
               "description": "100 - 100 * (poor_sessions / total_sessions).",
               "type": "number",
               "minimum": 0,
               "maximum": 100
          },
          "avg_participants_per_call": {
               "title": "Avg Participants per Call",
               "description": "total_participants / NULLIF(total_calls, 0).",
               "type": "number",
               "minimum": 0
          },
          "avg_duration_seconds_per_call": {
               "title": "Avg Duration (s) per Call",
               "description": "total_duration_seconds / NULLIF(total_calls, 0).",
               "type": "number",
               "minimum": 0
          },
          "date_day": {
               "title": "Local Date (Day)",
               "description": "Site local calendar day.",
               "type": "string",
               "format": "date",
               "maxLength": 1024
          },
          "date_week": {
               "title": "Local Week Start",
               "description": "Local week bucket (date_trunc('week', local)).",
               "type": "string",
               "format": "date-time",
               "maxLength": 1024
          },
          "date_month": {
               "title": "Local Month Start",
               "description": "Local month bucket (date_trunc('month', local)).",
               "type": "string",
               "format": "date-time",
               "maxLength": 1024
          },
          "day_of_week": {
               "title": "Day of Week",
               "description": "Local day-of-week (0=Sun..6=Sat).",
               "type": "integer",
               "minimum": 0,
               "maximum": 6
          },
          "is_business_hours": {
               "title": "Is Business Hours",
               "description": "True if bucket falls inside configured business hours.",
               "type": "boolean"
          },
          "hours_utilized": {
               "title": "Hours Utilized",
               "description": "total_duration_seconds / 3600.0.",
               "type": "number",
               "minimum": 0
          },
          "remote_participants": {
               "title": "Remote Participants",
               "description": "Sum of non-room participants in the hour.",
               "type": "integer",
               "minimum": 0
          },
          "has_remote_any": {
               "title": "Has Remote Any",
               "description": "True if any session had remote participants.",
               "type": "boolean"
          },
          "computed_at": {
               "title": "Computed At",
               "description": "When this row was (re)computed.",
               "type": "string",
               "format": "date-time",
               "maxLength": 1024
          },
          "last_collected_timestamp": {
               "title": "Last Collected Timestamp",
               "description": "Timestamp when data was last collected.",
               "type": "string",
               "format": "date-time",
               "maxLength": 1024
          },
          "last_collected_epoch": {
               "title": "Last Collected Epoch",
               "description": "Unix time when data was last collected.",
               "type": "integer"
          },
          "total_duration_minutes": {
               "title": "Total Duration (minutes)",
               "description": "Total duration in minutes.",
               "type": "number",
               "minimum": 0
          },
          "total_duration_hours": {
               "title": "Total Duration (hours)",
               "description": "Total duration in hours.",
               "type": "number",
               "minimum": 0
          },
          "avg_duration_minutes_per_call": {
               "title": "Avg Duration (minutes) per Call",
               "description": "Average duration in minutes per call.",
               "type": "number",
               "minimum": 0
          },
          "avg_duration_hours_per_call": {
               "title": "Avg Duration (hours) per Call",
               "description": "Average duration in hours per call.",
               "type": "number",
               "minimum": 0
          },
          "day_of_week_name": {
               "title": "Day of Week Name",
               "description": "Local day-of-week name (e.g., Sunday, Monday).",
               "type": "string",
               "maxLength": 1024
          },
          "has_business_hours_config": {
               "title": "Has Business Hours Config",
               "description": "Indicates if business hours configuration exists.",
               "type": "string",
               "maxLength": 1024
          },
          "is_business_holiday": {
               "title": "Is Business Holiday",
               "description": "Indicates if this is a business holiday.",
               "type": "string",
               "maxLength": 1024
          },
          "holiday_name": {
               "title": "Holiday Name",
               "description": "Name of the holiday if applicable.",
               "type": "string",
               "maxLength": 1024
          },
          "meeting_was_booked": {
               "title": "Meeting Was Booked",
               "description": "Number of distinct bookings for the room in the hour.",
               "type": "integer",
               "minimum": 0
          },
          "meeting_was_not_booked": {
               "title": "Meeting Was Not Booked",
               "description": "Number of times the meeting was used without a booking in the hour.",
               "type": "integer",
               "minimum": 0
          },
          "people_count": {
               "title": "People Count",
               "description": "Average number of people using the room in the hour.",
               "type": "number",
               "minimum": 0
          },
          "reported_capacity": {
               "title": "Reported Capacity",
               "description": "Room capacity (should match spark/place for validation).",
               "type": "integer",
               "minimum": 0
          },
          "room_occupancy_percentage": {
               "title": "Room Occupancy Percentage",
               "description": "Percentage of room capacity utilized.",
               "type": "number",
               "minimum": 0
          },
          "time_used": {
               "title": "Time Used",
               "description": "Number of minutes the room was used in the hour.",
               "type": "integer",
               "minimum": 0
          },
          "time_booked": {
               "title": "Time Booked",
               "description": "Number of minutes the room was booked in the hour.",
               "type": "integer",
               "minimum": 0
          },
          "booked_with_people_in_room": {
               "title": "Booked With People In Room",
               "description": "Number of times the room was booked and had people in the room in the hour.",
               "type": "integer",
               "minimum": 0
          },
          "booked_no_show": {
               "title": "Booked No Show",
               "description": "Number of times the room was booked but had no call in the hour.",
               "type": "integer",
               "minimum": 0
          },
          "not_booked_with_people_in_room": {
               "title": "Not Booked With People In Room",
               "description": "Number of times the room was not booked but people were in the room.",
               "type": "integer",
               "minimum": 0
          },
          "device_joined_meeting": {
               "title": "Device Joined Meeting",
               "description": "True if the room device joined the call.",
               "type": "integer",
               "minimum": 0
          },
          "meeting_usage_percentage": {
               "title": "Meeting Usage Percentage",
               "description": "Percentage of time the room was used for meetings.",
               "type": "number",
               "minimum": 0
          },
          "meeting_usage_category_title": {
               "title": "Meeting Usage Category Title",
               "description": "Display label for the meeting usage category band.",
               "type": "string",
               "maxLength": 1024
          }
     },
     "schema_version": "1.0"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/data/MeetingRoomUtilization/add/	hierarchy=[hierarchy] format=json	The GUI Add form of data/MeetingRoomUtilization 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/MeetingRoomUtilization	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/MeetingRoomUtilization/	hierarchy=[hierarchy]	{"hrefs":["/api/data/MeetingRoomUtilization/[pkid1]", "/api/data/MeetingRoomUtilization/[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/MeetingRoomUtilization
```
GET http://[host-proxy]/api/data/MeetingRoomUtilization/?hierarchy=[hierarchy]&format=json
```

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

Task	Call	URL	Parameters	Payload
Bulk Modify	POST	/api/data/MeetingRoomUtilization/bulk_update/	hierarchy=[hierarchy] format=json	For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/MeetingRoomUtilization/[pkid1]", "/api/v0/data/MeetingRoomUtilization/[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/MeetingRoomUtilization/?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/MeetingRoomUtilization; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/data/MeetingRoomUtilization/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/data/MeetingRoomUtilization/[pkid1]", "/api/data/MeetingRoomUtilization/[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/MeetingRoomUtilization and the JSON format can be used to import instances of data/MeetingRoomUtilization.

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

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

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

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

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

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/data/MeetingRoomUtilization/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/MeetingRoomUtilization/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/MeetingRoomUtilization/migration/	hierarchy=[hierarchy] format=json

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

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

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

{
     "pagination": {
          "skip": 0,
          "limit": 3,
          "maximum_limit": 2000,
          "total": 0,
          "total_limit": null,
          "order_by": "site",
          "direction": "asc",
          "current": "/api/data/MeetingRoomUtilization/?skip=0&limit=3&order_by=site&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/MeetingRoomUtilization",
          "summary_attrs": [
               {
                    "name": "site",
                    "title": "Site"
               },
               {
                    "name": "building",
                    "title": "Building"
               },
               {
                    "name": "room_name",
                    "title": "Room Name"
               },
               {
                    "name": "unified_room_id",
                    "title": "Unified Room ID"
               },
               {
                    "name": "timestamp_interval",
                    "title": "Timestamp Interval"
               },
               {
                    "name": "day_of_week",
                    "title": "Day of Week"
               },
               {
                    "name": "is_business_hours",
                    "title": "Is Business Hours"
               },
               {
                    "name": "hours_utilized",
                    "title": "Hours Utilized"
               },
               {
                    "name": "total_calls",
                    "title": "Total Calls"
               },
               {
                    "name": "total_participants",
                    "title": "Total Participants"
               },
               {
                    "name": "quality_score",
                    "title": "Quality Score"
               },
               {
                    "name": "hierarchy_friendly_name",
                    "title": "Located At",
                    "allow_filtering": true
               }
          ],
          "tagged_versions": [],
          "tags": [],
          "title": "? - ?",
          "business_key": {
               "unique": [
                    "unified_room_id",
                    "timestamp_interval"
               ]
          },
          "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.0",
          "actions": [
               {
                    "add": {
                         "method": "GET",
                         "class": "add",
                         "href": "/api/data/MeetingRoomUtilization/add/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Add"
                    }
               },
               {
                    "remove": {
                         "method": "DELETE",
                         "class": "delete",
                         "href": "/api/data/MeetingRoomUtilization/?hierarchy=[hierarchy]",
                         "support_async": true,
                         "title": "Delete"
                    }
               },
               {
                    "bulk_update_form": {
                         "method": "GET",
                         "class": "update",
                         "href": "/api/data/MeetingRoomUtilization/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
                         "support_async": false,
                         "title": "Bulk Modify"
                    }
               },
               {
                    "export": {
                         "method": "POST",
                         "class": "export",
                         "href": "/api/data/MeetingRoomUtilization/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/MeetingRoomUtilization/export_bulkload_template/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Export Bulk Load Template"
                    }
               },
               {
                    "tag": {
                         "method": "PATCH",
                         "class": "tag",
                         "href": "/api/data/MeetingRoomUtilization/+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/MeetingRoomUtilization/+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/MeetingRoomUtilization/configuration_template/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Configuration Template"
                    }
               },
               {
                    "field_display_policy": {
                         "method": "GET",
                         "class": "display_policy",
                         "href": "/api/data/MeetingRoomUtilization/field_display_policy/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Field Display Policy"
                    }
               },
               {
                    "migration": {
                         "method": "GET",
                         "class": "migration",
                         "href": "/api/data/MeetingRoomUtilization/migration/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Migration Template"
                    }
               },
               {
                    "list": {
                         "method": "GET",
                         "class": "list",
                         "href": "/api/data/MeetingRoomUtilization/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "List"
                    }
               },
               {
                    "help": {
                         "method": "GET",
                         "class": "help",
                         "href": "/api/data/MeetingRoomUtilization/help?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Help"
                    }
               },
               {
                    "transform": {
                         "method": "GET",
                         "class": "transform",
                         "href": "/api/data/MeetingRoomUtilization/transform/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Transform Template"
                    }
               }
          ]
     },
     "resources": []
}

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

Task	Call	URL	Parameters	Response
Transform Template	GET	/api/data/MeetingRoomUtilization/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/MeetingRoomUtilization/[pkid]	hierarchy=[hierarchy]	(For payload specification)

For Bulk modification, refer to the Bulk Modify section.

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

Task	Call	URL	Parameters	Response
Clone instance with [pkid]. The schema rules are applied.	GET	/api/data/MeetingRoomUtilization/[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/MeetingRoomUtilization

GET http://[host-proxy]/api/data/MeetingRoomUtilization/?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/MeetingRoomUtilization; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/data/MeetingRoomUtilization/[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/MeetingRoomUtilization and the JSON format can be used to import instances of data/MeetingRoomUtilization.

For Bulk Export, refer to the Bulk Export section.

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

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

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

API Reference for data/MeetingRoomUtilization

GET http://[host-proxy]/api/data/MeetingRoomUtilization/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/MeetingRoomUtilization/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Transform Template

Instance API Reference

Modify

Delete

Clone

Export

Tag

Get

Help