Widget Data Type

An object that represents a widget and it's properties.

Properties
name data type description
weight number The number of locations that this widget fills.
description string A description of this widget's functionality.
name string The name of this widget, as shown to users.
code string The string to be used for the div id, the placeholder image for this widget, and the name of the action and view of the widget content.
permission string The string name of the permission associated with this widget. A user must have this permission to view the widget.
type string The type of widget, i.e. how the data is displayed. This directly corresponds to images that represent that data type.
viewPath string The url where this widget gets its content
small boolean
medium boolean
large boolean
Properties inherited from BaseHibernateEntity
id number The unique internal ID of the object.
version number For internal use only. This is the serialization recorder for optimistic locking of several objects between sessions.
Properties inherited from BaseEntity
violations array of SimpleViolation A list of constraint violations, if any, that this object has.

Example

{
  "weight" : 12345,
  "description" : "...",
  "name" : "...",
  "code" : "...",
  "permission" : "...",
  "type" : "...",
  "viewPath" : "...",
  "small" : true,
  "medium" : true,
  "large" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}