[Index]
This implements the relationship between a Webex Teams place and associated devices.
Model ref.: relation/WebexTeamsPlace
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": {
"sip_address": {
"type": "string",
"description": "The unique SIP address this place.",
"title": "SIP Address"
},
"capacity": {
"type": "integer",
"description": "How many people is the Workspace suitable for?",
"title": "Capacity"
},
"name": {
"required": true,
"type": "string",
"description": "Unique name for this place.",
"title": "Name"
},
"sparkplace": {
"type": "object",
"properties": {
"capacity": {
"type": "integer",
"title": "Capacity"
},
"created": {
"readonly": true,
"type": "string",
"title": "Date Created"
},
"orgId": {
"type": "string",
"title": "Organization ID"
},
"displayName": {
"required": true,
"type": "string",
"title": "Name"
},
"sipAddress": {
"readonly": true,
"type": "string",
"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",
"title": "Type"
},
"id": {
"type": "string",
"title": "Id"
}
},
"title": "Sparkplace"
},
"place_hierarchy_node_type": {
"type": "string",
"description": "This is a hidden field which is automatically popluated with the place's hierarchy type.",
"title": "Hierarchy Node Type"
},
"devices": {
"items": {
"type": "object",
"properties": {
"sipUrls": {
"readonly": true,
"type": "string",
"description": "All SIP addresses to dial this device.",
"title": "SIP URLs"
},
"product": {
"readonly": true,
"type": "string",
"description": "The product name.",
"title": "Product"
},
"upgradeChannel": {
"readonly": true,
"type": "string",
"description": "The upgrade channel the device is assigned to.",
"title": "Upgrade Channel"
},
"displayName": {
"readonly": true,
"type": "string",
"description": "A friendly name for the device.",
"title": "Name"
},
"tags": {
"readonly": true,
"type": "string",
"description": "Tags assigned to the device.",
"title": "Tags"
},
"personId": {
"description": "The person associated with the device.",
"format": "uri",
"title": "Person",
"convert_to_primary_key": true,
"choices": [],
"target_attr": "email",
"readonly": true,
"target_model_type": "device/spark/User",
"type": "string",
"target": "/api/device/spark/User/choices/?field=email&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"ip": {
"readonly": true,
"type": "string",
"description": "The current IP address of the device.",
"title": "IP Address"
},
"activeInterface": {
"readonly": true,
"type": "string",
"description": "The current network connectivty for the device.",
"title": "Active Interface"
},
"placeId": {
"description": "The place associated with the device.",
"format": "uri",
"title": "Place",
"convert_to_primary_key": true,
"choices": [],
"target_attr": "displayName",
"readonly": true,
"target_model_type": "device/spark/Place",
"type": "string",
"target": "/api/device/spark/Place/choices/?field=displayName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"capabilities": {
"readonly": true,
"type": "string",
"description": "The capabilities of the device.",
"title": "Capabilities"
},
"created": {
"readonly": true,
"type": "string",
"description": "The date and time that the device was registered, in ISO8601 format.",
"title": "Created"
},
"mac": {
"readonly": true,
"type": "string",
"description": "The unique address for the network adapter.",
"title": "MAC Address"
},
"primarySipUrl": {
"readonly": true,
"type": "string",
"description": "The primary SIP address to dial this device.",
"title": "Primary SIP URL"
},
"errorCodes": {
"readonly": true,
"type": "string",
"description": "This device has the following issues.",
"title": "Errors"
},
"orgId": {
"readonly": true,
"type": "string",
"description": "The organization associated with the device.",
"title": "Organization ID"
},
"connectionStatus": {
"readonly": true,
"type": "string",
"description": "The connection status of the device.",
"title": "Connection Status"
},
"link": {
"readonly": true,
"format": "link",
"type": "string",
"description": "Link to jump to the device details.",
"title": "Link"
},
"serial": {
"readonly": true,
"type": "string",
"description": "Serial number for the device.",
"title": "Serial"
},
"software": {
"readonly": true,
"type": "string",
"description": "The operating system name data and version tag.",
"title": "Software"
},
"id": {
"readonly": true,
"type": "string",
"description": "A unique identifier for the device.",
"title": "Id"
},
"permissions": {
"readonly": true,
"type": "string",
"description": "The permissions the user has for this device. For example, xapi means this user is entitled to using the xapi against this device.",
"title": "Permissions"
}
}
},
"type": "array",
"title": "Devices"
},
"calling": {
"type": "object",
"properties": {
"subscriber_pkid": {
"type": "string",
"description": "Internal field for the subscriber ID.",
"title": "Subscriber PKID"
},
"directory_number": {
"type": "string",
"description": "Enter the DN to be used with the Unified CM account. This DN is used for hybrid calling.",
"title": "Directory Number"
},
"site": {
"type": "string",
"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.",
"title": "Site"
},
"site_pkid": {
"type": "string",
"title": "Site Pkid"
},
"subscriber_link": {
"title": "Link to Subscriber",
"type": "string",
"description": "Jump to the associated subscriber page.",
"format": "link"
},
"mailid": {
"pattern": "(^$|^([^.@]+)(\\.[^.@]+)*@([^.@]+\\.)+([^.@]+)$)",
"type": "string",
"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": "Mail ID from Unified CM"
},
"calling_behaviour": {
"default": "Free Calling (default)",
"choices": [
{
"value": "Free Calling (default)",
"title": "Free Calling (default)"
},
{
"value": "Hybrid Calling",
"title": "Hybrid Calling"
}
],
"type": "string",
"description": "This determines how calls are made from this place.",
"title": "Calling Behaviour"
}
},
"title": "Calling"
},
"wt_device_code": {
"type": "string",
"description": "The activation code for registering and associating a device with this place.",
"title": "Device Activation Code"
},
"calendar": {
"type": "object",
"properties": {
"calendar": {
"type": "boolean",
"description": "Calendar service enables One Button To Push for this place.",
"title": "Calendar"
},
"hybrid_calendar_service": {
"title": "Hybrid Calendar Service",
"type": "string",
"description": "Which calendar provider do you want to use?.",
"choices": [
{
"value": "Microsoft Exchange / Office 365",
"title": "Microsoft Exchange / Office 365"
},
{
"value": "Google Calendar",
"title": "Google Calendar"
}
]
},
"email": {
"type": "string",
"description": "This is the email address that will be used to connect to the hybrid calendar service.",
"title": "Email address of the calendar mailbox"
}
},
"title": "Calendar"
},
"wt_device_code_email": {
"pattern": "^(\\s?[^\\s,]+@[^\\s,]+\\.[^\\s,]+\\s?,)*(\\s?[^\\s,]+@[^\\s,]+\\.[^\\s,]+)$",
"type": "string",
"description": "A comma separated list of email addresses the activation code will be sent to via a Webex Teams message.",
"title": "Send Device Activation Code To"
},
"type": {
"title": "Type",
"type": "string",
"description": "What type best describes the Workspace?",
"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"
}
]
},
"wt_device_code_expiry_date": {
"type": "string",
"description": "The expiration date for the activation code.",
"title": "Device Activation Code Expiration Date"
},
"wt_device_product": {
"type": "string",
"description": "The product type of the devices associated with this place.",
"title": "Contains"
}
},
"schema_version": "1.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/WebexTeamsPlace/add/ |
|
The GUI Add form of relation/WebexTeamsPlace 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/relation/WebexTeamsPlace/ | 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/relation/WebexTeamsPlace/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/WebexTeamsPlace/[pkid1]", "/api/relation/WebexTeamsPlace/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/WebexTeamsPlace/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/WebexTeamsPlace; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/WebexTeamsPlace/export/ |
|
{ "hrefs":["/api/relation/WebexTeamsPlace/[pkid1]", "/api/relation/WebexTeamsPlace/[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 relation/WebexTeamsPlace and the JSON format can be used to import instances of relation/WebexTeamsPlace.
GET http://[host-proxy]/api/relation/WebexTeamsPlace/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/WebexTeamsPlace | POST | /api/relation/WebexTeamsPlace/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/relation/WebexTeamsPlace/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/relation/WebexTeamsPlace/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/WebexTeamsPlace/ |
|
The relation/WebexTeamsPlace schema and all instances as JSON. |
(The list will return 0 to 3 relation/WebexTeamsPlace instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"add",
"bulk_update",
"export"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/WebexTeamsPlace/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "1.1",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/WebexTeamsPlace/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/WebexTeamsPlace/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/WebexTeamsPlace/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/WebexTeamsPlace/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/relation/WebexTeamsPlace/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/relation/WebexTeamsPlace/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/relation/WebexTeamsPlace/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/WebexTeamsPlace/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/WebexTeamsPlace/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/WebexTeamsPlace",
"model_specific_actions": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"add",
"export"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "capacity",
"title": "Capacity"
},
{
"name": "type",
"title": "Type"
},
{
"name": "sip_address",
"title": "SIP Address"
},
{
"name": "wt_device_product",
"title": "Contains"
},
{
"name": "wt_device_code",
"title": "Device Activation Code"
},
{
"name": "wt_device_code_expiry_date",
"title": "Device Activation Code Expiration Date"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "calling.calling_behaviour",
"title": "Calling Behaviour"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "calling.directory_number",
"title": "Directory Number"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "calling.mailid",
"title": "Mail ID from Unified CM"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "calendar.calendar",
"title": "Calendar"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "calendar.hybrid_calendar_service",
"title": "Hybrid Calendar Service"
},
{
"allow_filtering": true,
"allow_ordering": false,
"name": "calendar.email",
"title": "Email address of the calendar mailbox"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/WebexTeamsPlace. | GET | /api/relation/WebexTeamsPlace/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/WebexTeamsPlace as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/WebexTeamsPlace/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/WebexTeamsPlace/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/WebexTeamsPlace; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/WebexTeamsPlace/[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 relation/WebexTeamsPlace and the JSON format can be used to import instances of relation/WebexTeamsPlace.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/WebexTeamsPlace/[pkid]/ | hierarchy=[hierarchy] | The relation/WebexTeamsPlace instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/WebexTeamsPlace/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/WebexTeamsPlace. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Add Device | POST | /api/relation/WebexTeamsPlace/[pkid]/+AddDevice/ | hierarchy=[hierarchy] | If payload required: |