privatestaticfinalStringALARM_QUERY_TEXT_SEARCH_DESCRIPTION="The case insensitive 'startsWith' filter based on of next alarm fields: type, severity or status";
privatestaticfinalStringALARM_QUERY_START_TIME_DESCRIPTION="The start timestamp(milliseconds) of the search time range over the alarm object field: 'createdTime'.";
privatestaticfinalStringALARM_QUERY_END_TIME_DESCRIPTION="The end timestamp(milliseconds) of the search time range over the alarm object field: 'createdTime'.";
privatestaticfinalStringALARM_QUERY_START_TIME_DESCRIPTION="The start timestamp in milliseconds of the search time range over the Alarm class field: 'createdTime'.";
privatestaticfinalStringALARM_QUERY_END_TIME_DESCRIPTION="The end timestamp in milliseconds of the search time range over the Alarm class field: 'createdTime'.";
privatestaticfinalStringALARM_QUERY_FETCH_ORIGINATOR_DESCRIPTION="A boolean value to specify if the alarm originator name will be "+
"filled in the AlarmInfo object field: 'originatorName' or will returns as null.";
protectedfinalStringAUDIT_LOG_ACTION_TYPES_DESCRIPTION="A String value representing action types parameter. The value is not required, but it can be any value of ActionType class. "+
"For example, 'ADDED,DELETED,UPDATED,LOGIN,LOGOUT'.";
protectedfinalStringSORT_AUDIT_LOG_PROPERTY_DESCRIPTION="Property of logs to sort by";
privatestaticfinalStringAUDIT_LOG_QUERY_START_TIME_DESCRIPTION="The start timestamp in milliseconds of the search time range over the AuditLog class field: 'createdTime'.";
privatestaticfinalStringAUDIT_LOG_QUERY_END_TIME_DESCRIPTION="The end timestamp in milliseconds of the search time range over the AuditLog class field: 'createdTime'.";
privatestaticfinalStringAUDIT_LOG_QUERY_ACTION_TYPES_DESCRIPTION="A String value representing comma-separated list of action types. "+
"This parameter is optional, but it can be used to filter results to fetch only audit logs of specific action types. "+
"For example, 'LOGIN', 'LOGOUT'. See the 'Model' tab of the Response Class for more details.";
privatestaticfinalStringAUDIT_LOG_SORT_PROPERTY_DESCRIPTION="Property of audit log to sort by. "+
"See the 'Model' tab of the Response Class for more details. "+
"Note: entityType sort property is not defined in the AuditLog class, however, it can be used to sort audit logs by types of entities that were logged.";
@ApiOperation(value="Get audit logs by customer id (getAuditLogsByCustomerId)",
notes="Returns a page of audit logs by selected customer. "+PAGE_DATA_PARAMETERS,
notes="Returns a page of audit logs related to the targeted customer entities(devices, assets, etc.), "+
"and users actions(login, logout, etc.) that belong to this customer. "+
@ -186,6 +186,7 @@ public abstract class BaseController {
protectedfinalStringDEVICE_TEXT_SEARCH_DESCRIPTION="The case insensitive 'startsWith' filter based on the device name.";
protectedfinalStringCUSTOMER_TEXT_SEARCH_DESCRIPTION="The case insensitive 'startsWith' filter based on the customer title.";
protectedfinalStringEVENT_TEXT_SEARCH_DESCRIPTION="The value is not used in searching.";
protectedfinalStringAUDIT_LOG_TEXT_SEARCH_DESCRIPTION="The case insensitive 'startsWith' filter based on one of the next properties: entityType, entityName, userName, actionType, actionStatus.";
protectedfinalStringSORT_PROPERTY_DESCRIPTION="Property of entity to sort by";
protectedfinalStringDEVICE_INFO_DESCRIPTION="Device Info is an extension of the default Device object that contains information about the assigned customer name and device profile name. ";
@ -205,8 +207,10 @@ public abstract class BaseController {
protectedfinalStringEVENT_START_TIME_DESCRIPTION="Timestamp. Events with creation time before it won't be queried.";
protectedfinalStringEVENT_END_TIME_DESCRIPTION="Timestamp. Events with creation time after it won't be queried.";
protectedstaticfinalStringRELATION_TYPE_PARAM_DESCRIPTION="A string value representing relation type between entities. For example, 'Contains', 'Manages'. It can be any string value.";
protectedstaticfinalStringRELATION_TYPE_GROUP_PARAM_DESCRIPTION="A string value representing relation type group. For example, 'COMMON'";
protectedfinalStringRELATION_TYPE_PARAM_DESCRIPTION="A string value representing relation type between entities. For example, 'Contains', 'Manages'. It can be any string value.";
protectedfinalStringRELATION_TYPE_GROUP_PARAM_DESCRIPTION="A string value representing relation type group. For example, 'COMMON'";
protectedfinalStringADMINISTRATOR_AUTHORITY_ONLY="Available for users with 'Tenant Administrator' authority only.";
@ApiModelProperty(position=6,value="Name of the logged entity",example="Thermometer",readOnly=true)
privateStringentityName;
@ApiModelProperty(position=5,value="JSON object with User id.",readOnly=true)
@ApiModelProperty(position=7,value="JSON object with User id.",readOnly=true)
privateUserIduserId;
@ApiModelProperty(position=6,value="Unique User Name in scope of Administrator.",example="Tenant",readOnly=true)
@ApiModelProperty(position=8,value="Unique user name(email) of the user that performed some action on logged entity",example="tenant@thingsboard.org",readOnly=true)
@ApiModelProperty(position=12,value="Failure action details info. An empty string in case of action status type 'SUCCESS', otherwise includes stack trace of the caused exception.",readOnly=true)
privateStringactionFailureDetails;
publicAuditLog(){
@ -70,4 +70,17 @@ public class AuditLog extends BaseData<AuditLogId> {
ShvaykaD
5 years ago