@ -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'";
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'";
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'";
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'";
@ -56,6 +56,7 @@ public class ControllerConstants {
protectedstaticfinalStringPAGE_SIZE_DESCRIPTION="Maximum amount of entities in a one page";
protectedstaticfinalStringPAGE_NUMBER_DESCRIPTION="Sequence number of page starting from 0";
protectedstaticfinalStringDEVICE_TYPE_DESCRIPTION="Device type as the name of the device profile";
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;
@ -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."
@ApiModelProperty(position=8,required=true,value="Set of telemetry and attribute keys to expose via Entity View.")
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;
@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;
publicEntityView(){
@ -73,6 +81,7 @@ public class EntityView extends SearchTextBasedWithAdditionalInfo<EntityViewId>
returngetName()/*What the ...*/;
}
@ApiModelProperty(position=4,value="JSON object with Customer Id. Use 'assignEntityViewToCustomer' to change the Customer Id.",readOnly=true)
@Override
publicCustomerIdgetCustomerId(){
returncustomerId;
@ -83,8 +92,31 @@ public class EntityView extends SearchTextBasedWithAdditionalInfo<EntityViewId>
returnname;
}
@ApiModelProperty(position=3,value="JSON object with Tenant Id.",readOnly=true)
@Override
publicTenantIdgetTenantId(){
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;
@ApiModelProperty(position=13,value="Indicates special 'Public' Customer that is auto-generated to use the entity view on public dashboards.",readOnly=true)
Andrii Shvaika
5 years ago