EntitySpecification Data Type

Type that describes a Waterline Data object type.

Abstract Type
Properties
name data type description
propertySpecifications array of PropertySpecification
entitySpecType string
entitySchemaJson string
propertyNames array of string
uniqueKeyProps array of string
requiredProps array of string
propertyGroup string
Properties inherited from Entity
key string
type string
description string
timeOfLastChange number
timeOfCreation number
restricted array of string
updateable array of string
viewAble array of string
customProperties array of CustomProperty

Example

This data type is abstract. The example below may be incomplete. More accurate examples can be found in subtypes pages.
{
  "propertySpecifications" : [ {
    "facetable" : true,
    "label" : "...",
    "description" : "...",
    "name" : "...",
    "property_type" : "...",
    "item_type" : "...",
    "permission_group" : "...",
    "is_custom_property" : true,
    "_custom_property" : true,
    "groupKey" : "...",
    "searchable" : true,
    "_case_sensitive" : true,
    "supports_special_chars" : true
  }, {
    "facetable" : true,
    "label" : "...",
    "description" : "...",
    "name" : "...",
    "property_type" : "...",
    "item_type" : "...",
    "permission_group" : "...",
    "is_custom_property" : true,
    "_custom_property" : true,
    "groupKey" : "...",
    "searchable" : true,
    "_case_sensitive" : true,
    "supports_special_chars" : true
  } ],
  "entitySpecType" : "...",
  "entitySchemaJson" : "...",
  "propertyNames" : [ "...", "..." ],
  "uniqueKeyProps" : [ "...", "..." ],
  "requiredProps" : [ "...", "..." ],
  "propertyGroup" : "...",
  "key" : "...",
  "type" : "...",
  "description" : "...",
  "timeOfLastChange" : 12345,
  "timeOfCreation" : 12345,
  "restricted" : [ "...", "..." ],
  "updateable" : [ "...", "..." ],
  "viewAble" : [ "...", "..." ],
  "customProperties" : [ {
    "displayName" : "...",
    "value" : { },
    "description" : "...",
    "facetAble" : true,
    "name" : "...",
    "type" : "..."
  }, {
    "displayName" : "...",
    "value" : { },
    "description" : "...",
    "facetAble" : true,
    "name" : "...",
    "type" : "..."
  } ]
}