Change

Description

The change type contains the field that was changed, plus prior and new values.

Parameters

Name Type Description
field FieldIdentifier The field that was changed.
priorValue string Contains the prior field value. Only populated if displayPriorValues is set to true.
newValue string The new field value.
extendedData ExtendedData Placeholder for future arguments.

Usage

The change type is part of the ItemChangeAction response. Use GetItemsChangeHistory to retrieve the data shown here.

ItemChangeAction holds the same information that you see in the details of the Change History for an item. Field values are presented in format ready to be displayed to end user without any internal identifiers. For example, if the Owner field was changed, only the user name is returned without the internal user ID.

XML

The following XML snippet shows the change type in the GetItemsChangeHistory response.

<ae:change>
   <ae:field>
      <ae:displayName>State</ae:displayName>
      <ae:id>82</ae:id>
      <ae:uuid>ebda959b-cbef-434b-ab68-83f8a8c03730</ae:uuid>
      <ae:dbName>STATE</ae:dbName>
   </ae:field>
   <ae:priorValue>Evaluating Issue</ae:priorValue>
   <ae:newvalue>Resolved</ae:newvalue>
</ae:change>
<ae:change>
   <ae:field>
      <ae:displayName>Owner</ae:displayName>
      <ae:id>86</ae:id>
      <ae:uuid>91548936-7979-49eb-9a03-1cb4545361d4</ae:uuid>
      <ae:dbName>OWNER</ae:dbName>
   </ae:field>
   <ae:priorValue>Bill Admin</ae:priorValue>
   <ae:newvalue>(None)</ae:newvalue>
 </ae:change>
 <ae:change>
    <ae:field>
       <ae:displayName>Active/Inactive</ae:displayName>
       <ae:id>80</ae:id>
       <ae:uuid>e90174d9-76fa-4ac2-b2bd-13944626c685</ae:uuid>
       <ae:dbName>ACTIVEINACTIVE</ae:dbName>
    </ae:field>
    <ae:priorValue>Active</ae:priorValue>
    <ae:newvalue>Inactive</ae:newvalue>
 </ae:change>