getUDFInfo()
IMPORTANT The SOAP API entered a limited enhancement phase in Q4 2020. Access to version 1.6 will be deactivated.
This API call is an informational Web Service that returns an array of all user-defined fields (UDF), that is, non-standard fields, for a specified entity. Currently, the following Autotask entities can include UDFs: Account, AccountLocation, Contact, Contract, InstalledProduct, Opportunity, Product, Project, SalesOrder, Task, Ticket.
getUDFInfo() returns the following information for each field.
Data | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Name as String | Name of the field element, this is not what you see on the UI. | ||||||||||
Label as String | Name of the field on the UI. | ||||||||||
Type as String | The field element data type String: Can contain alpha-numeric and most special characters (note: some fields have specific lengths) Double: Like Integer but can contain decimal places dateTime: Contains the date and time as one value like a time stamp Date: Date only, no time Boolean: True (Yes) (1) or False (No) (0) |
||||||||||
Description as String | The long Description of the field element. | ||||||||||
IsRequired as Boolean | True or False. Returns True (Yes) if the element is required to update or create. | ||||||||||
IsReadOnly as Boolean | True or False. Returns True (Yes) if the element cannot be updated or created. | ||||||||||
IsQueryable as Boolean | True or False. Returns True (Yes) if the element can be searched on. | ||||||||||
IsReference as Boolean | True or False. Returns True (Yes) if the field contains the ID value of another entity type. | ||||||||||
ReferenceEntityType as String | If the element IsReference is True (Yes), indicates the Entity Type of the reference. | ||||||||||
IsPicklist as Boolean | True or False. Returns True (Yes) if the element is a picklist, specifically a drop-down list. | ||||||||||
PickListValues() as PickListValue | If IsPicklist = True, then this will hold the values of the Drop Down List. The picklist values elements include the following:
|
||||||||||
IsSupportedWebhookField | True or False. Reflects whether the field is a webhook-capable field that can either trigger a callout or is always part of the information (payload) sent to the WebhookURL. |
Sample getUDFInfo() SOAP XML
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<AutotaskIntegrations xmlns="http://autotask.net/ATWS/v1_6/">
<IntegrationCode>[insert your own tracking identifier]</IntegrationCode>
</AutotaskIntegrations>
</soap:Header>
<soap:Body>
<getUDFInfo xmlns="http://autotask.net/ATWS/v1_6/">
<psTable>Account</psTable>
</getUDFInfo >
</soap:Body>
</soap:Envelope>