Getting Policy Non-Compliant Overview

Description

Get the number of devices that have not complied to a policy that was enforced on a device.

Resource Path non-compliant-device-counts-by-features

URL

/mdm-admin/dashboard/non-compliant-device-counts-by-features

HTTP Method GET

Request/Response Format application/json

cURL command

curl -v -L -G -H "Content-Type: application/json" -H "Authorization: Bearer <EMM_API_TOKEN>" -k -v https://<EMM_HOST>:<EMM_HTTPS_PORT>/mdm-admin/dashboard/non-compliant-device-counts-by-features -d "start=<START>&length=<LENGTH>"

For more information on how to generate the <EMM_API_TOKEN>, see Generating the EMM API Token.
By default, <EMM_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
By default, <EMM_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.
start - Provide the starting pagination index. Example 10
length- Provide how many policy details you require from the starting pagination index. For example if you require the non-compliant policy details from the 10^thpagination index to the 15^th, you must define 10 as the value for start and 5 as the value for length.

If you wish to get the device details within a predefined index range, you need to define both the start and length fields.
Example: https://localhost:9443/mdm-admin/dashboard/non-compliant-device-counts-by-features -d "start=10&length=5"

There will be situations were you will not have any details in the specified index range. In such situation all the details of the devices that have not complied to a given policy is given.

Example:

curl -v -L -G -H "Content-Type: application/json" -H "Authorization: Bearer 0ff0f5c5ef202f5abd933efef370a28c" -k -v https://localhost:9443/mdm-admin/dashboard/non-compliant-device-counts-by-features -d "start=10&length=5"

Sample output

> GET /mdm-admin/dashboard/non-compliant-device-counts-by-features?start=0&length=5 HTTP/1.1
> User-Agent: curl/7.38.0
> Host: localhost:9443
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer c148a833a9c3d30bb5197788eaad5541
>
< HTTP/1.1 200 OK
< Cache-Control: private
< Expires: Thu, 01 Jan 1970 05:30:00 IST
< Date: Sat, 30 Apr 2016 06:55:54 GMT
< Content-Type: application/json
< Content-Length: 184
* Server WSO2 Carbon Server is not blacklisted
< Server: WSO2 Carbon Server
<
[{"context":"non-compliant-feature","data":[{"group":"PASSCODE_POLICY","label":"PASSCODE_POLICY","count":4},{"group":"WIFI","label":"WIFI","count":2}], "totalRecordCount":2}]

Sample JSON Output Definition

[  
   {  
      "context":"non-compliant-feature",
      "data":[  
         {  
            "group":"PASSCODE_POLICY",
            "label":"PASSCODE_POLICY",
            "count":4
         },
         {  
            "group":"WIFI",
            "label":"WIFI",
            "count":2
         }
      ],
      "totalRecordCount":2
   }
]

Parameter	Definition
`context`	Defines the attribute, to which the data is being populated. In this use case the attribute is `non-compliant-feature`.
`data`	Defines the data received.
`group`	The devices are grouped according to the policy profile names.
`label`	Defines the name of the grouped devices.
`count`	The number of devices in each category.