DeviceMgmtPkisResult Data Type

DeviceMgmtPki is a container for a list of DeviceMgmtCerticate returned by a list deviceMgmt pki call. It contains the list of requested DeviceMgmtPki and a flag signaling whether the limit for the maximum number of returned entities has been reached. If limitExceeded is set, the client is requested to paginate through the result by moving the offset forward and issue a new request to get more data.

Example to get all devices: 

    String apiPath = "deviceMgmtPki.xml";
    WebResource apisWeb = client.resource(API_URL).path(apiPath);
    
    DeviceMgmtPkiResult result;
    int offset = 0;
    do {
       // if the "limit" queryParam is not initialized, limit default value = 50
       // if the "offset" queryParam is not initialized, offset default value = 0
       apisWeb = apisWeb.queryParam("limit", "" + limit);
       if (offset > 0) 
          apisWeb = apisWeb.queryParam("offset", "" + offset);
       result = apisWeb.get(DeviceMgmtPkiResult.class);
       offset += limit;
    } while (result.isLimitExceeded()):

Properties
name data type constraints description
limitExceeded boolean required
deviceMgmtPki array of DeviceMgmtPki  

Example

{
  "limitExceeded" : true,
  "deviceMgmtPki" : [ {
    "privateKey" : "...",
    "password" : "...",
    "isDefault" : true,
    "caId" : 12345,
    "isCa" : true,
    "pkiStatus" : "SUSPENDED",
    "id" : 12345,
    "certificate" : "...",
    "accountId" : 12345,
    "version" : 12345,
    "serial" : "...",
    "algorithm" : "...",
    "subject" : "...",
    "issuer" : "...",
    "notBefore" : 12345,
    "notAfter" : 12345,
    "createdOn" : 12345,
    "createdBy" : 12345,
    "modifiedOn" : 12345,
    "modifiedBy" : 12345,
    "name" : "...",
    "optlock" : 12345
  }, {
    "privateKey" : "...",
    "password" : "...",
    "isDefault" : true,
    "caId" : 12345,
    "isCa" : true,
    "pkiStatus" : "EXPIRED",
    "id" : 12345,
    "certificate" : "...",
    "accountId" : 12345,
    "version" : 12345,
    "serial" : "...",
    "algorithm" : "...",
    "subject" : "...",
    "issuer" : "...",
    "notBefore" : 12345,
    "notAfter" : 12345,
    "createdOn" : 12345,
    "createdBy" : 12345,
    "modifiedOn" : 12345,
    "modifiedBy" : 12345,
    "name" : "...",
    "optlock" : 12345
  } ]
}