ClientProfileFieldCategory Data Type

Group of profile subcategories that is owned by a client.

Properties
name data type description
displayName string The label for the category
subcategories array of ClientProfileFieldSubcategory Subcategories that are owned by this category
displayOrder number The order in which to display the category in relation to other categories.
hidden boolean Should this category be hidden from the user?
headerText string
profileFieldCategoryId number
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

{
  "displayName" : "...",
  "subcategories" : [ {
    "displayName" : "...",
    "fields" : [ {
      "inputType" : { },
      "fieldType" : { },
      "displayName" : "...",
      "displayOrder" : 12345,
      "hidden" : true,
      "readOnly" : true,
      "defaultValue" : "...",
      "selectValues" : [ { }, { } ],
      "required" : true,
      "requiredInGroup" : true,
      "minLength" : 12345,
      "maxLength" : 12345,
      "shouldMask" : true,
      "maskBeginIndex" : 12345,
      "maskEndIndex" : 12345,
      "phoneType" : { },
      "addressType" : { },
      "customFieldName" : "...",
      "transform" : "...",
      "preferred" : true,
      "encrypted" : true,
      "fieldVisibility" : { },
      "setOnUserCreation" : true,
      "composite" : true,
      "childFields" : [ { }, { } ],
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "inputType" : { },
      "fieldType" : { },
      "displayName" : "...",
      "displayOrder" : 12345,
      "hidden" : true,
      "readOnly" : true,
      "defaultValue" : "...",
      "selectValues" : [ { }, { } ],
      "required" : true,
      "requiredInGroup" : true,
      "minLength" : 12345,
      "maxLength" : 12345,
      "shouldMask" : true,
      "maskBeginIndex" : 12345,
      "maskEndIndex" : 12345,
      "phoneType" : { },
      "addressType" : { },
      "customFieldName" : "...",
      "transform" : "...",
      "preferred" : true,
      "encrypted" : true,
      "fieldVisibility" : { },
      "setOnUserCreation" : true,
      "composite" : true,
      "childFields" : [ { }, { } ],
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "displayOrder" : 12345,
    "hidden" : true,
    "multipleInstances" : true,
    "headerText" : "...",
    "profileFieldSubcategoryId" : 12345,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "displayName" : "...",
    "fields" : [ {
      "inputType" : { },
      "fieldType" : { },
      "displayName" : "...",
      "displayOrder" : 12345,
      "hidden" : true,
      "readOnly" : true,
      "defaultValue" : "...",
      "selectValues" : [ { }, { } ],
      "required" : true,
      "requiredInGroup" : true,
      "minLength" : 12345,
      "maxLength" : 12345,
      "shouldMask" : true,
      "maskBeginIndex" : 12345,
      "maskEndIndex" : 12345,
      "phoneType" : { },
      "addressType" : { },
      "customFieldName" : "...",
      "transform" : "...",
      "preferred" : true,
      "encrypted" : true,
      "fieldVisibility" : { },
      "setOnUserCreation" : true,
      "composite" : true,
      "childFields" : [ { }, { } ],
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "inputType" : { },
      "fieldType" : { },
      "displayName" : "...",
      "displayOrder" : 12345,
      "hidden" : true,
      "readOnly" : true,
      "defaultValue" : "...",
      "selectValues" : [ { }, { } ],
      "required" : true,
      "requiredInGroup" : true,
      "minLength" : 12345,
      "maxLength" : 12345,
      "shouldMask" : true,
      "maskBeginIndex" : 12345,
      "maskEndIndex" : 12345,
      "phoneType" : { },
      "addressType" : { },
      "customFieldName" : "...",
      "transform" : "...",
      "preferred" : true,
      "encrypted" : true,
      "fieldVisibility" : { },
      "setOnUserCreation" : true,
      "composite" : true,
      "childFields" : [ { }, { } ],
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "displayOrder" : 12345,
    "hidden" : true,
    "multipleInstances" : true,
    "headerText" : "...",
    "profileFieldSubcategoryId" : 12345,
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "displayOrder" : 12345,
  "hidden" : true,
  "headerText" : "...",
  "profileFieldCategoryId" : 12345,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}