ProfileFieldCategory Data Type

A profile field category is a combined group of subcategories that lets us keep our display tidy when we render the profile form.

Properties
name data type description
displayName string The label for the category.
hidden boolean Should this category be hidden from the user?
subcategories array of ProfileFieldSubcategory A collection of subcategories under this category.
displayOrder number The order of display in relation to other categories.
headerText string DO NOT USE. UP FOR DEPRECATION.
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" : "...",
  "hidden" : true,
  "subcategories" : [ {
    "displayName" : "...",
    "fields" : [ {
      "propertyName" : "...",
      "displayName" : "...",
      "type" : { },
      "displayOrder" : 12345,
      "hidden" : true,
      "readonly" : true,
      "defaultValue" : "...",
      "required" : true,
      "requiredInGroup" : true,
      "fullDisplayName" : "...",
      "shouldMask" : true,
      "maskBeginIndex" : 12345,
      "maskEndIndex" : 12345,
      "minLength" : 12345,
      "maxLength" : 12345,
      "custom" : true,
      "customFieldName" : "...",
      "fieldGroup" : { },
      "preferred" : true,
      "encrypted" : true,
      "fieldVisibility" : { },
      "setOnUserCreation" : true,
      "composite" : true,
      "childFields" : [ { }, { } ],
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "propertyName" : "...",
      "displayName" : "...",
      "type" : { },
      "displayOrder" : 12345,
      "hidden" : true,
      "readonly" : true,
      "defaultValue" : "...",
      "required" : true,
      "requiredInGroup" : true,
      "fullDisplayName" : "...",
      "shouldMask" : true,
      "maskBeginIndex" : 12345,
      "maskEndIndex" : 12345,
      "minLength" : 12345,
      "maxLength" : 12345,
      "custom" : true,
      "customFieldName" : "...",
      "fieldGroup" : { },
      "preferred" : true,
      "encrypted" : true,
      "fieldVisibility" : { },
      "setOnUserCreation" : true,
      "composite" : true,
      "childFields" : [ { }, { } ],
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "displayOrder" : 12345,
    "hidden" : true,
    "multipleInstances" : true,
    "headerText" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  }, {
    "displayName" : "...",
    "fields" : [ {
      "propertyName" : "...",
      "displayName" : "...",
      "type" : { },
      "displayOrder" : 12345,
      "hidden" : true,
      "readonly" : true,
      "defaultValue" : "...",
      "required" : true,
      "requiredInGroup" : true,
      "fullDisplayName" : "...",
      "shouldMask" : true,
      "maskBeginIndex" : 12345,
      "maskEndIndex" : 12345,
      "minLength" : 12345,
      "maxLength" : 12345,
      "custom" : true,
      "customFieldName" : "...",
      "fieldGroup" : { },
      "preferred" : true,
      "encrypted" : true,
      "fieldVisibility" : { },
      "setOnUserCreation" : true,
      "composite" : true,
      "childFields" : [ { }, { } ],
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "propertyName" : "...",
      "displayName" : "...",
      "type" : { },
      "displayOrder" : 12345,
      "hidden" : true,
      "readonly" : true,
      "defaultValue" : "...",
      "required" : true,
      "requiredInGroup" : true,
      "fullDisplayName" : "...",
      "shouldMask" : true,
      "maskBeginIndex" : 12345,
      "maskEndIndex" : 12345,
      "minLength" : 12345,
      "maxLength" : 12345,
      "custom" : true,
      "customFieldName" : "...",
      "fieldGroup" : { },
      "preferred" : true,
      "encrypted" : true,
      "fieldVisibility" : { },
      "setOnUserCreation" : true,
      "composite" : true,
      "childFields" : [ { }, { } ],
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "displayOrder" : 12345,
    "hidden" : true,
    "multipleInstances" : true,
    "headerText" : "...",
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  } ],
  "displayOrder" : 12345,
  "headerText" : "...",
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}