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.

Parent REST API: User-defined fields (UDFs)
URLs UserDefinedFieldListItems​/query (GET, POST)
UserDefinedFieldListItems​/{id} (GET)
UserDefinedFieldListItems​/query​/count (GET, POST)
UserDefinedFieldListItems​/entityInformation (GET)
​UserDefinedFieldListItems​/entityInformation​/fields (GET)
UserDefinedFieldListItems​/entityInformation​/userDefinedFields (GET)

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.

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 fields for this entity. Refer to the following articles for more information about working with these fields:

To learn how to query picklist endpoints, refer to Understanding picklists.

Notes

  • For string datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.
  • If this entity has child collections, they will appear in a Child collection access URLs or an Entity URLs and relationships drop-down in the Entity details section of this article.
  • You can call the /query/count/ endpoint of a resource to determine how many records a collection holds.
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