Web Services Developer's Guide → Web Services API Reference → SBM Application Web Services → Application Calls → GetStateChangeHistory
This service returns a specified range of state change history for an item.
|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 state change history is returned.|
|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 state changes that are returned.|
|options||Options||Holds name value pairing for future arguments.|
GetStateChangeHistoryResult is returned. A list containing each state change record, within the specified range, is displayed in the response. The response contains detailed information about each state change, including the state, the user who performed the transition, and the owner. For more detail, see GetStateChangeHistoryResult.
You use GetStateChangeHistory to return either the entire state 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_CHANGEACTIONS table in the database. Use the GetStateChangeHistory call if you want to retrieve the details of an item's lifecycle for audit purposes.
The following XML is a snippet of the payload that is sent with GetStateChangeHistory to only return history through the first two states.
<urn:GetStateChangeHistory> <urn:auth> <urn:userId>admin</urn:userId> <urn:password></urn:password> <urn:hostname></urn:hostname> <urn:loginAsUserId></urn:loginAsUserId> </urn:auth> <urn:item> <urn:displayName></urn:displayName> <urn:id></urn:id> <urn:uuid></urn:uuid> <urn:tableId></urn:tableId> <urn:tableIdItemId>1000:2</urn:tableIdItemId> <urn:issueId></urn:issueId> </urn:item> <urn:queryRange> <urn:startIndex></urn:startIndex> <urn:fetchSize>2</urn:fetchSize> <urn:totalCount></urn:totalCount> </urn:queryRange> </urn:GetStateChangeHistory>
Copyright © 2007–2016 Serena Software, Inc. All rights reserved.