Getting Non-Compliant Device Details

Description

Get device details of non-compliant devices which do not comply to a given policy.

Resource Path /dashboard/feature-non-compliant-devices-with-details

URL

/mdm-admin/dashboard/feature-non-compliant-devices-with-details

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/feature-non-compliant-devices-with-details -d “non-compliant-feature-code=<FEATURE_CODE>&pagination-enabled=<TRUE/FALSE>”

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.

Filter the device based on the following required parameter:
- non-compliant-feature-code - Provide the code specific to the feature (examples for feature codes are: WIFI,PASSCODE_POLICY, CAMERA and ENCRYPT_STORAGE.)
- Pagination-enabled - To enable/disable pagination set the value as true or false.
  If pagination is enabled you have to also set the following query parameters:
  - 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-devices-with-details -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.
Filter the device details using the query parameters given below:
- platform -Provide the platform that the device is running on. This can be one of the following:
  1. - iOS
    - Android
    - Windows
- ownership - Provide the ownership status of the device. This can be one of the following:
  - - BYOD: Bring Your Own Device
    - COPE: Corporate-Owned, Personally-Enabled

Example:

curl -v -L -G -H "Content-Type: application/json" -H "Authorization: Bearer c148a833a9c3d30bb5197788eaad5541" -k -v https://localhost:9443/mdm-admin/dashboard/feature-non-compliant-devices-with-details -d “non-compliant-feature-code=WIFI&pagination-enabled=false”

Sample output

> GET /mdm-admin/dashboard/feature-non-compliant-devices-with-details?non-compliant-feature-code=WIFI&pagination-enabled=false HTTP/1.1
> User-Agent: curl/7.38.0
> Host: localhost:9443
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer edd064382fdc1086cdbd1ce2a780b9c6
>
< HTTP/1.1 200 OK
< Cache-Control: private
< Expires: Thu, 01 Jan 1970 05:30:00 IST
< Date: Mon, 09 May 2016 16:30:26 GMT
< Content-Type: application/json
< Content-Length: 241
* Server WSO2 Carbon Server is not blacklisted
< Server: WSO2 Carbon Server
<
* Connection #0 to host localhost left intact
[{"context":"Filtered-feature-non-compliant-devices-with-details","data":[{"deviceId":2,"platform":"android","ownershipType":"COPE","connectivityStatus":"ACTIVE"},{"deviceId":4,"platform":"ios","ownershipType":"BYOD","connectivityStatus":"ACTIVE"}]}]

Sample JSON Output Definition

[  
   {  
      "context":"Filtered-feature-non-compliant-devices-with-details",
      "data":[  
         {  
            "deviceId":2,
            "platform":"android",
            "ownershipType":"COPE",
            "connectivityStatus":"ACTIVE"
         },
         {  
            "deviceId":4,
            "platform":"ios",
            "ownershipType":"BYOD",
            "connectivityStatus":"ACTIVE"
         }
      ]
   }
]

Parameter	Definition
`context`	Defines the attribute, to which the data is being populated. In this use case the context is `Feature-non-compliant-devices-with-details`.
`data`	Defines the data received. In this use case, the data will be filtered by a non-compliant feature and paginated (if pagination is enabled).