DicomObjects.NET.8.48 Documentation
DicomObjects.DicomWeb.WebClient Namespace / WorkItemWebClient Class / Subscribe Method
The Subscribe Target Resource
deletionlock query parameter in the Subscribe request
The AETitle of Subscriber
The Workitem UID for matching, required if Resource is Workitem
A Workitem Subscription will be created for any existing and future Workitem that matches the attribute/value pairs of the filter.
Example






In This Topic
    Subscribe Method
    In This Topic
    This transaction creates a Subscription to a Worklist or Workitem resource. It corresponds to the UPS DIMSE N-ACTION operation "Subscribe to Receive UPS Event Reports".
    Syntax
    'Declaration
     
    
    Public Function Subscribe( _
       ByVal Resource As SubscribeTargetResource, _
       ByVal DeletionLock As System.Boolean, _
       ByVal AETitle As System.String, _
       ByVal WorkItemUID As System.String, _
       ByVal FilterDataSet As DicomDataSet _
    ) As System.Net.Http.HttpResponseMessage
    'Usage
     
    
    Dim instance As WorkItemWebClient
    Dim Resource As SubscribeTargetResource
    Dim DeletionLock As System.Boolean
    Dim AETitle As System.String
    Dim WorkItemUID As System.String
    Dim FilterDataSet As DicomDataSet
    Dim value As System.Net.Http.HttpResponseMessage
     
    value = instance.Subscribe(Resource, DeletionLock, AETitle, WorkItemUID, FilterDataSet)
    public System.Net.Http.HttpResponseMessage Subscribe( 
       SubscribeTargetResource Resource,
       System.bool DeletionLock,
       System.string AETitle,
       System.string WorkItemUID,
       DicomDataSet FilterDataSet
    )
    public function Subscribe( 
        Resource: SubscribeTargetResource;
        DeletionLock: System.Boolean;
        AETitle: System.String;
        WorkItemUID: System.String;
        FilterDataSet: DicomDataSet
    ): System.Net.Http.HttpResponseMessage; 
    public function Subscribe( 
       Resource : SubscribeTargetResource,
       DeletionLock : System.boolean,
       AETitle : System.String,
       WorkItemUID : System.String,
       FilterDataSet : DicomDataSet
    ) : System.Net.Http.HttpResponseMessage;
    public: System.Net.Http.HttpResponseMessage* Subscribe( 
       SubscribeTargetResource Resource,
       System.bool DeletionLock,
       System.string* AETitle,
       System.string* WorkItemUID,
       DicomDataSet* FilterDataSet
    ) 
    public:
    System.Net.Http.HttpResponseMessage^ Subscribe( 
       SubscribeTargetResource Resource,
       System.bool DeletionLock,
       System.String^ AETitle,
       System.String^ WorkItemUID,
       DicomDataSet^ FilterDataSet
    ) 

    Parameters

    Resource
    The Subscribe Target Resource
    DeletionLock
    deletionlock query parameter in the Subscribe request
    AETitle
    The AETitle of Subscriber
    WorkItemUID
    The Workitem UID for matching, required if Resource is Workitem
    FilterDataSet
    A Workitem Subscription will be created for any existing and future Workitem that matches the attribute/value pairs of the filter.

    Return Value

    A DicomObjects.DicomDataSet object that represents the retreived Workitem (UPS) object
    Example
    WorkItemWebClient wwc = new WorkItemWebClient(BaseUri);
    var ds = wwc.Retrieve("1.2.3.4.5.6.7.8.9");
    Requirements

    Target Platforms: .NET CLR 4.8 or higher

    See Also