XML

Java class for Tad complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="Tad">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="Option" type="{http://www.osgi.org/xmlns/metatype/v1.2.0}Toption" maxOccurs="unbounded" minOccurs="0"/>
         <any processContents='lax' namespace='##other' maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="name" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="description" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="id" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="type" use="required" type="{http://www.osgi.org/xmlns/metatype/v1.2.0}Tscalar" />
       <attribute name="cardinality" type="{http://www.w3.org/2001/XMLSchema}int" default="0" />
       <attribute name="min" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="max" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="default" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="required" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <anyAttribute/>
     </restriction>
   </complexContent>
 </complexType>
 

Java class for Ticon complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="Ticon">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <any processContents='lax' maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="resource" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="size" use="required" type="{http://www.w3.org/2001/XMLSchema}positiveInteger" />
       <anyAttribute/>
     </restriction>
   </complexContent>
 </complexType>
 

Java class for Tocd complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="Tocd">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="AD" type="{http://www.osgi.org/xmlns/metatype/v1.2.0}Tad" maxOccurs="unbounded"/>
         <element name="Icon" type="{http://www.osgi.org/xmlns/metatype/v1.2.0}Ticon" maxOccurs="unbounded" minOccurs="0"/>
         <any processContents='lax' namespace='##other' maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="description" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="id" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <anyAttribute/>
     </restriction>
   </complexContent>
 </complexType>
 

Java class for Toption complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="Toption">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <any processContents='lax' maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="label" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="value" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <anyAttribute/>
     </restriction>
   </complexContent>
 </complexType>
 

Java class for Tscalar.

The following schema fragment specifies the expected content contained within this class.

 <simpleType name="Tscalar">
   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
     <enumeration value="String"/>
     <enumeration value="Long"/>
     <enumeration value="Double"/>
     <enumeration value="Float"/>
     <enumeration value="Integer"/>
     <enumeration value="Byte"/>
     <enumeration value="Char"/>
     <enumeration value="Boolean"/>
     <enumeration value="Short"/>
     <enumeration value="Password"/>
   </restriction>
 </simpleType>
 

Example to get all devices:

    String apiPath = "allowedCerticates.xml";
    WebResource apisWeb = client.resource(API_URL).path(apiPath);
    
    AllowedCerticatesResult 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(AllowedCerticatesResult.class);
       offset += limit;
    } while (result.isLimitExceeded()):
 

Example to get all devices:

    String apiPath = "blockedCerticates.xml";
    WebResource apisWeb = client.resource(API_URL).path(apiPath);
    
    BlockedCerticatesResult 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(BlockedCerticatesResult.class);
       offset += limit;
    } while (result.isLimitExceeded()):
 

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()):
 

Example to get all devices:

    String apiPath = "devices.xml";
    WebResource apisWeb = client.resource(API_URL).path(apiPath);

    DevicesResult 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(DevicesResult.class);
       offset += limit;
    } while (result.isLimitExceeded()):
 

Example to get all messages:

    // First get the total count of messages
    String apiPath = "messages/count.xml";
    WebResource apisWeb = client.resource(API_URL).path(apiPath);
    CountResult countResult = apisWeb.get(CountResult.class);

    // Then paginate to get all messages
    long MSG_COUNT = countResult.getCount();
    apiPath = "messages.xml";
    apisWeb = client.resource(API_URL).path(apiPath);

    for (int offset = 0; offset < MSG_COUNT; offset += limit) {
       // set limit and offset as queryParam
       // 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);

     MessagesResult result = apisWeb.get(MessagesResult.class);
    }

    // To get all messages of a given topic
    apiPath = "messages/searchByTopic.xml";
    apisWeb = client.resource(API_URL).path(apiPath);
    apisWeb = apisWeb.queryParam("topic", topic);

    MessagesResult result;
    int offset = 0;
    do {
       apisWeb = apisWeb.queryParam("limit", "" + limit);
       if (offset > 0)
          apisWeb = apisWeb.queryParam("offset", "" + offset);
       result = apisWeb.get(MessagesResult.class);
       offset += limit;
    } while (result.isLimitExceeded()):
 

Upon connecting to the Everyware platform, each device will publish a birth certification announcing its characterinstics. The device profile attributes can be divided into few groups.
The device identifiers are attributes which uniquely identify the device. Those include: id, clientId, displayName, serialNumber, IMEI, IMSU, ICCID. The device displayName can be updated by the Account administrator.
The device connection information are attributes related to the device connection. Those include: status, lastEventOn, lastEventType, connectionIp, gpsLatitude, gpsLongitude.
The device version information are attributes related to the device model and version information. Those include: modelId, biosVersion, firmwareVersion, osVersion, jvmVersion, osgiFrameworkVersion, esfVersion, applicationIdentifiers.
The value of the device custom attributes 1-5 are set by the system administrator as additional string attributes that can be associated to the device.
All other device attributes are defined as device extended properties.
When loading or searching a device using the Everyware REST APIs, a fetch parameter can be used to control whether the device extended attributes should be loaded and returned.

A provision request is owned by the target account even if the device will connect to the provision broker using a user that belong to the provision account.

A ProvisionRequest object contains a nested ProvisionJob that represent the background job that will be triggered upon device request to be provisioned. The nested ProvisionJob will contain information the provisioning process of a device, its retry counter and general status.

Mandatory fields are: accountId, retryMaxAttempts, provisionUserUsername, provisionUserPassword. Other field that are not set in the ProvisionRequestCreator will be set to the default value of their type.

• sentOn: it is the timestamp when the data was captured and sent to the Everyware Cloud platform.
• metrics: a metric is a data structure composed of the name, a value, and the type of the value. When used with the REST API valid metric types are: string, double, int, float, long, boolean, base64Binary. Data exposed into the payload metrics can be processed through the real-time rules offered by the Everyware Cloud platform or used as query criteria when searching for messages through the messages/searchByMetric API. Each payload can have zero or more metrics.
• position: it is an optional field used to capture a geo position associated to this payload.
• body: it is an optional part of the payload that allows additional information to be transmitted in any format determined by the user. This field will be stored into the platform database, but the Everyware Cloud cannot apply any statistical analysis on it.

• sentOn: it is the timestamp when the data was captured and sent to the Everyware Cloud platform.
• metrics: a metric is a data structure composed of the name, a value, and the type of the value. When used with the REST API valid metric types are: string, double, int, float, long, boolean, base64Binary. Data exposed into the payload metrics can be processed through the real-time rules offered by the Everyware Cloud platform or used as query criteria when searching for messages through the messages/searchByMetric API. Each payload can have zero or more metrics.
• position: it is an optional field used to capture a geo position associated to this payload.
• body: it is an optional part of the payload that allows additional information to be transmitted in any format determined by the user. This field will be stored into the platform database, but the Everyware Cloud cannot apply any statistical analysis on it.