UserDefinedFieldListItem

IMPORTANT  The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will eventually be deactivated. At this time, there is no end-of-lifecycle date.

This entity describes a list item associated with a UserDefinedFieldDefinition entity that has DataType = List.

NOTE  Not all entities use UDFs. To determine if an entity can use UDFs, locate it in the and click to open the entity's topic. Alternately, use the API calls The getEntityInfo() SOAP API call and getUDFInfo().

Entity details

You can also retrieve this information with the Web Services API call The getEntityInfo() SOAP API call.

Entity Name: UserDefinedFieldListItem
Can Create:
Can Update:
Can Query:
Can Delete:  
Can Have UDFs:  

Conditions and requirements

  • API calls to multi-select and reference UDFs are not supported.
  • A UserDefinedListItem requires a UdfFieldId that references an existing UserDefinedFieldDefinition.

  • ValueForDisplay cannot be changed if the UserDefinedFieldListItem is the default value for a
    UserDefinedFieldDefinition.

  • ValueForDisplay and ValueForExport are both required and must be unique within the collection of
    UserDefinedFieldListItems associated to a UserDefinedFieldDefinition.
  • IsActive defaults to true on create.

Field definitions

Field Name Label Datatype Read Only Is Required Reference Name Picklist
CreateDate Create Date datetime      
id ID long    

IsActive

Is Active

boolean

 

 

 

 
UdfFieldId User Defined Field Definition long   UserDefinedFieldDefinition  
ValueForDisplay Value For Display string (128)      
ValueForExport Value For Export string (128)