ProfileValue Data Type

DO NOT USE. UP FOR DEPRECATION Combines encrypted and unencrypted profiles

Abstract Type
Subtypes
ProfileValueEncrypted, ProfileValueUnencrypted
Properties
name data type description
field ClientProfileField
value string
masked 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

This data type is abstract. The example below may be incomplete. More accurate examples can be found in subtypes pages.
{
  "field" : {
    "inputType" : {
      "code" : "...",
      "name" : "...",
      "dropdown" : true,
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "fieldType" : {
      "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" : [ { }, { } ]
    },
    "displayName" : "...",
    "displayOrder" : 12345,
    "hidden" : true,
    "readOnly" : true,
    "defaultValue" : "...",
    "selectValues" : [ {
      "displayName" : "...",
      "value" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    }, {
      "displayName" : "...",
      "value" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    } ],
    "required" : true,
    "requiredInGroup" : true,
    "minLength" : 12345,
    "maxLength" : 12345,
    "shouldMask" : true,
    "maskBeginIndex" : 12345,
    "maskEndIndex" : 12345,
    "phoneType" : {
      "type" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "addressType" : {
      "type" : "...",
      "code" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "customFieldName" : "...",
    "transform" : "...",
    "preferred" : true,
    "encrypted" : true,
    "fieldVisibility" : {
      "name" : "...",
      "description" : "...",
      "id" : 12345,
      "version" : 12345,
      "violations" : [ { }, { } ]
    },
    "setOnUserCreation" : true,
    "composite" : true,
    "childFields" : [ { }, { } ],
    "id" : 12345,
    "version" : 12345,
    "violations" : [ {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    }, {
      "propertyName" : "...",
      "failureMessage" : "...",
      "stackTrace" : "..."
    } ]
  },
  "value" : "...",
  "masked" : true,
  "id" : 12345,
  "version" : 12345,
  "violations" : [ {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  }, {
    "propertyName" : "...",
    "failureMessage" : "...",
    "stackTrace" : "..."
  } ]
}