Skip to content
Vault Logo
Vault Developer Portal Developer Clinical
Advanced Search

    Release Notes

    Docfield

    Class: metadata

    Attribute of a document associated to one or more document types.

    AttributeMetadataDescription
    secure_relationshipType: BooleanEnables relationship security on a referenced object.
    sharedType: Boolean
    Required    		Indicates whether the field is shared or local.
    multi_valueType: BooleanIndicates whether the field accepts multiple values.
    display_sectionType: String
    Required
    Max length: 1500    		Name of the display section. For example, Docfieldlayout.general_properties__v
    formulaType: Expression
    Max length: 4000    		An expression surrounded in [ ] character combination.
    blank_fieldsType: String
    Max length: 1500    		options:
    • zeros
    • blanks
    controlling_fieldType: String
    Max length: 1500    		Controlling field name, if any.
    scaleType: NumberApplicable to fields of type number only.
    default_securityType: String
    Max length: 1500    		options:
    • editable
    • readonly
    • hidden
    security_override_editableType: String
    Max length: 1500
    Multi-value    		To specify users: User.user@domain.com.
    To specify groups: Group.public_key__v.
    security_override_readonlyType: String
    Max length: 1500
    Multi-value    		To specify users: User.user@domain.com.
    To specify groups: Group.public_key__v.
    security_override_hiddenType: String
    Max length: 1500
    Multi-value    		To specify users: User.user@domain.com.
    To specify groups: Group.public_key__v.
    set_on_create_onlyType: BooleanCan only set if the user has a proper MDL admin permission.
    editableType: BooleanWhether the field is editable by the user.
    The value here is specific to the user and depends on security_overrides.
    hiddenType: BooleanIndicates whether the field is hidden in the UI.
    The value here is specific to the user and depends on security_overrides.
    defined_inType: String
    Max length: 1500    		The Doc Type this field belongs to (local fields only). e.g. Doctype.my_doc_type__c
    used_inType: String
    Max length: 1500
    Multi-value    		The Doc Type(s) this field is used in (shared fields only). e.g. Doctype.my_doc_type__c
    relationship_typeType: String
    Max length: 1500    		Can only return “reference” at this time.
    relationship_nameType: String
    Max length: 1500    		Auto-generated name based on the field name and the Vault object.
    lookupObjectFieldKeyType: String
    Max length: 1500    		Reference to Doc field component. Used for the Lookup field type.
    lookupObjectIdType: String
    Max length: 1500    		Reference to Object component. Used for the Lookup field type.
    lookupFieldIdType: String
    Max length: 1500    		Reference to Object field component. Used for the Lookup field type.
    relationship_criteriaType: String
    Max length: 1500
    Multi-value    		The VQL used to constrain records in the referenced Object
    no_copyType: BooleanWhen true a value will not be set in a copied document. Cannot be true when required is true.
    can_change_sectionType: BooleanFor internal Veeva use only.
    can_change_requiredType: BooleanFor internal Veeva use only.
    can_change_disabledType: BooleanFor internal Veeva use only.
    can_change_multipleType: BooleanFor internal Veeva use only.
    can_change_no_copyType: BooleanFor internal Veeva use only.
    picklistType: String
    Max length: 1500    		Reference to Picklist component.
    Used for the Picklist field type.
    help_contentType: String
    Max length: 500    		UI-friendly help string
    max_lengthType: NumberApplicable to fields of type string only.
    activeType: Boolean
    Required    		Indicates whether the field is active.
    requiredType: Boolean
    Required    		Indicates whether the field is required.
    typeType: String
    Required
    Max length: 1500    		options:
    • String
    • Number
    • Boolean
    • Picklist
    • Date
    • URL
    • Formula
    • ObjectReference
    • Lookup
    default_valueType: String
    Max length: 1500
    Multi-value    		The default value used when the field is not set.
    objectType: String
    Max length: 1500    		Possible values supported are names of VOF objects, User, Group, and Lifecycle.
    queryableType: BooleanIndicates whether the field is queryable through VQL. This attribute is read-only.
    scopeType: String
    Max length: 1500    		options:
    • Document
    • DocumentVersion

    Regular users can create Document scoped fields only.
    Creating DocumentVersion scoped fields requires special security permissions.
    min_valueType: NumberApplicable to fields of type number only.
    max_valueType: NumberFor Number type fields, this is the maximum value allowed. For ObjectReference type fields where multi-value is set to true, this is the maximum number of records that can be selected in the field. If not specified, the default is 250 values. This attribute is not editable for ObjectReference type fields, but may have a specific value set for some system-managed fields. If the value is greater than 500, VQL queries return an unordered list.
    labelType: String
    Required
    Max length: 1500    		UI-friendly string in the Vault's base language.

    Supported Operations

    Section link for Supported Operations
    OperationSupport
    Create
    Recreate
    Alter*
    Drop
    Rename
    Describe
    Generate Recreate
    Queryable

    Notes:

    • Alter: MDL Operation may not be supported for some multi-value attributes.