CustomFieldHistoryTracking
Query information regarding histories for a particular custom field.
Table-Specific Information
Select
The cmdlet uses the Zoho CRM API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client-side within the cmdlet.
- ModuleName supports the '=' operator.
- EntityId supports the '=' operator.
- FieldName supports the '=' operator.
- HistoryName supports the '=' operator.
All columns used in the criteria are required. Use FieldName to specify the actual name of the tracked custom field and HistoryName to specify the name of the history tracking section. If you want to retrieve data for a specific entity of a module specify EntityId in the criteria.
For example, the following query is processed server side:
SELECT * FROM [CustomFieldHistoryTracking] WHERE ModuleName = 'Leads' AND FieldName = 'pickListField' AND HistoryName = 'Pick List 1' SELECT * FROM [CustomFieldHistoryTracking] WHERE ModuleName = 'Leads' AND FieldName = 'pickListField' AND HistoryName = 'Pick List 1' AND EntityId = '12345665'
Columns
| Name | Type | Description |
| Id [KEY] | String | A unique numeric identifier for the history. |
| ModuleName | String | A unique numeric identifier for the module instance this custom field tracking belongs to. |
| EntityId | String | A unique numeric identifier for the module instance this custom field tracking belongs to. |
| FieldName | String | The name of the custom field. |
| HistoryName | String | The name of the custom field tracking history. |
| FieldValue | String | The value of the custom field. |
| DurationDays | Integer | The duration of this stage. |
| ModifiedAt | Datetime | The time this historical value was last modified. |
| ModifiedById | String | The id of the user who modified the value. |
| ModifiedByName | String | The name of the user who modified the value. |
| CurrencySymbol | String | The currency symbol for the value. |
| ProcessFlow | Boolean | The boolean indicating the process flow for this historical value. |
| Editable | Boolean | The boolean indicating if this historical value can be edited. |
| Approved | Boolean | The boolean indicating if this historical value has been approved. |