GetItemsChangeHistory

Description

This service returns a range of change history for one or more primary or auxiliary items.

Arguments

Argument	Type	Description
auth (optional)	Auth	The Auth type supplies credentials and optionally, a host name for licensing. The userId and password can be specified with HTTP BASIC or WS-SECURITY instead.
item (required)	ItemIdentifier	Specifies the item for which change history is returned. Send multiple item arguments to return history for multiple items.
queryRange (optional)	QueryRange	The QueryRange type allows you to specify the number of change records to return. It can be used to limit the number of changes that are returned.
options	ChangeHistoryResponseOptions	Enables you to limit the data that is returned in the response. Also used to specify whether the service should continue or stop if an error is encountered. Boolean options enable you to control the display of history records returned in the response.

Response

ItemChangeHistoryHolder is returned for each item. A list of items containing each change record, within the specified range, is displayed in the response. The response contains detailed information about each field value change, including the state, user who performed the transition, and the item's owner. For more detail, see ItemChangeHistoryHolder.

Usage

You use GetItemsChangeHistory to return either the entire change history for an item or only a portion of the history. The information that is returned is the same information that is stored in the TS_CHANGES table in the database. Use the GetItemsChangeHistory call if you want to retrieve the details of an item's changes for audit purposes.

Faults

Invalid User ID or Password.
Invalid item id 0 for table 0.

XML

The following XML is a snippet of the payload that is sent with GetItemsChangeHistory to only return the most recent changes that were made to the Status Log field for the specified item.

<urn:GetItemsChangeHistory>         
    <urn:auth>
        <urn:userId>admin</urn:userId>
        <urn:password></urn:password>
    </urn:auth>
    <urn:item>
        <urn:tableIdItemId>1000:109</urn:tableIdItemId>
    </urn:item>
    <urn:queryRange>
        <urn:startIndex></urn:startIndex>
        <urn:fetchSize>1</urn:fetchSize>
        <urn:totalCount></urn:totalCount>
    </urn:queryRange>
    <urn:options>
        <urn:sections>SECTIONS-SPECIFIED</urn:sections>
        <urn:specifiedSections>SECTION:EXTENDED</urn:specifiedSections>
        <urn:limitedField>
            <urn:dbName>STATUS_LOG</urn:dbName>
        </urn:limitedField>
        <urn:displayPriorValues>true</urn:displayPriorValues>
        <urn:sortNewFirst>true</urn:sortNewFirst>
    </urn:options>
  </urn:GetItemsChangeHistory>