BulkUpdateSystem FieldValueInfo

Whether you choose to get a list of entity identities using OSQL, CustomSearch, or leveraging archive providers, we assume that you know how to execute a query that will result in one or more entity identities to update. With a list of entity identities to iterate over, bulk update operations are performed against the fields of that entity, that is, Person.Title and Person.Interest. The way bulk update understands which fields need to be updated is by using a FieldValueInfo instance, containing the following information:

• Key: the field name.
• Operation: the action to be performed.
• Values: the parameters that correspond to the operation.

​

FieldValueInfo.Key

FieldValueInfo.Key refers to an entity field name. While most of the entity field names are the same as seen in the database or API, some are not. See the listing of all field names and their affected API properties.

​

FieldValueInfo.CurrentOperationType

FieldValueInfo.CurrentOperationType is the action performed by the bulk update system. Use the BulkUpdateSystem.OperationTypes static class, containing all available operation values to set the intended action. Each operation has a predetermined set of parameters needed to perform successfully.

​

FieldValueInfo.Values

FieldValueInfo.Values is a string array that is expected to contain the parameters required by the field operation. Each operation has a different number of values required for each operation type. Continue reading: Operations and values.