[Index]

Model: device/spark/Place

Model Details: device/spark/Place

Title Description Details
Workspace Details Group Assigned by FDP
  • Field Name: Workspace Details
  • Type: Object
Name * A friendly name for the workspace.
  • Field Name: Workspace Details.displayName
  • Type: String
Id
  • Field Name: Workspace Details.id
  • Type: String
Organization ID
  • Field Name: Workspace Details.orgId
  • Type: String
Type The workspace type.
  • Field Name: Workspace Details.type
  • Type: String
  • Choices: ["No workspace type set", "Desk - individual", "Focus - high concentration", "Huddle - brainstorm/collaboration", "Meeting Room - dedicated meeting space", "Open Space", "Other"]
Capacity How many people the workspace is suitable for.
  • Field Name: Workspace Details.capacity
  • Type: Integer
Date Created
  • Field Name: Workspace Details.created
  • Type: String
Notes
  • Field Name: Workspace Details.notes
  • Type: String
Associated Devices The product type of the devices associated with this place.
  • Field Name: Workspace Details.associated_devices
  • Type: String
Floor
  • Field Name: Workspace Details.floorId
  • Type: String
SIP Address SipUrl to call all the devices associated with the workspace.
  • Field Name: Workspace Details.sipAddress
  • Type: String
Supported Devices
  • Field Name: Workspace Details.supportedDevices
  • Type: String
  • Choices: ["Collaboration devices", "MPP phones"]
Workspace hierarchy node type The hierarchy node type where this workspace is located.
  • Field Name: Workspace Details.workspace_hierarchy_node_type
  • Type: String
Location
  • Field Name: Workspace Details.locationId
  • Type: String
  • Target: device/spark/Location
  • Target attr: name
  • Format: uri
Device Platform
  • Field Name: Workspace Details.devicePlatform
  • Type: String
  • Choices: ["Cisco", "Microsoft Teams Room"]
Device Activation Code The activation code for registering and associating a device with this place.
  • Field Name: Workspace Details.device_activation_code
  • Type: String
Device Activation Code Expiration Date The expiration date for the activation code.
  • Field Name: Workspace Details.device_activation_code_expiry_date
  • Type: String
  • Format: date-time
Hot Desking Status
  • Field Name: Workspace Details.hotdeskingStatus
  • Type: String
  • Choices: ["On", "Off"]
Calling Settings Group Assigned by FDP
  • Field Name: Calling Settings
  • Type: Object
Calling
  • Field Name: calling
  • Type: Object
Directory Number Enter the DN to be used with the Unified CM account. This DN is used for hybrid calling.
  • Field Name: Calling Settings.calling.directory_number
  • Type: String
Hybrid Calling Settings
  • Field Name: hybridCalling
  • Type: Object
End user email address in Cisco Unified CM 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.
  • Field Name: Calling Settings.calling.hybridCalling.emailAddress
  • Type: String
  • Pattern: (^$|^([^.@]+)(\.[^.@]+)*@([^.@]+\.)+([^.@]+)$)
Site 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.
  • Field Name: Calling Settings.calling.site
  • Type: String
Site Pkid
  • Field Name: Calling Settings.calling.site_pkid
  • Type: String
Link to Subscriber Jump to the associated subscriber page.
  • Field Name: Calling Settings.calling.subscriber_link
  • Type: String
  • Format: link
Subscriber PKID Internal field for the subscriber ID.
  • Field Name: Calling Settings.calling.subscriber_pkid
  • Type: String
Calling Behaviour This determines how calls are made from this place. Default: freeCalling
  • Field Name: Calling Settings.calling.type
  • Type: String
  • Default: freeCalling
  • Choices: ["No Calling", "Free Calling (default)", "Hybrid Calling", "Webex Calling", "Third-party SIP URI", "Webex Edge For Devices"]
Webex Calling Settings
  • Field Name: webexCalling
  • Type: Object
Extension Extension when adding a Webex Calling workspace.
  • Field Name: Calling Settings.calling.webexCalling.extension
  • Type: String
Licenses
  • Field Name: licenses.[n]
  • Type: Array
Location Location ID when adding a Webex Calling workspace.
  • Field Name: Calling Settings.calling.webexCalling.locationId
  • Type: String
  • Target: device/spark/Location
  • Target attr: name
  • Format: uri
Phone Number Phone Numberwhen adding a Webex Calling workspace.
  • Field Name: Calling Settings.calling.webexCalling.phoneNumber
  • Type: String
Calendar Settings Group Assigned by FDP
  • Field Name: Calendar Settings
  • Type: Object
Calendar
  • Field Name: calendar
  • Type: Object
Workspace email address This is the email address that will be used to connect to the hybrid calendar service.
  • Field Name: Calendar Settings.calendar.emailAddress
  • Type: String
Resource Group ID Only applicable for on-premise Microsoft calendars.
  • Field Name: Calendar Settings.calendar.resourceGroupId
  • Type: String
Calendar Type Which calendar provider do you want to use?. Default: none
  • Field Name: Calendar Settings.calendar.type
  • Type: String
  • Default: none
  • Choices: ["None", "Microsoft Exchange / Office 365", "Google Calendar"]
Device Hosted Meetings Settings Group Assigned by FDP
  • Field Name: Device Hosted Meetings Settings
  • Type: Object
Device Hosted Meetings Configuration for device-hosted meetings functionality.
  • Field Name: deviceHostedMeetings
  • Type: Object
Enable Device Hosted Meetings Set to true to enable device-hosted meetings, false to disable.
  • Field Name: Device Hosted Meetings Settings.deviceHostedMeetings.enabled
  • Type: Boolean
Webex Site URL The Webex site URL for device hosting meetings.
  • Field Name: Device Hosted Meetings Settings.deviceHostedMeetings.siteUrl
  • Type: String
Indoor Navigation Settings Group Assigned by FDP
  • Field Name: Indoor Navigation Settings
  • Type: Object
Indoor Navigation Configuration for indoor navigation and workspace location mapping.
  • Field Name: indoorNavigation
  • Type: Object
Map URL URL of a map locating the workspace for indoor navigation.
  • Field Name: Indoor Navigation Settings.indoorNavigation.url
  • Type: String
Phone Numbers Settings Group Assigned by FDP
  • Field Name: Phone Numbers Settings
  • Type: Object
Phone Numbers
  • Field Name: phoneNumbers.[n]
  • Type: Array
Extension
  • Field Name: Phone Numbers Settings.phoneNumbers.[n].extension
  • Type: String
External
  • Field Name: Phone Numbers Settings.phoneNumbers.[n].external
  • Type: String
Primary
  • Field Name: Phone Numbers Settings.phoneNumbers.[n].primary
  • Type: Boolean
Capabilities Settings Group Assigned by FDP
  • Field Name: Capabilities Settings
  • Type: Object
Workspace Capabilities Environmental monitoring and detection capabilities of the workspace.
  • Field Name: capabilities
  • Type: Object
Air Quality Monitoring Air quality monitoring capability status.
  • Field Name: airQuality
  • Type: Object
Configured Whether air quality monitoring is configured.
  • Field Name: Capabilities Settings.capabilities.airQuality.configured
  • Type: Boolean
Supported Whether air quality monitoring is supported.
  • Field Name: Capabilities Settings.capabilities.airQuality.supported
  • Type: Boolean
Ambient Noise Monitoring Ambient noise level monitoring capability status.
  • Field Name: ambientNoise
  • Type: Object
Configured Whether ambient noise monitoring is configured.
  • Field Name: Capabilities Settings.capabilities.ambientNoise.configured
  • Type: Boolean
Supported Whether ambient noise monitoring is supported.
  • Field Name: Capabilities Settings.capabilities.ambientNoise.supported
  • Type: Boolean
Occupancy Detection Occupancy detection capability status.
  • Field Name: occupancyDetection
  • Type: Object
Configured Whether occupancy detection is configured.
  • Field Name: Capabilities Settings.capabilities.occupancyDetection.configured
  • Type: Boolean
Supported Whether occupancy detection is supported.
  • Field Name: Capabilities Settings.capabilities.occupancyDetection.supported
  • Type: Boolean
Presence Detection Presence detection capability status.
  • Field Name: presenceDetection
  • Type: Object
Configured Whether presence detection is configured.
  • Field Name: Capabilities Settings.capabilities.presenceDetection.configured
  • Type: Boolean
Supported Whether presence detection is supported.
  • Field Name: Capabilities Settings.capabilities.presenceDetection.supported
  • Type: Boolean
Humidity Monitoring Relative humidity monitoring capability status.
  • Field Name: relativeHumidity
  • Type: Object
Configured Whether humidity monitoring is configured.
  • Field Name: Capabilities Settings.capabilities.relativeHumidity.configured
  • Type: Boolean
Supported Whether humidity monitoring is supported.
  • Field Name: Capabilities Settings.capabilities.relativeHumidity.supported
  • Type: Boolean
Sound Level Monitoring Sound level monitoring capability status.
  • Field Name: soundLevel
  • Type: Object
Configured Whether sound level monitoring is configured.
  • Field Name: Capabilities Settings.capabilities.soundLevel.configured
  • Type: Boolean
Supported Whether sound level monitoring is supported.
  • Field Name: Capabilities Settings.capabilities.soundLevel.supported
  • Type: Boolean
Temperature Monitoring Temperature monitoring capability status.
  • Field Name: temperature
  • Type: Object
Configured Whether temperature monitoring is configured.
  • Field Name: Capabilities Settings.capabilities.temperature.configured
  • Type: Boolean
Supported Whether temperature monitoring is supported.
  • Field Name: Capabilities Settings.capabilities.temperature.supported
  • Type: Boolean
Health Settings Group Assigned by FDP
  • Field Name: Health Settings
  • Type: Object
Workspace Health Health status and issues associated with the workspace.
  • Field Name: health
  • Type: Object
Health Issues List of workspace health issues and recommendations.
  • Field Name: issues.[n]
  • Type: Array
Created At Issue creation timestamp.
  • Field Name: Health Settings.health.issues.[n].createdAt
  • Type: String
Description Detailed description of the health issue.
  • Field Name: Health Settings.health.issues.[n].description
  • Type: String
Issue ID Unique identifier for the health issue.
  • Field Name: Health Settings.health.issues.[n].id
  • Type: String
Issue Level Severity level of the individual issue.
  • Field Name: Health Settings.health.issues.[n].level
  • Type: String
  • Choices: []
Recommended Action Recommended action to resolve the issue.
  • Field Name: Health Settings.health.issues.[n].recommendedAction
  • Type: String
Issue Title Brief title of the health issue.
  • Field Name: Health Settings.health.issues.[n].title
  • Type: String
Health Level Overall health level based on workspace issues.
  • Field Name: Health Settings.health.level
  • Type: String
  • Choices: []
Planned Maintenance Settings Group Assigned by FDP
  • Field Name: Planned Maintenance Settings
  • Type: Object
Planned Maintenance Scheduled maintenance information for the workspace.
  • Field Name: plannedMaintenance
  • Type: Object
Maintenance End Time End time of the planned maintenance period.
  • Field Name: Planned Maintenance Settings.plannedMaintenance.endTime
  • Type: String
Maintenance Mode Current maintenance mode status.
  • Field Name: Planned Maintenance Settings.plannedMaintenance.mode
  • Type: String
  • Choices: []
Maintenance Start Time Start time of the planned maintenance period.
  • Field Name: Planned Maintenance Settings.plannedMaintenance.startTime
  • Type: String