Inventory Reporting & Management
Use Inventory Reporting & Management to create detailed inventory reports of devices, rooms, and sites.
Examples
Inventory - Provide a View of the devices associated to a specific tenant. If a Tenant Id is provided as an URL parameter, it will be shown if you have access to the requested account.
All Inventory - Provide a View of all devices associated to all accounts you have access to.
Device Details - Clicking into any device from inventory dives provides the information applicable to a device and made available through Poly Lens.
Supported APIs
Custom Device Tags
API | Description | Type | Required Arguments | Requires Poly Lens Premium |
---|---|---|---|---|
addDeviceTag | Attaches a new tag to a device and returns the list of all the tags for the device. | Mutation | tag , deviceId | No |
removeDeviceTag | Removes the specified tag from a device and returns the list of all tags for the device. | Mutation | tag , deviceId | No |
Inventory Reporting
API | Description | Type | Required Arguments | Requires Poly Lens Premium |
---|---|---|---|---|
catalogModels | Returns the hardware product information for the products in the product catalog. | Query | n/a | No |
countDevices | Returns the total number of devices the requesting user has permission to view, across all tenants that the user can access. | Query | n/a | No |
deviceAggregations | Grouping the devices based on their geographical location. | Query | n/a | No |
deviceSearch | Searches for devices using query parameters. Supports pagination and finding results of more than 10K entries. Note: The pageSize should be limited to 5000 entries or less (default 10). Also, pageSize parameter of subsequent page calls must be idential to the first, or an error will be returned. | Query | n/a | No |
hardwareModel | Hardware Model level details for an item in the product catalog. | Query | hardwareModelId | No |
Notification Center
API | Description | Type | Required Arguments |
---|---|---|---|
ncAddRecipient | Adds a recipient who will receive notifications. | Mutation | input |
ncConfirmEmail | Confirms recipient's email address. | Mutation | ncConfirmEmailId |
ncCreateServiceNowWebhook | Creates a new webhook in Poly Lens for ServiceNow. | Mutation | tenantId , input |
ncCreateTeamsWebhookForTenant | Creates a new webhook in Poly Lens for Microsoft Teams. | Mutation | tenantId |
ncDeleteServiceNowWebhook | Deletes a ServiceNow webhook. | Mutation | ncDeleteServiceNowWebhookId |
ncDeleteTeamsWebhook | Deletes a Microsoft Teams webhook. | Mutation | ncDeleteTeamsWebhookId |
ncDisableAction | Disables notifications for an action. | Mutation | input |
ncDisableServiceNowWebhook | Disables a ServiceNow webhook. | Mutation | ncDisableServiceNowWebhookId |
ncDisableTeamsWebhook | Disables a Microsoft Teams webhook | Mutation | ncDisableTeamsWebhookId |
ncDisableTenant | Disables email notifications for a tenant. | Mutation | ncDisableTenantId |
ncDisableUser | Disables email notifications for users. | Mutation | input |
ncEnableAction | Enables notifications for an action. | Mutation | input |
ncEnableServiceNowWebhook | Enables a ServiceNow webhook to start sending notifications to ServiceNow. | Mutation | ncEnableServiceNowWebhookId |
ncEnableTeamsWebhook | Enables a Microsoft Teams webhook to start sending notifications to Microsoft Teams | Mutation | ncEnableTeamsWebhookId |
ncEnableTenant | Enables email notifications for a tenant. | Mutation | ncEnableTenantId |
ncEnableUser | Enables email notifications for users. | Mutation | input |
ncPoly | Returns details of all Poly notification configurations. | Query | - |
ncRemoveRecipient | Removes a recipient. | Mutation | input |
ncReplaceRecipient | Replaces a recipient. | Mutation | input |
ncServiceNow | Returns details of all configured ServiceNow webhooks. | Query | - |
ncSetFrequency | Sets notification frequency for an action. | Mutation | input |
ncTeams | Returns details of all configured Microsoft Teams webhooks. | Query | - |
ncTestServiceNowWebhook | API for testing of a ServiceNow webhook. | Mutation | input |
ncTestServiceNowWebhookWithParams | API for testing of a ServiceNow webhook with parameters. | Mutation | tenantId , input |
ncTestTeamsWebhook | API for testing of a Microsoft Teams webhook. | Mutation | input |
ncUnsubscribe | Unsubscribes a recipient. | Mutation | ncUnsubscribeId |
ncUpdateServiceNowActionConfiguration | Updates action configuration of a ServiceNow webhook. | Mutation | input |
ncUpdateServiceNowWebhook | Updates a ServiceNow webhook. | Mutation | ncUpdateServiceNowWebhookId , input |
ncUpdateTeamsWebhook | Updates a Microsoft Teams webhook | Mutation | ncUpdateTeamsWebhookId , input |
ncUpdateWebhookActionConfiguration | Updates action configuration of a Microsoft Teams webhook. | Mutation | input |
notificationCenter | Enables tenant admin or device manager to enable and configure notifications for events that occur in Poly Lens. | Query | - |
Room & Site Management
API | Description | Type | Required Arguments | Requires Poly Lens Premium |
---|---|---|---|---|
deleteRooms | Deletes an existing room or sets of rooms. | Mutation | tenantId , ids | No |
deleteSites | Deletes an existing site or set of sites. | Mutation | tenantId , ids | No |
room | Gets detailed data for a specified room. | Query | roomId | No |
roomData | Retrieves room data for a specified tenant. | Query | tenantId | No |
site | Gets the geographical location of the device. | Query | siteId | No |
siteData | Retrieves site data for a specified tenant. | Query | tenantId | No |
switchSite | Switches a room to another site. | Mutation | tenantId , siteId , roomId | No |
upsertRoom | Creates a new room or updates an existing room if applicable. | Mutation | tenantId , siteId | No |
upsertSite | Creates a new site or updates an existing site if applicable. | Mutation | tenantId , name | No |
Subnet Management
API | Description | Type | Required Arguments | Requires Poly Lens Premium |
---|---|---|---|---|
createSubnetRule | Creates a new subnet rule. | Mutation | siteId , publicCidr | No |
deleteSubnetRule | Deletes an existing subnet rule. | Mutation | ruleId | No |
getSubnetRules | Get subnet rules for a given site. | Query | siteId | No |
getSubnetRuleValidity | Check if site subnet rules are valid. | Query | tenantId , siteId , publicCidr | No |
updateSubnetRule | Updates an existing subnet rule. | Mutation | publicCidr , ruleId | No |