PDMS-SP APIs's Home Page

PDMS-SP APIs

How to edit the banner area of a home page

Overview

The Poly Device Management Service for Service Providers (PDMS-SP) service offers organizations cloud-based management functionality over their deployments of Poly voice equipment.

The service exposes a programmatic interface to Poly’s cloud features. The interface is intended to be consumed by software clients.

The service’s primary function is the provisioning, monitoring, probing, and operational control of remote devices. Secondarily, the service provides functions related to access and reporting.

The API will be extended over time to cover additional PDMS-SP service features.

Please create a case on MyHPSupport or CSDP if you wish to enable access to the PDMS-SP API for your organization.

Features

In its current revision, the Service API allows authorized clients to automate various tasks, including:

  • Fetch information on:
    • Polycom device models
    • Their configurable parameters
    • Their observable statistics
    • The organization’s hierarchical structure
    • And each (sub-)organization’s assets
  • Fetch and update:
    • Base profiles
    • Individual device configurations
  • Fetch latest known:
    • Device basic state
    • Device samples (a.k.a. ‘device status values’)
  • Manage device ownership:
    • Claim ZT devices
    • Delete (previously added) BYOD devices
  • Reboot devices

Interface

The service exposes a REST-like interface, relying on the HTTP/1.1 protocol for request/response framing. It defines a set of domain resources and associated operations, as presented in this document.

Key characteristics:

  • HTTP framing over TLS connections
  • Username and password based authentication
  • Token based request authorization
  • JSON as primary content type

The document

HP Developers Portal | PDMS-SP API Documentation document also integrates ‘Live Request’ panels for all available API operations. This allows the reader to interact with the PDMS-SP production server, issuing individual requests and capturing the server’s replies.