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.
SOAP REST
Account Companies
AccountLocation CompanySiteConfigurations
Contact Contacts
Contract Contracts
InstalledProduct ConfigurationItems
Opportunity Opportunities
Product Products
Project Projects
SalesOrder SalesOrders
 

ServiceBundles

 

Services

Subscription Subscriptions
Task Tasks
Ticket Tickets

Each entity has a maximum number of active user-defined fields that you can define. For more information, refer to Managing user-defined fields.

IMPORTANT  You can only query by one user-defined field at a time.

To learn how to make PUT, PATCH, and POST requests to entities that support UDFs, refer to Creating resources via POST request in the REST API, Updating data via PUT request with the REST API and Updating data via PATCH request with the REST API.

Field definitions

The following table describes the standard Autotask field objects for this entity.

  • To retrieve more detailed information specific to a particular Autotask implementation, use the Web Services API call The getFieldInfo() SOAP API call.
  • For information on entity UDFs, use getUDFInfo().
  • For String datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.

For more information about fields marked as picklists, review our Understanding picklists article.

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)