CancelActivity Method

Initiates a synchronous call to cancel eligible activities for analyses in Touchstone and Touchstone Re. You can initiate cancel request for a pending activity directly, thereby, enabling you to bypass cancel restrictions on UI. In addition, the Cancel Activity method allows you to interrupt individual analyses that may take several hours to complete and saves on resources and/or time that you can use for other higher priority activities. Retrieves the status of an activity that you requested to cancel using the CancelActivity() method.

Syntax

Visual Basic (Declaration)
Visual Basic (Usage)
C#

Public Function CancelActivity( _
   ByVal request As CancelActivityRequest _
) As CancelActivityResponse

Dim instance As ActivityManagementServiceClient
Dim request As CancelActivityRequest
Dim value As CancelActivityResponse
 
value = instance.CancelActivity(request)

public CancelActivityResponse CancelActivity( 
   CancelActivityRequest request
)

Parameters

request: Contains a CancelActivityRequest that identifies the Business Unit SID, SQL Instance SID, and Activity SID associated with an activity.

Return Value

A CancelActivityResponse containing a flag to indicate the status of the activity.

Remarks

You can initiate a synchronous call to cancel activities associated with Data Quality analyses, automated portfolio analyses, auto CLF, CLF, and CLA.
The child activities associated in Exposure View or Exposure Summary analyses cannot be canceled using the CancelActivityRequest class.

Example

using AIR.Services.ActivityManagement.Api;
using AIR.Services.Common.Data;
using System;
            
public class SnippetCancelActivityRequest
{
   private static void CancelActivity(int businessUnitSid, int sqlInstanceSid, int activitySid)
   {
       ActivityManagementServiceClient activityClient = new ActivityManagementServiceClient();
       CancelActivityRequest request = new CancelActivityRequest();
       request.BusinessUnitSid = businessUnitSid;
       request.SqlInstanceSid = sqlInstanceSid;
       request.Sid = activitySid;
       CancelActivityResponse response = activityClient.CancelActivity(request);
       if ((response.Status.Code == StatusCode.Success))
       {
           Console.WriteLine("Activity cancellation completed");
       }
   }
}

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

ActivityManagementServiceClient Class
ActivityManagementServiceClient Members