ICustomFieldService1

Operations

NameSignatureDescription
BulkGetAllCustomFieldsCustomFieldBulkGetResult1[] BulkGetAllCustomFields(Uri[] objectUris)Get all the custom fields on a for a set of objects or groups
BulkGetEnabledCustomFieldsCustomFieldBulkGetResult1[] BulkGetEnabledCustomFields(Uri[] objectUris)Get all the enabled custom fields on a for a set of objects or groups
BulkGetVisibleCustomFieldsCustomFieldBulkGetResult1[] BulkGetVisibleCustomFields(Uri[] objectUris)Get all the enabled and visible custom fields on a for a set of objects or groups
ConfigureToAllowEmptyValuevoid ConfigureToAllowEmptyValue(Uri customFieldUri)Modify custom field to allow empty value
ConfigureToRequireValuevoid ConfigureToRequireValue(Uri customFieldUri)Modify custom field that the value is required, and change to be shown if hidden
CreateEditDraftUri CreateEditDraft(Uri customFieldUri)Create an edit draft of an existing custom field.
CreateNewDraftUri CreateNewDraft(Uri customFieldGroupUri)Create a draft of a custom field.
Deletevoid Delete(Uri customFieldUri)Delete the specified custom field
Disablevoid Disable(Uri customFieldUri)Modify the custom field to be disabled so does not show up in user interface
Enablevoid Enable(Uri customFieldUri)Modify the custom field to be displayed in user interface
GetAllCustomFieldDropDownOptionsCustomFieldDropDownOptionDetails1[] GetAllCustomFieldDropDownOptions(Uri customFieldUri)Get all drop-down options for a drop-down custom field
GetAllCustomFieldsCustomFieldDetails1[] GetAllCustomFields(Uri objectUri)Get all the custom fields on a particular object or in a particular group
GetCustomFieldDetailsCustomFieldDetails1 GetCustomFieldDetails(CustomFieldTargetParameter1 customField)Get custom field details using custom field target
GetCustomFieldGroupCustomFieldGroupReference1 GetCustomFieldGroup(Uri objectTypeUri)Retrieve the custom field group for the specified object type. May be null if the object type does not support custom fields
GetCustomFieldGroupsCustomFieldGroupReference1[] GetCustomFieldGroups()Get the available groups for custom fields.
GetCustomFieldTypesCustomFieldTypeDetails1[] GetCustomFieldTypes()Get the available types of custom fields
GetDateValueDate1 GetDateValue(Uri objectUri, Uri customFieldUri)Get the value for the specified custom field which is a 'date' custom field type
GetDropdownValueCustomFieldDropDownOptionDetails1 GetDropdownValue(Uri objectUri, Uri customFieldUri)Get the value for the specified custom field which is a 'dropdown' custom field type
GetEnabledCustomFieldDropDownOptionsCustomFieldDropDownOptionDetails1[] GetEnabledCustomFieldDropDownOptions(Uri customFieldUri)Get all enabled drop-down options for a drop-down custom field
GetEnabledCustomFieldsCustomFieldDetails1[] GetEnabledCustomFields(Uri objectUri)Get all the enabled custom fields on a particular object or in a particular group
GetNumericValueNullable<Double> GetNumericValue(Uri objectUri, Uri customFieldUri)Get the value for the specified custom field which is a 'numeric' custom field type
GetPageOfAllCustomFieldDropDownOptionsCustomFieldDropDownOptionDetails1[] GetPageOfAllCustomFieldDropDownOptions(Int32 page, Int32 pageSize, Uri customFieldUri)Get a page of all (enabled and disabled) drop-down options for a drop-down custom field
GetPageOfEnabledCustomFieldDropDownOptionsCustomFieldDropDownOptionDetails1[] GetPageOfEnabledCustomFieldDropDownOptions(Int32 page, Int32 pageSize, Uri customFieldUri)Get a page of enabled drop-down options for a drop-down custom field
GetTextValueString GetTextValue(Uri objectUri, Uri customFieldUri)Get the value for the specified custom field which is a 'text' custom field type
GetValueCustomFieldValueDetails1 GetValue(Uri objectUri, Uri customFieldUri)Get the detailed representation of the value for the specified custom field on the specified object
GetValueAsTextString GetValueAsText(Uri objectUri, Uri customFieldUri)Get the textual representation of the value for the specified custom field on the specified object
GetVisibleCustomFieldsCustomFieldDetails1[] GetVisibleCustomFields(Uri objectUri)Get all the enabled and visible custom fields on a particular object or in a particular group
Hidevoid Hide(Uri customFieldUri)Modify the custom field to be hidden in user interface and change to not required if set
IsDropDownOptionInUseBoolean IsDropDownOptionInUse(Uri customFieldDropDownOptionUri)Checks if the dropdown option is in Use
PublishDraftCustomFieldDetails1 PublishDraft(Uri draftUri)Publish the custom field draft into a persisted custom field.
PutCustomFieldCustomFieldReference1 PutCustomField(CustomFieldParameter1 customField)Put the entire custom field details. If CustomFieldParameter1.target.name is specifed and not found, a custom field will be created
PutDropDownOptionsvoid PutDropDownOptions(Uri customFieldUri, CustomFieldDropDownOptionParameter1[] customFieldDropDownOptionUris)Replace the drop-down options available on a drop-down custom field
Reordervoid Reorder(Uri[] customFieldUris)Change the order of custom fields in a particular group
ReplaceTypevoid ReplaceType(Uri customFieldUri, Uri customFieldTypeUri)Replace the type of the custom field, and remove all existing data
Showvoid Show(Uri customFieldUri)Modify the custom field to show up in user interface, and enable if disabled
UpdateDateDefaultValuevoid UpdateDateDefaultValue(Uri customFieldUri, Date1 defaultValue)Modify the default value of a date custom field
UpdateDateDefaultValueToTodayvoid UpdateDateDefaultValueToToday(Uri customFieldUri)Modify the default value of a date custom field to the $Today special default value
UpdateDateRangevoid UpdateDateRange(Uri customFieldUri, Date1 minimumDate, Date1 maximumDate)Modify the default value of a date custom field
UpdateDateValuevoid UpdateDateValue(Uri objectUri, Uri customFieldUri, Date1 value)Set the value for the specified custom field which is a 'date' custom field type
UpdateDropDownDefaultValuevoid UpdateDropDownDefaultValue(Uri customFieldUri, Uri customFieldDropDownOptionUri)Modify the default value of a drop-down custom field
UpdateDropDownOptionIsEnabledvoid UpdateDropDownOptionIsEnabled(Uri customFieldDropDownOptionUri, Boolean isEnabled)Modify the enabled state of a drop-down value on a drop-down custom field
UpdateDropdownValuevoid UpdateDropdownValue(Uri objectUri, Uri customFieldUri, Uri customFieldDropDownOptionUri)Set the value for the specified custom field which is a 'dropdown' custom field type
UpdateNamevoid UpdateName(Uri customFieldUri, String name)Modify the name of the custom field
UpdateNumericDefaultValuevoid UpdateNumericDefaultValue(Uri customFieldUri, Nullable<Double> defaultValue)Modify the default value of a numeric custom field
UpdateNumericPrecisionvoid UpdateNumericPrecision(Uri customFieldUri, Int32 decimalPlaces)Modify the number of decimals places to show of a numeric custom field
UpdateNumericRangevoid UpdateNumericRange(Uri customFieldUri, Nullable<Double> minimumValue, Nullable<Double> maximumValue)Modify the number minimum and maximum value of a numeric custom field
UpdateNumericValuevoid UpdateNumericValue(Uri objectUri, Uri customFieldUri, Nullable<Double> value)Set the value for the specified custom field which is a 'numeric' custom field type
UpdateTextDefaultValuevoid UpdateTextDefaultValue(Uri customFieldUri, String defaultValue)Modify the default value of a text custom field
UpdateTextValuevoid UpdateTextValue(Uri objectUri, Uri customFieldUri, String value)Set the value for the specified custom field which is a 'text' custom field type