@ -32,6 +31,7 @@ public class ControllerConstants {
protectedstaticfinalStringDASHBOARD_ID_PARAM_DESCRIPTION="A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
protectedstaticfinalStringDASHBOARD_ID_PARAM_DESCRIPTION="A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
protectedstaticfinalStringRPC_ID_PARAM_DESCRIPTION="A string value representing the rpc id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
protectedstaticfinalStringRPC_ID_PARAM_DESCRIPTION="A string value representing the rpc id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
protectedstaticfinalStringDEVICE_ID_PARAM_DESCRIPTION="A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
protectedstaticfinalStringDEVICE_ID_PARAM_DESCRIPTION="A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
protectedstaticfinalStringENTITY_VIEW_ID_PARAM_DESCRIPTION="A string value representing the entity view id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
protectedstaticfinalStringDEVICE_PROFILE_ID_PARAM_DESCRIPTION="A string value representing the device profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
protectedstaticfinalStringDEVICE_PROFILE_ID_PARAM_DESCRIPTION="A string value representing the device profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
protectedstaticfinalStringTENANT_PROFILE_ID_PARAM_DESCRIPTION="A string value representing the tenant profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
protectedstaticfinalStringTENANT_PROFILE_ID_PARAM_DESCRIPTION="A string value representing the tenant profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
protectedstaticfinalStringTENANT_ID_PARAM_DESCRIPTION="A string value representing the tenant id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
protectedstaticfinalStringTENANT_ID_PARAM_DESCRIPTION="A string value representing the tenant id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
@ -56,6 +56,7 @@ public class ControllerConstants {
protectedstaticfinalStringPAGE_SIZE_DESCRIPTION="Maximum amount of entities in a one page";
protectedstaticfinalStringPAGE_SIZE_DESCRIPTION="Maximum amount of entities in a one page";
protectedstaticfinalStringPAGE_NUMBER_DESCRIPTION="Sequence number of page starting from 0";
protectedstaticfinalStringPAGE_NUMBER_DESCRIPTION="Sequence number of page starting from 0";
protectedstaticfinalStringDEVICE_TYPE_DESCRIPTION="Device type as the name of the device profile";
protectedstaticfinalStringDEVICE_TYPE_DESCRIPTION="Device type as the name of the device profile";
protectedstaticfinalStringIS_BOOTSTRAP_SERVER_PARAM_DESCRIPTION="A Boolean value representing the Server SecurityInfo for future Bootstrap client mode settings. Values: 'true' for Bootstrap Server; 'false' for Lwm2m Server. ";
protectedstaticfinalStringFILTER_VALUE_TYPE=NEW_LINE+"## Value Type and Operations"+NEW_LINE+
protectedstaticfinalStringFILTER_VALUE_TYPE=NEW_LINE+"## Value Type and Operations"+NEW_LINE+
"Provides a hint about the data type of the entity field that is defined in the filter key. "+
"Provides a hint about the data type of the entity field that is defined in the filter key. "+
"The value type impacts the list of possible operations that you may use in the corresponding predicate. For example, you may use 'STARTS_WITH' or 'END_WITH', but you can't use 'GREATER_OR_EQUAL' for string values."+
"The value type impacts the list of possible operations that you may use in the corresponding predicate. For example, you may use 'STARTS_WITH' or 'END_WITH', but you can't use 'GREATER_OR_EQUAL' for string values."+
@ -1359,4 +1403,11 @@ public class ControllerConstants {
protectedstaticfinalStringMODEL_DESCRIPTION="See the 'Model' tab for more details.";
protectedstaticfinalStringENTITY_VIEW_DESCRIPTION="Entity Views limit the degree of exposure of the Device or Asset telemetry and attributes to the Customers. "+
"Every Entity View references exactly one entity (device or asset) and defines telemetry and attribute keys that will be visible to the assigned Customer. "+
"As a Tenant Administrator you are able to create multiple EVs per Device or Asset and assign them to different Customers. ";
protectedstaticfinalStringENTITY_VIEW_INFO_DESCRIPTION="Entity Views Info extends the Entity View with customer title and 'is public' flag. "+ENTITY_VIEW_DESCRIPTION;
@ApiOperation(value="Create Device (saveDevice) with credentials ",
notes="Create or update the Device. When creating device, platform generates Device Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address). "+
"Requires to provide the Device Credentials object as well. Useful to create device and credentials in one request. "+
"You may find the example of LwM2M device and RPK credentials below: \n\n"+
@ -556,10 +630,16 @@ public class EntityViewController extends BaseController {
}
}
}
}
@ApiOperation(value="Find related entity views (findByQuery)",
notes="Returns all entity views that are related to the specific entity. "+
"The entity id, relation type, entity view types, depth of the search, and other query parameters defined using complex 'EntityViewSearchQuery' object. "+
"See 'Model' tab of the Parameters for more info."+TENANT_OR_CUSTOMER_AUTHORITY_PARAGRAPH)
notes="Returns a set of unique entity view types based on entity views that are either owned by the tenant or assigned to the customer which user is performing the request."
notes="Get the Lwm2m Bootstrap SecurityInfo object (of the current server) based on the provided isBootstrapServer parameter. If isBootstrapServer == true, get the parameters of the current Bootstrap Server. If isBootstrapServer == false, get the parameters of the current Lwm2m Server. Used for client settings when starting the client in Bootstrap mode. "+
@ApiModelProperty(position=8,required=true,value="Set of telemetry and attribute keys to expose via Entity View.")
privateTelemetryEntityViewkeys;
privateTelemetryEntityViewkeys;
@ApiModelProperty(position=9,value="Represents the start time of the interval that is used to limit access to target device telemetry. Customer will not be able to see entity telemetry that is outside the specified interval;")
privatelongstartTimeMs;
privatelongstartTimeMs;
@ApiModelProperty(position=10,value="Represents the end time of the interval that is used to limit access to target device telemetry. Customer will not be able to see entity telemetry that is outside the specified interval;")
privatelongendTimeMs;
privatelongendTimeMs;
publicEntityView(){
publicEntityView(){
@ -73,6 +81,7 @@ public class EntityView extends SearchTextBasedWithAdditionalInfo<EntityViewId>
returngetName()/*What the ...*/;
returngetName()/*What the ...*/;
}
}
@ApiModelProperty(position=4,value="JSON object with Customer Id. Use 'assignEntityViewToCustomer' to change the Customer Id.",readOnly=true)
@Override
@Override
publicCustomerIdgetCustomerId(){
publicCustomerIdgetCustomerId(){
returncustomerId;
returncustomerId;
@ -83,8 +92,31 @@ public class EntityView extends SearchTextBasedWithAdditionalInfo<EntityViewId>
returnname;
returnname;
}
}
@ApiModelProperty(position=3,value="JSON object with Tenant Id.",readOnly=true)
@Override
@Override
publicTenantIdgetTenantId(){
publicTenantIdgetTenantId(){
returntenantId;
returntenantId;
}
}
@ApiModelProperty(position=1,value="JSON object with the Entity View Id. "+
"Specify this field to update the Entity View. "+
"Referencing non-existing Entity View Id will cause error. "+
"Omit this field to create new Entity View.")
@Override
publicEntityViewIdgetId(){
returnsuper.getId();
}
@ApiModelProperty(position=2,value="Timestamp of the Entity View creation, in milliseconds",example="1609459200000",readOnly=true)
@Override
publiclonggetCreatedTime(){
returnsuper.getCreatedTime();
}
@ApiModelProperty(position=11,value="Additional parameters of the device",dataType="com.fasterxml.jackson.databind.JsonNode")
@ApiModelProperty(position=12,value="Title of the Customer that owns the entity view.",readOnly=true)
privateStringcustomerTitle;
privateStringcustomerTitle;
@ApiModelProperty(position=13,value="Indicates special 'Public' Customer that is auto-generated to use the entity view on public dashboards.",readOnly=true)
@ApiModelProperty(position=2,value="Host for 'No Security' mode",example="0.0.0.0",readOnly=true)
Stringhost;
Stringhost;
StringsecurityHost;
@ApiModelProperty(position=3,value="Port for 'No Security' mode",example="5687",readOnly=true)
Integerport;
Integerport;
@ApiModelProperty(position=4,value="Host for 'Security' mode (DTLS)",example="0.0.0.0",readOnly=true)
StringsecurityHost;
@ApiModelProperty(position=5,value="Port for 'Security' mode (DTLS)",example="5688",readOnly=true)
IntegersecurityPort;
IntegersecurityPort;
StringserverPublicKey;
@ApiModelProperty(position=5,value="Server short Id",example="111",readOnly=true)
booleanbootstrapServerIs=true;
IntegerclientHoldOffTime=1;
IntegerserverId=111;
IntegerserverId=111;
@ApiModelProperty(position=7,value="Client Hold Off Time",example="1",readOnly=true)
IntegerclientHoldOffTime=1;
@ApiModelProperty(position=8,value="Server Public Key (base64 encoded)",example="MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEAZ0pSaGKHk/GrDaUDnQZpeEdGwX7m3Ws+U/kiVat\n"+