UserDefinedFieldListItems

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

NOTE  You can refer to the Online Help to find root and child access URLs of the entity you wish to query. Refer to Finding resource and child access URLs of REST API entities for more information.

Entity details

Entity Name: UserDefinedFieldListItems

Entity Path:

/atservicesrest/v1.0/UserDefinedFieldListItems

Parent Entity:

REST API: User-defined fields (UDFs)

Can Create:
Can Update:
Can Query:
Can Delete:  
Can Have UDFs:  

IMPORTANT  Requests to this entity require special handling. Refer to the Entity URLs and relationships section of this article for details.

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.

NOTE  Not all entities use UDFs. To determine an entity's scope of UDF support, locate it in the and click to open the entity's topic. Alternately, use the GET call against the entity path listed for the entity in its topic.

Field definitions

Field Name Datatype Read-Only Is Required Reference Name Picklist
createDate datetime      
id long    
isActive boolean

 

 

 

 
udfFieldId long   UserDefinedFieldDefinitions  
valueForDisplay string (128)      
valueForExport string (128)      

Additional resources