tenantFWVersionStatus

Set Admin Credentials...
tenantFWVersionStatus

get

tenantFWVersionStatus

Finds device firmware version compliance status of a tenant. There are 3 categories of firmware and software versions identified here: Compliant: the device (or computer) is running the firmware (or software) version AS DEFINED by your active policy for that product. Non-Compliant: the device (or computer) is running a firmware (or software) version DIFFERENT from what you have defined in your policy for that product. No Policy: the device (or computer) is currently NOT MANAGED by an active policy.
This dataset is addressing the details. tenantApiCode value of "af0813e6-81c0-4a77-89d2-3338d0277c42" and apikey value of "1hKMMPFMmaldnC0rcohvXN0UX7UeWPjb" can be used as url parameters to test this api for accessing sample data.
Note:
  1. The tenantApiCode and apikey pre populated in the docs here is intended for accessing sandbox data to help understand the API only.
  2. For production integration use case, please access Plantronics Manager Pro's Admin->Accounts->Company Profile to get access to the tenantApiCode for the tenant.
  3. Please register here http://developer.plantronics.com/user/register and generate your apikey for apps when you are ready to integrate with a production tenant data and your app.  

Resource URL

https://oda-sandbox.plantronicsmanager.com /reports/assets/tenant/{tenantApiCode}/versionstatus/firmware

Query Parameters

Name Values Description
apikey
(required)

Key to access this api.
complianceStatus

Optional Filter parameter to filter by compliant datasets or non compliant
username

User name queried for mute statistics
deviceId

Array of devices; Devices should be a valid display id of a Plantronics device e.g. 12FF7EF0F70D194881B7797E0D27FF55
deviceState

Device state; Please refer documentation on device states
productName

Product Name e.g. BT600
deviceType

Device Type e.g. DECT

page
(required)

Page of the result, start from 0

count
(required)

count or number of results in a page

Header Parameters

Name Values Description
appId
(required)

Unique Id for the App

Request Body

tenantApiCode ID of the tenant; Should be a valid hexadecimal af0813e6-81c0-4a77-89d2-3338d0277c42 true

HTTP Basic

Set...

OAuth 2.0

Set...

API Key

Set...
Reset
Request Response cURL

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 400
    400

    Generic malformed request.

  • 422
    422

    One or more of the required parameters not found in the request URI.

  • 401
    401

    Unauthorized

  • 500
    500

    Internal server error.

  • 403
    403

    Unauthorized token error.

  • 404
    404

    No tenant entity could be found for the requested device path parameters

Resource Summary

Security

Content Type

application/json

Category

Asset Management and Adoption

Name Type Description
Name Type Description

Working...