Name | Signature | Description |
---|
BulkGetAllCustomFields | CustomFieldBulkGetResult1[] BulkGetAllCustomFields(Uri[] objectUris) | Get all the custom fields on a for a set of objects or groups |
BulkGetEnabledCustomFields | CustomFieldBulkGetResult1[] BulkGetEnabledCustomFields(Uri[] objectUris) | Get all the enabled custom fields on a for a set of objects or groups |
BulkGetVisibleCustomFields | CustomFieldBulkGetResult1[] BulkGetVisibleCustomFields(Uri[] objectUris) | Get all the enabled and visible custom fields on a for a set of objects or groups |
ConfigureToAllowEmptyValue | void ConfigureToAllowEmptyValue(Uri customFieldUri) | Modify custom field to allow empty value |
ConfigureToRequireValue | void ConfigureToRequireValue(Uri customFieldUri) | Modify custom field that the value is required, and change to be shown if hidden |
CreateEditDraft | Uri CreateEditDraft(Uri customFieldUri) | Create an edit draft of an existing custom field. |
CreateNewDraft | Uri CreateNewDraft(Uri customFieldGroupUri) | Create a draft of a custom field. |
Delete | void Delete(Uri customFieldUri) | Delete the specified custom field |
Disable | void Disable(Uri customFieldUri) | Modify the custom field to be disabled so does not show up in user interface |
Enable | void Enable(Uri customFieldUri) | Modify the custom field to be displayed in user interface |
GetAllCustomFieldDropDownOptions | CustomFieldDropDownOptionDetails1[] GetAllCustomFieldDropDownOptions(Uri customFieldUri) | Get all drop-down options for a drop-down custom field |
GetAllCustomFields | CustomFieldDetails1[] GetAllCustomFields(Uri objectUri) | Get all the custom fields on a particular object or in a particular group |
GetCustomFieldDetails | CustomFieldDetails1 GetCustomFieldDetails(CustomFieldTargetParameter1 customField) | Get custom field details using custom field target |
GetCustomFieldGroup | CustomFieldGroupReference1 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 |
GetCustomFieldGroups | CustomFieldGroupReference1[] GetCustomFieldGroups() | Get the available groups for custom fields. |
GetCustomFieldTypes | CustomFieldTypeDetails1[] GetCustomFieldTypes() | Get the available types of custom fields |
GetDateValue | Date1 GetDateValue(Uri objectUri, Uri customFieldUri) | Get the value for the specified custom field which is a 'date' custom field type |
GetDropdownValue | CustomFieldDropDownOptionDetails1 GetDropdownValue(Uri objectUri, Uri customFieldUri) | Get the value for the specified custom field which is a 'dropdown' custom field type |
GetEnabledCustomFieldDropDownOptions | CustomFieldDropDownOptionDetails1[] GetEnabledCustomFieldDropDownOptions(Uri customFieldUri) | Get all enabled drop-down options for a drop-down custom field |
GetEnabledCustomFields | CustomFieldDetails1[] GetEnabledCustomFields(Uri objectUri) | Get all the enabled custom fields on a particular object or in a particular group |
GetNumericValue | Nullable<Double> GetNumericValue(Uri objectUri, Uri customFieldUri) | Get the value for the specified custom field which is a 'numeric' custom field type |
GetPageOfAllCustomFieldDropDownOptions | CustomFieldDropDownOptionDetails1[] GetPageOfAllCustomFieldDropDownOptions(Int32 page, Int32 pageSize, Uri customFieldUri) | Get a page of all (enabled and disabled) drop-down options for a drop-down custom field |
GetPageOfEnabledCustomFieldDropDownOptions | CustomFieldDropDownOptionDetails1[] GetPageOfEnabledCustomFieldDropDownOptions(Int32 page, Int32 pageSize, Uri customFieldUri) | Get a page of enabled drop-down options for a drop-down custom field |
GetTextValue | String GetTextValue(Uri objectUri, Uri customFieldUri) | Get the value for the specified custom field which is a 'text' custom field type |
GetValue | CustomFieldValueDetails1 GetValue(Uri objectUri, Uri customFieldUri) | Get the detailed representation of the value for the specified custom field on the specified object |
GetValueAsText | String GetValueAsText(Uri objectUri, Uri customFieldUri) | Get the textual representation of the value for the specified custom field on the specified object |
GetVisibleCustomFields | CustomFieldDetails1[] GetVisibleCustomFields(Uri objectUri) | Get all the enabled and visible custom fields on a particular object or in a particular group |
Hide | void Hide(Uri customFieldUri) | Modify the custom field to be hidden in user interface and change to not required if set |
IsDropDownOptionInUse | Boolean IsDropDownOptionInUse(Uri customFieldDropDownOptionUri) | Checks if the dropdown option is in Use |
PublishDraft | CustomFieldDetails1 PublishDraft(Uri draftUri) | Publish the custom field draft into a persisted custom field. |
PutCustomField | CustomFieldReference1 PutCustomField(CustomFieldParameter1 customField) | Put the entire custom field details. If CustomFieldParameter1.target.name is specifed and not found, a custom field will be created |
PutDropDownOptions | void PutDropDownOptions(Uri customFieldUri, CustomFieldDropDownOptionParameter1[] customFieldDropDownOptionUris) | Replace the drop-down options available on a drop-down custom field |
Reorder | void Reorder(Uri[] customFieldUris) | Change the order of custom fields in a particular group |
ReplaceType | void ReplaceType(Uri customFieldUri, Uri customFieldTypeUri) | Replace the type of the custom field, and remove all existing data |
Show | void Show(Uri customFieldUri) | Modify the custom field to show up in user interface, and enable if disabled |
UpdateDateDefaultValue | void UpdateDateDefaultValue(Uri customFieldUri, Date1 defaultValue) | Modify the default value of a date custom field |
UpdateDateDefaultValueToToday | void UpdateDateDefaultValueToToday(Uri customFieldUri) | Modify the default value of a date custom field to the $Today special default value |
UpdateDateRange | void UpdateDateRange(Uri customFieldUri, Date1 minimumDate, Date1 maximumDate) | Modify the default value of a date custom field |
UpdateDateValue | void UpdateDateValue(Uri objectUri, Uri customFieldUri, Date1 value) | Set the value for the specified custom field which is a 'date' custom field type |
UpdateDropDownDefaultValue | void UpdateDropDownDefaultValue(Uri customFieldUri, Uri customFieldDropDownOptionUri) | Modify the default value of a drop-down custom field |
UpdateDropDownOptionIsEnabled | void UpdateDropDownOptionIsEnabled(Uri customFieldDropDownOptionUri, Boolean isEnabled) | Modify the enabled state of a drop-down value on a drop-down custom field |
UpdateDropdownValue | void UpdateDropdownValue(Uri objectUri, Uri customFieldUri, Uri customFieldDropDownOptionUri) | Set the value for the specified custom field which is a 'dropdown' custom field type |
UpdateName | void UpdateName(Uri customFieldUri, String name) | Modify the name of the custom field |
UpdateNumericDefaultValue | void UpdateNumericDefaultValue(Uri customFieldUri, Nullable<Double> defaultValue) | Modify the default value of a numeric custom field |
UpdateNumericPrecision | void UpdateNumericPrecision(Uri customFieldUri, Int32 decimalPlaces) | Modify the number of decimals places to show of a numeric custom field |
UpdateNumericRange | void UpdateNumericRange(Uri customFieldUri, Nullable<Double> minimumValue, Nullable<Double> maximumValue) | Modify the number minimum and maximum value of a numeric custom field |
UpdateNumericValue | void UpdateNumericValue(Uri objectUri, Uri customFieldUri, Nullable<Double> value) | Set the value for the specified custom field which is a 'numeric' custom field type |
UpdateTextDefaultValue | void UpdateTextDefaultValue(Uri customFieldUri, String defaultValue) | Modify the default value of a text custom field |
UpdateTextValue | void UpdateTextValue(Uri objectUri, Uri customFieldUri, String value) | Set the value for the specified custom field which is a 'text' custom field type |