Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt
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”
  1. Filter the device based on the following required parameter:
    • Pagination-enabled  - To enable/disable pagination set the value as true or false.

Description

Get device details of devices based on a particular device type.

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

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

HTTP MethodGET
Request/Response Formatapplication/json
cURL command
Code Block
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=WIFI<FEATURE_CODE>&pagination-enabled=false”<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.

Example:

Code Block
Noteinfo

If pagination is enabled you have to also set the following query parameters:

  • start-index - 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 10th pagination index to the 15th, you must define 10 as the value for start and 5 as the value for length.
     
Note

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:
    • connectivity-status - Provide the connectivity status of the device. This can be one of the following:
        • Total: All the devices that have registered with WSO2 EMM.
        • active: The devices that are registered with WSO2 EMM and are actively communicating with the server.
        • inactive: The devices that are registered with WSO2 EMM but unable to actively communicate with the server.
        • removed: The devices that have unregistered from WSO2 EMM.
    • potential-vulnerability -Provide details of the potential vulnerabilities of the device. This can be:
        • non-compliant: Devices that have not complied to the policies enforced on the device by WSO2 EMM.
        • unmonitored: Devices that have no policy assigned to them. 
    • platform -Provide the platform that the device is running on. This can be one of the following:
        • 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:

    Code Block
    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
    Code Block
    > 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 
    Code Block
    [  
       {  
          "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"
             }
          ]
       }
    ]
    ParameterDefinition
    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 and paginated (if pagination is enabled).