@ -157,19 +157,25 @@ public abstract class BaseController {
publicstaticfinalStringPAGE_DATA_PARAMETERS="You can specify parameters to filter the results. "+
"The result is wrapped with PageData object that allows you to iterate over result set using pagination. "+
"See the 'Model' tab of the Response Class for more details. ";
publicstaticfinalStringDASHBOARD_ID_PARAM_DESCRIPTION="A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
publicstaticfinalStringDEVICE_ID_PARAM_DESCRIPTION="A string value representing the device id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
publicstaticfinalStringDEVICE_PROFILE_ID_DESCRIPTION="A string value representing the device profile id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
publicstaticfinalStringTENANT_ID_PARAM_DESCRIPTION="A string value representing the tenant id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
publicstaticfinalStringEDGE_ID_PARAM_DESCRIPTION="A string value representing the edge id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
publicstaticfinalStringCUSTOMER_ID_PARAM_DESCRIPTION="A string value representing the customer id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'";
publicstaticfinalStringCUSTOMER_ID="customerId";
publicstaticfinalStringTENANT_ID="tenantId";
protectedfinalStringPAGE_SIZE_DESCRIPTION="Maximum amount of entities in a one page";
protectedfinalStringPAGE_NUMBER_DESCRIPTION="Sequence number of page starting from 0";
protectedfinalStringDEVICE_TYPE_DESCRIPTION="Device type as the name of the device profile";
protectedfinalStringDASHBOARD_TEXT_SEARCH_DESCRIPTION="The case insensitive 'startsWith' filter based on the dashboard title.";
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 name.";
protectedfinalStringCUSTOMER_TEXT_SEARCH_DESCRIPTION="The case insensitive 'startsWith' filter based on the customer title.";
protectedfinalStringSORT_PROPERTY_DESCRIPTION="Property of device 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. ";
publicstaticfinalStringCUSTOMER_SECURITY_CHECK="If the user has the authority of 'Tenant Administrator', the server checks that the customer is owned by the same tenant. "+
"If the user has the authority of 'Customer User', the server checks that the user belongs to the customer.";
@ -120,9 +119,10 @@ public class CustomerController extends BaseController {
}
@ApiOperation(value="Create or update Customer (saveCustomer)",
notes="Creates or Updates the Customer. Platform generates random Customer Id during device creation. "+
"The Customer Id will be present in the response. Specify the Customer Id when you would like to update the Customer. "+
"Referencing non-existing Customer Id will cause an error.")
notes="Creates or Updates the Customer. When creating customer, platform generates Customer Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address) "+
"The newly created Customer Id will be present in the response. "+
"Specify existing Customer Id to update the Customer. "+
"Referencing non-existing Customer Id will cause 'Not Found' error.")
publicstaticfinalStringDASHBOARD_INFO_DEFINITION="The Dashboard Info object contains lightweight information about the dashboard (e.g. title, image, assigned customers) but does not contain the heavyweight configuration JSON.";
publicstaticfinalStringDASHBOARD_DEFINITION="The Dashboard object is a heavyweight object that contains information about the dashboard (e.g. title, image, assigned customers) and also configuration JSON (e.g. layouts, widgets, entity aliases).";
publicstaticfinalStringHIDDEN_FOR_MOBILE="Exclude dashboards that are hidden for mobile";
@Value("${dashboard.max_datapoints_limit}")
privatelongmaxDatapointsLimit;
@ApiOperation(value="Get server time (getServerTime)",
notes="Get the server time (milliseconds since January 1, 1970 UTC). "+
"Used to adjust view of the dashboards according to the difference between browser and server time.")
@ -113,10 +138,20 @@ public class DashboardController extends BaseController {
}
}
@ApiOperation(value="Create Or Update Dashboard (saveDashboard)",
notes="Create or update the Dashboard. When creating dashboard, platform generates Dashboard Id as [time-based UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_1_(date-time_and_MAC_address)."+
"The newly created Dashboard id will be present in the response. "+
"Specify existing Dashboard id to update the dashboard. "+
"Referencing non-existing dashboard Id will cause 'Not Found' error. "+
"Only users with 'TENANT_ADMIN') authority may create the dashboards.",
@ -235,11 +288,20 @@ public class DashboardController extends BaseController {
}
}
@ApiOperation(value="Update the Dashboard Customers (updateDashboardCustomers)",
notes="Updates the list of Customers that this Dashboard is assigned to. Removes previous assignments to customers that are not in the provided list. "+
"Returns the Dashboard object. Only users with 'TENANT_ADMIN') authority may assign the dashboards to customers.",
@ -301,11 +363,19 @@ public class DashboardController extends BaseController {
}
}
@ApiOperation(value="Adds the Dashboard Customers (addDashboardCustomers)",
notes="Adds the list of Customers to the existing list of assignments for the Dashboard. Keeps previous assignments to customers that are not in the provided list. "+
"Returns the Dashboard object. Only users with 'TENANT_ADMIN') authority may assign the dashboards to customers.",
@ -345,11 +415,19 @@ public class DashboardController extends BaseController {
}
}
@ApiOperation(value="Remove the Dashboard Customers (removeDashboardCustomers)",
notes="Removes the list of Customers from the existing list of assignments for the Dashboard. Keeps other assignments to customers that are not in the provided list. "+
"Returns the Dashboard object. Only users with 'TENANT_ADMIN') authority may assign the dashboards to customers.",
@ -415,10 +503,16 @@ public class DashboardController extends BaseController {
}
}
@ApiOperation(value="Unassign the Dashboard from Public Customer (unassignDashboardFromPublicCustomer)",
notes="Unassigns the dashboard from a special, auto-generated 'Public' Customer. Once unassigned, unauthenticated users may no longer browse the dashboard. "+
"Returns the Dashboard object. Only users with 'TENANT_ADMIN') authority may assign the dashboards to customers.",
@ -512,6 +637,13 @@ public class DashboardController extends BaseController {
}
}
@ApiOperation(value="Get Home Dashboard (getHomeDashboard)",
notes="Returns the home dashboard object that is configured as 'homeDashboardId' parameter in the 'additionalInfo' of the User. "+
"If 'homeDashboardId' parameter is not set on the User level and the User has authority 'CUSTOMER_USER', check the same parameter for the corresponding Customer. "+
"If 'homeDashboardId' parameter is not set on the User and Customer levels then checks the same parameter for the Tenant that owns the user. "
+DASHBOARD_DEFINITION+" "+
"Only users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority should use this method.",
@ -543,6 +675,12 @@ public class DashboardController extends BaseController {
}
}
@ApiOperation(value="Get Home Dashboard Info (getHomeDashboardInfo)",
notes="Returns the home dashboard info object that is configured as 'homeDashboardId' parameter in the 'additionalInfo' of the User. "+
"If 'homeDashboardId' parameter is not set on the User level and the User has authority 'CUSTOMER_USER', check the same parameter for the corresponding Customer. "+
"If 'homeDashboardId' parameter is not set on the User and Customer levels then checks the same parameter for the Tenant that owns the user. "+
"Only users with 'TENANT_ADMIN' or 'CUSTOMER_USER' authority should use this method.",
@ -574,6 +712,10 @@ public class DashboardController extends BaseController {
}
}
@ApiOperation(value="Get Tenant Home Dashboard Info (getTenantHomeDashboardInfo)",
notes="Returns the home dashboard info object that is configured as 'homeDashboardId' parameter in the 'additionalInfo' of the corresponding tenant. "+
"Only users with 'TENANT_ADMIN' authority may use this method.",
@ -137,7 +137,7 @@ public class DeviceController extends BaseController {
}
@ApiOperation(value="Create Or Update Device (saveDevice)",
notes="Creates or Updates 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)"+
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). "+
"Device credentials are also generated if not provided in the 'accessToken' request parameter. "+
"The newly created device id will be present in the response. "+
"Specify existing Device id to update the device. "+
@ -376,15 +376,15 @@ public class DeviceController extends BaseController {
@ -86,6 +108,7 @@ public class DashboardInfo extends SearchTextBased<DashboardId> implements HasNa
this.assignedCustomers=assignedCustomers;
}
@ApiModelProperty(position=6,value="Hide dashboard from mobile devices. Useful if the dashboard is not designed for small screens.",readOnly=true)
publicbooleanisMobileHide(){
returnmobileHide;
}
@ -94,6 +117,7 @@ public class DashboardInfo extends SearchTextBased<DashboardId> implements HasNa
this.mobileHide=mobileHide;
}
@ApiModelProperty(position=7,value="Order on mobile devices. Useful to adjust sorting of the dashboards for mobile applications",readOnly=true)
publicIntegergetMobileOrder(){
returnmobileOrder;
}
@ -152,6 +176,7 @@ public class DashboardInfo extends SearchTextBased<DashboardId> implements HasNa
}
}
@ApiModelProperty(position=4,value="Same as title of the dashboard. Read-only field. Update the 'title' to change the 'name' of the dashboard.",readOnly=true)
@ApiModelProperty(position=1,value="Array of the entities.",readOnly=true)
@ApiModelProperty(position=1,value="Array of the entities",readOnly=true)
publicList<T>getData(){
returndata;
}
@ApiModelProperty(position=2,value="Total number of available pages. Calculated based on the 'pageSize' request parameter and total number of entities that match search criteria.",readOnly=true)
@ApiModelProperty(position=2,value="Total number of available pages. Calculated based on the 'pageSize' request parameter and total number of entities that match search criteria",readOnly=true)
publicintgetTotalPages(){
returntotalPages;
}
@ApiModelProperty(position=3,value="Total number of elements in all available pages.",readOnly=true)
@ApiModelProperty(position=3,value="Total number of elements in all available pages",readOnly=true)
publiclonggetTotalElements(){
returntotalElements;
}
@ApiModelProperty(position=4,value="'false' value indicates the end of the result set.",readOnly=true)
@ApiModelProperty(position=4,value="'false' value indicates the end of the result set",readOnly=true)
Andrii Shvaika
5 years ago