[Index]
Model ref.: device/spark/Place
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"input_devices": {
"items": {
"type": "object",
"properties": {
"Profile": {
"target": "/api/data/RoomosDeviceConfigurationProfile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": true,
"convert_to_primary_key": true,
"choices": [],
"target_attr": "name",
"target_model_type": "data/RoomosDeviceConfigurationProfile",
"title": "Profile",
"type": "string"
},
"IP": {
"required": true,
"type": "string",
"title": "IP Address"
},
"username": {
"type": "string",
"description": "Defaults to admin",
"title": "Username"
},
"password": {
"is_password": true,
"type": "string",
"description": "Defaults to empty string",
"title": "Password"
}
}
},
"type": "array",
"title": "Devices"
},
"associated_devices": {
"name": "associated_devices",
"title": "Associated Devices",
"cache_only": true,
"readonly": true,
"type": "string",
"description": "The product type of the devices associated with this place."
},
"capacity": {
"type": "integer",
"description": "How many people the workspace is suitable for.",
"title": "Capacity"
},
"created": {
"readonly": true,
"type": "string",
"title": "Date Created"
},
"device_activation_code_expiry_date": {
"name": "device_activation_code_expiry_date",
"format": "date-time",
"title": "Device Activation Code Expiration Date",
"cache_only": true,
"readonly": true,
"type": "string",
"description": "The expiration date for the activation code."
},
"notes": {
"type": "string",
"title": "Notes"
},
"supportedDevices": {
"choices": [
{
"value": "collaborationDevices",
"title": "Collaboration devices"
},
{
"value": "phones",
"title": "MPP phones"
}
],
"type": "string",
"title": "Hot Desking Status"
},
"hotdeskingStatus": {
"choices": [
{
"value": "on",
"title": "On"
},
{
"value": "off",
"title": "Off"
}
],
"type": "string",
"title": "Hot Desking Status"
},
"phoneNumbers": {
"items": {
"type": "object",
"properties": {
"external": {
"readonly": true,
"type": "string",
"title": "External"
},
"extension": {
"readonly": true,
"type": "string",
"title": "Extension"
},
"primary": {
"readonly": true,
"type": "boolean",
"title": "Primary"
}
}
},
"readonly": true,
"type": "array",
"title": "Phone Numbers"
},
"floorId": {
"type": "string",
"title": "Floor"
},
"calling": {
"type": "object",
"properties": {
"subscriber_pkid": {
"cache_only": true,
"title": "Subscriber PKID",
"type": "string",
"name": "subscriber_pkid",
"description": "Internal field for the subscriber ID."
},
"directory_number": {
"cache_only": true,
"title": "Directory Number",
"type": "string",
"name": "directory_number",
"description": "Enter the DN to be used with the Unified CM account. This DN is used for hybrid calling."
},
"site": {
"cache_only": true,
"title": "Site",
"type": "string",
"name": "site",
"description": "Select the Site where the associated Unifed CM user will be created. The Webex Teams places and devices will automatically be moved to this site."
},
"site_pkid": {
"cache_only": true,
"type": "string",
"name": "site_pkid",
"title": "Site Pkid"
},
"subscriber_link": {
"description": "Jump to the associated subscriber page.",
"title": "Link to Subscriber",
"format": "link",
"cache_only": true,
"type": "string",
"name": "subscriber_link"
},
"hybridCalling": {
"type": "object",
"properties": {
"emailAddress": {
"pattern": "(^$|^([^.@]+)(\\.[^.@]+)*@([^.@]+\\.)+([^.@]+)$)",
"title": "End user email address in Cisco Unified CM",
"type": "string",
"name": "emailAddress",
"description": "Enter the Mail ID below to connect this place to the existing Unified CM account. This Mail ID ensures that the correct user account is connected with this place for hybrid calling. A default domain must be configured on the Webex Teams account to dervice this email address."
}
},
"title": "Hybrid Calling Settings"
},
"type": {
"name": "type",
"title": "Calling Behaviour",
"default": "freeCalling",
"choices": [
{
"value": "none",
"title": "No Calling"
},
{
"value": "freeCalling",
"title": "Free Calling (default)"
},
{
"value": "webexCalling",
"title": "Webex Calling"
},
{
"value": "thirdPartySipCalling",
"title": "Third-party SIP URI"
},
{
"value": "webexEdgeForDevices",
"title": "Webex Edge For Devices"
}
],
"type": "string",
"description": "This determines how calls are made from this place."
}
},
"title": "Calling"
},
"device_activation_code": {
"name": "device_activation_code",
"title": "Device Activation Code",
"cache_only": true,
"readonly": true,
"type": "string",
"description": "The activation code for registering and associating a device with this place."
},
"workspaceLocationId": {
"target": "/api/device/spark/WorkspaceLocation/choices/?field=displayName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Location",
"convert_to_primary_key": true,
"choices": [],
"target_attr": "displayName",
"target_model_type": "device/spark/WorkspaceLocation",
"type": "string"
},
"orgId": {
"type": "string",
"title": "Organization ID"
},
"calendar": {
"type": "object",
"properties": {
"emailAddress": {
"title": "Workspace email address",
"type": "string",
"name": "emailAddress",
"description": "This is the email address that will be used to connect to the hybrid calendar service."
},
"type": {
"name": "type",
"title": "Calendar Type",
"default": "none",
"choices": [
{
"value": "none",
"title": "None"
},
{
"value": "microsoft",
"title": "Microsoft Exchange / Office 365"
},
{
"value": "google",
"title": "Google Calendar"
}
],
"type": "string",
"description": "Which calendar provider do you want to use?."
}
},
"title": "Calendar"
},
"workspace_hierarchy_node_type": {
"name": "workspace_hierarchy_node_type",
"title": "Workspace hierarchy node type",
"cache_only": true,
"readonly": true,
"type": "string",
"description": "The hierarchy node type where this workspace is located."
},
"displayName": {
"required": true,
"type": "string",
"description": "A friendly name for the workspace.",
"title": "Name"
},
"sipAddress": {
"readonly": true,
"type": "string",
"description": "SipUrl to call all the devices associated with the workspace.",
"title": "SIP Address"
},
"type": {
"choices": [
{
"value": "",
"title": "No workspace type set"
},
{
"value": "desk",
"title": "Desk - individual"
},
{
"value": "focus",
"title": "Focus - high concentration"
},
{
"value": "huddle",
"title": "Huddle - brainstorm/collaboration"
},
{
"value": "meetingRoom",
"title": "Meeting Room - dedicated meeting space"
},
{
"value": "open",
"title": "Open Space"
},
{
"value": "other",
"title": "Other"
}
],
"type": "string",
"description": "The workspace type.",
"title": "Type"
},
"id": {
"readonly": true,
"type": "string",
"title": "Id"
}
},
"schema_version": "1.0.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/spark/Place/add/ |
|
The GUI Add form of device/spark/Place 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/device/spark/Place | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/device/spark/Place/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/spark/Place/[pkid1]", "/api/device/spark/Place/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/spark/Place/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/spark/Place/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/spark/Place/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/spark/Place/[pkid1]", "/api/v0/device/spark/Place/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/spark/Place/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/spark/Place |
|
{"hrefs": ["/api/device/spark/Place/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/spark/Place |
|
{"hrefs": ["/api/device/spark/Place/[pkid1]", "/api/device/spark/Place/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/spark/Place; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/spark/Place/export/ |
|
{ "hrefs":["/api/device/spark/Place/[pkid1]", "/api/device/spark/Place/[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 device/spark/Place and the JSON format can be used to import instances of device/spark/Place.
GET http://[host-proxy]/api/device/spark/Place/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/spark/Place | POST | /api/device/spark/Place/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/device/spark/Place/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/spark/Place/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/device/spark/Place/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/spark/Place/ |
|
The device/spark/Place schema and all instances as JSON. |
(The list will return 0 to 3 device/spark/Place instances)
{
"operations": [
"list"
],
"pagination": {
"direction": "asc",
"order_by": "displayName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/spark/Place/?skip=0&limit=3&order_by=displayName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 18
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "1.0.0",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/device/spark/Place/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/spark/Place/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/spark/Place/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Bulk Modify"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/spark/Place",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/spark/Place/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/device/spark/Place/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/spark/Place/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/device/spark/Place/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/spark/Place/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/spark/Place/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"migration": {
"support_async": false,
"class": "migration",
"href": "/api/device/spark/Place/migration/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Migration Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/spark/Place/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/spark/Place/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/spark/Place/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
},
{
"transform": {
"support_async": false,
"class": "transform",
"href": "/api/device/spark/Place/transform/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Transform Template"
}
}
],
"model_type": "device/spark/Place",
"model_specific_actions": [
"list",
"get",
"add",
"update",
"remove",
"move",
"clone",
"export",
"export_bulkload_template",
"bulk_update_form",
"configuration_template",
"field_display_policy",
"help",
"migration",
"transform",
"tag",
"tag_version"
],
"summary_attrs": [
{
"name": "displayName",
"title": "Name"
},
{
"name": "capacity",
"title": "Capacity"
},
{
"name": "type",
"title": "Type"
},
{
"name": "sipAddress",
"title": "SIP Address"
},
{
"name": "associated_devices",
"title": "Associated Devices"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "calling.type",
"title": "Calling Behaviour"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "calling.directory_number",
"title": "Directory Number"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "calendar.type",
"title": "Calendar Type"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "calendar.emailAddress",
"title": "Workspace email address"
},
{
"name": "workspaceLocationId",
"title": "Location"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "65e09a1d6fd4534903e3fbcd",
"meta": {
"tags": [],
"cached": true,
"title": "Room-10-5",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "65e0918d6fd4534903e212ec",
"href": "/api/v0/data/Spark/65e0918d6fd4534903e212ec"
}
],
"self": [
{
"pkid": "65e09a1d6fd4534903e3fbcd",
"href": "/api/device/spark/Place/65e09a1d6fd4534903e3fbcd/"
}
],
"parent": [
{
"pkid": "6130d69ae04a4a0015a93bc6",
"href": "/api/data/HierarchyNode/6130d69ae04a4a0015a93bc6"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/spark/Place/65e09a1d6fd4534903e3fbcd/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/spark/Place/65e09a1d6fd4534903e3fbcd/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/spark/Place/65e09a1d6fd4534903e3fbcd/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/65e09a1d6fd4534903e3fbcd/?model_type=device/spark/Place",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/spark/Place/65e09a1d6fd4534903e3fbcd/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/spark/Place/65e09a1d6fd4534903e3fbcd/+tag/",
"class": "tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/device/spark/Place/65e09a1d6fd4534903e3fbcd/+tag_version/",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/spark/Place/65e09a1d6fd4534903e3fbcd/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/spark/Place/65e09a1d6fd4534903e3fbcd/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/spark/Place/65e09a1d6fd4534903e3fbcd/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/spark/Place",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"6130d69ae04a4a0015a93bc6",
"65e09a1d6fd4534903e3fbcd"
],
"summary_attrs": [
{
"name": "displayName",
"title": "Name"
},
{
"name": "capacity",
"title": "Capacity"
},
{
"name": "type",
"title": "Type"
},
{
"name": "sipAddress",
"title": "SIP Address"
},
{
"name": "associated_devices",
"title": "Associated Devices"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "calling.type",
"title": "Calling Behaviour"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "calling.directory_number",
"title": "Directory Number"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "calendar.type",
"title": "Calendar Type"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "calendar.emailAddress",
"title": "Workspace email address"
},
{
"name": "workspaceLocationId",
"title": "Location"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"phoneNumbers": [
{
"primary": true,
"extension": "4570"
}
],
"displayName": "Room-10-5",
"created": "2024-02-16T10:28:01.762Z",
"supportedDevices": "phones",
"hotdeskingStatus": "off",
"calling": {
"type": "webexCalling"
},
"associated_devices": "",
"workspaceLocationId": "VOSS-GBR-Ringwood",
"orgId": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLXdlc3QtMl9yL09SR0FOSVpBVElPTi81NjZmZTE4My1hZThhLTQ1OGMtYjNjMi1lZDUzMWU0MjE2Yzk=",
"calendar": {
"type": "none"
},
"capacity": 4,
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"summary_device": "Connection parameters for Spark Customer AAAGlobal, AAAGlobal, hcs.CS-P.CS-NB.AAAGlobal",
"type": "meetingRoom",
"id": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLXdlc3QtMl9yL1BMQUNFLzRlODk3NWYzLTc2MzEtNDUxZi05NDMxLTY4ZjYyNWIwYmExZg==",
"sipAddress": "[email protected]",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "65e09a946fd4534903e41ad2",
"meta": {
"tags": [],
"cached": true,
"title": "VOSS-Bournemouth-GroundFloor",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "65e0918d6fd4534903e212ec",
"href": "/api/v0/data/Spark/65e0918d6fd4534903e212ec"
}
],
"self": [
{
"pkid": "65e09a946fd4534903e41ad2",
"href": "/api/device/spark/Place/65e09a946fd4534903e41ad2/"
}
],
"parent": [
{
"pkid": "6130d69ae04a4a0015a93bc6",
"href": "/api/data/HierarchyNode/6130d69ae04a4a0015a93bc6"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/device/spark/Place/65e09a946fd4534903e41ad2/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/device/spark/Place/65e09a946fd4534903e41ad2/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/device/spark/Place/65e09a946fd4534903e41ad2/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/65e09a946fd4534903e41ad2/?model_type=device/spark/Place",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/spark/Place/65e09a946fd4534903e41ad2/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/device/spark/Place/65e09a946fd4534903e41ad2/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/device/spark/Place/65e09a946fd4534903e41ad2/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/spark/Place/65e09a946fd4534903e41ad2/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/spark/Place/65e09a946fd4534903e41ad2/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/spark/Place/65e09a946fd4534903e41ad2/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/spark/Place",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"6130d69ae04a4a0015a93bc6",
"65e09a946fd4534903e41ad2"
],
"summary_attrs": [
{
"name": "displayName",
"title": "Name"
},
{
"name": "capacity",
"title": "Capacity"
},
{
"name": "type",
"title": "Type"
},
{
"name": "sipAddress",
"title": "SIP Address"
},
{
"name": "associated_devices",
"title": "Associated Devices"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "calling.type",
"title": "Calling Behaviour"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "calling.directory_number",
"title": "Directory Number"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "calendar.type",
"title": "Calendar Type"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "calendar.emailAddress",
"title": "Workspace email address"
},
{
"name": "workspaceLocationId",
"title": "Location"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"associated_devices": "",
"displayName": "VOSS-Bournemouth-GroundFloor",
"created": "2023-10-25T18:46:13.525Z",
"supportedDevices": "collaborationDevices",
"hotdeskingStatus": "off",
"floorId": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLXdlc3QtMl9yL1dPUktTUEFDRV9MT0NBVElPTl9GTE9PUi82Yzc0ZDk5MC1iMzAzLTRkNjgtOWM1NC0zNDQ1MDFjYWI0Mjk=",
"calling": {
"type": "none"
},
"workspaceLocationId": "VOSS-GBR-Bournemouth",
"orgId": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLXdlc3QtMl9yL09SR0FOSVpBVElPTi81NjZmZTE4My1hZThhLTQ1OGMtYjNjMi1lZDUzMWU0MjE2Yzk=",
"id": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLXdlc3QtMl9yL1BMQUNFL2UzZmE3N2RjLWZhYjQtNDRjMi1iYTFkLTcxZWNkMGYwNWFlOA==",
"capacity": 30,
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"summary_device": "Connection parameters for Spark Customer AAAGlobal, AAAGlobal, hcs.CS-P.CS-NB.AAAGlobal",
"type": "open",
"calendar": {
"type": "none"
},
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "65e09bc26fd4534903e4618c",
"meta": {
"tags": [],
"cached": true,
"title": "VOSS-Bradford-MR-1",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "65e0918d6fd4534903e212ec",
"href": "/api/v0/data/Spark/65e0918d6fd4534903e212ec"
}
],
"self": [
{
"pkid": "65e09bc26fd4534903e4618c",
"href": "/api/device/spark/Place/65e09bc26fd4534903e4618c/"
}
],
"parent": [
{
"pkid": "6130d69ae04a4a0015a93bc6",
"href": "/api/data/HierarchyNode/6130d69ae04a4a0015a93bc6"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/device/spark/Place/65e09bc26fd4534903e4618c/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/device/spark/Place/65e09bc26fd4534903e4618c/",
"class": "delete",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/spark/Place/65e09bc26fd4534903e4618c/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/65e09bc26fd4534903e4618c/?model_type=device/spark/Place",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/device/spark/Place/65e09bc26fd4534903e4618c/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"class": "tag",
"href": "/api/device/spark/Place/65e09bc26fd4534903e4618c/+tag/",
"method": "PATCH",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"class": "tag_version",
"href": "/api/device/spark/Place/65e09bc26fd4534903e4618c/+tag_version/",
"method": "PATCH",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/spark/Place/65e09bc26fd4534903e4618c/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/spark/Place/65e09bc26fd4534903e4618c/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/spark/Place/65e09bc26fd4534903e4618c/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/spark/Place",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"6130d69ae04a4a0015a93bc6",
"65e09bc26fd4534903e4618c"
],
"summary_attrs": [
{
"name": "displayName",
"title": "Name"
},
{
"name": "capacity",
"title": "Capacity"
},
{
"name": "type",
"title": "Type"
},
{
"name": "sipAddress",
"title": "SIP Address"
},
{
"name": "associated_devices",
"title": "Associated Devices"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "calling.type",
"title": "Calling Behaviour"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "calling.directory_number",
"title": "Directory Number"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "calendar.type",
"title": "Calendar Type"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "calendar.emailAddress",
"title": "Workspace email address"
},
{
"name": "workspaceLocationId",
"title": "Location"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"associated_devices": "SAM S34J55x, Cisco Touch 10, Cisco Room Kit Mini",
"displayName": "VOSS-Bradford-MR-1",
"created": "2023-04-25T14:25:40.674Z",
"supportedDevices": "collaborationDevices",
"hotdeskingStatus": "off",
"floorId": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLXdlc3QtMl9yL1dPUktTUEFDRV9MT0NBVElPTl9GTE9PUi9lMzZlYzM1NC1hZTIzLTQyOTAtOTNlZi0zYjNhZTc5MWNjM2Y=",
"calling": {
"type": "freeCalling"
},
"workspaceLocationId": "VOSS-GBR-Bradford",
"orgId": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLXdlc3QtMl9yL09SR0FOSVpBVElPTi81NjZmZTE4My1hZThhLTQ1OGMtYjNjMi1lZDUzMWU0MjE2Yzk=",
"id": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLXdlc3QtMl9yL1BMQUNFL2Q5OTFhZDE1LTBmNmMtNGNhMS1hODM2LTQ5MjI3ZWNmMDcyYw==",
"capacity": 5,
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"summary_device": "Connection parameters for Spark Customer AAAGlobal, AAAGlobal, hcs.CS-P.CS-NB.AAAGlobal",
"type": "meetingRoom",
"calendar": {
"type": "none"
},
"sipAddress": "[email protected]",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
}
]
}
(Show the first instance)
{
"pkid": "65e09a1d6fd4534903e3fbcd",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "Room-10-5",
"business_key": {},
"schema_version": "",
"references": {
"parent": [
{
"pkid": "6130d69ae04a4a0015a93bc6",
"href": "/api/data/HierarchyNode/6130d69ae04a4a0015a93bc6"
}
],
"self": [
{
"pkid": "65e09a1d6fd4534903e3fbcd",
"href": "/api/device/spark/Place/65e09a1d6fd4534903e3fbcd/"
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "65e0918d6fd4534903e212ec",
"href": "/api/v0/data/Spark/65e0918d6fd4534903e212ec"
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/spark/Place/65e09a1d6fd4534903e3fbcd/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/spark/Place/65e09a1d6fd4534903e3fbcd/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/spark/Place/65e09a1d6fd4534903e3fbcd/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/65e09a1d6fd4534903e3fbcd/?hierarchy=[hierarchy]&model_type=device/spark/Place",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/spark/Place/65e09a1d6fd4534903e3fbcd/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/device/spark/Place/65e09a1d6fd4534903e3fbcd/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/device/spark/Place/65e09a1d6fd4534903e3fbcd/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/spark/Place/65e09a1d6fd4534903e3fbcd/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/spark/Place/65e09a1d6fd4534903e3fbcd/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/spark/Place/65e09a1d6fd4534903e3fbcd/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/spark/Place",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae236ce894e001204efa0",
"6130d69ae04a4a0015a93bc6",
"65e09a1d6fd4534903e3fbcd"
],
"summary_attrs": [
{
"name": "displayName",
"title": "Name"
},
{
"name": "capacity",
"title": "Capacity"
},
{
"name": "type",
"title": "Type"
},
{
"name": "sipAddress",
"title": "SIP Address"
},
{
"name": "associated_devices",
"title": "Associated Devices"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "calling.type",
"title": "Calling Behaviour"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "calling.directory_number",
"title": "Directory Number"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "calendar.type",
"title": "Calendar Type"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "calendar.emailAddress",
"title": "Workspace email address"
},
{
"name": "workspaceLocationId",
"title": "Location"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"sipAddress": "[email protected]",
"phoneNumbers": [
{
"primary": true,
"extension": "4570"
}
],
"displayName": "Room-10-5",
"created": "2024-02-16T10:28:01.762Z",
"supportedDevices": "phones",
"hotdeskingStatus": "off",
"calling": {
"type": "webexCalling"
},
"workspaceLocationId": "VOSS-GBR-Ringwood",
"orgId": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLXdlc3QtMl9yL09SR0FOSVpBVElPTi81NjZmZTE4My1hZThhLTQ1OGMtYjNjMi1lZDUzMWU0MjE2Yzk=",
"capacity": 4,
"calendar": {
"type": "none"
},
"type": "meetingRoom",
"id": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLXdlc3QtMl9yL1BMQUNFLzRlODk3NWYzLTc2MzEtNDUxZi05NDMxLTY4ZjYyNWIwYmExZg==",
"associated_devices": ""
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/spark/Place. | GET | /api/device/spark/Place/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/spark/Place as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/spark/Place/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/device/spark/Place/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/spark/Place/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/spark/Place/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/spark/Place | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of device/spark/Place; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/spark/Place/[pkid]/export |
|
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 device/spark/Place and the JSON format can be used to import instances of device/spark/Place.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/device/spark/Place/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/spark/Place/[pkid] | hierarchy=[hierarchy] | The device/spark/Place instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/spark/Place/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/spark/Place. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/spark/Place/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |