ChangeState Method (WorkItemWebClient)

In This Topic

Transaction to change the state of a Workitem. It corresponds to the UPS DIMSE N-ACTION operation "Change UPS State". State changes are used to claim ownership, complete, or cancel a Workitem.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Function ChangeState( _
   ByVal State As UPSState, _
   ByVal TransactionUID As String, _
   Optional ByVal Encoding As DicomDataEncoding _
) As HttpResponseMessage

'Usage
 
Dim instance As WorkItemWebClient
Dim State As UPSState
Dim TransactionUID As String
Dim Encoding As DicomDataEncoding
Dim value As HttpResponseMessage
 
value = instance.ChangeState(State, TransactionUID, Encoding)

public HttpResponseMessage ChangeState( 
   UPSState State,
   string TransactionUID,
   DicomDataEncoding Encoding
)

public:
HttpResponseMessage^ ChangeState( 
   UPSState State,
   String^ TransactionUID,
   DicomDataEncoding Encoding
)

Parameters

State: New State for the Workitem, cannot set to SCHEDULED
TransactionUID: The Transaction UID used to lock the target Workitem
Encoding: The encoding to use (native/json/xml)

Return Value

HttpResponseMessage

Example

WorkItemWebClient wwc = new WorkItemWebClient(BaseUri);
var resp = wwc.ChangeState(UPSState.INPROGRESS, "1.2.3.4.5.6.7.8.9");
Log($"Change State response: {resp.StatusCode}");

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

WorkItemWebClient Class
WorkItemWebClient Members

Send Feedback