IStructuredAnalyticsManager. CancelAsync Method (Int32, Int32)

Structured Analytics API Documentation
Cancels the analysis of a structured analytics set.

Namespace:  Relativity.StructuredAnalytics.Services.Interfaces.StructuredAnalytics
Assembly:  Relativity.Threads.Services.Interfaces (in Relativity.Threads.Services.Interfaces.dll) Version: 10.0.0.0 (10.0.0.0)
Syntax

Task<OperationResult> CancelAsync(
	int workspaceId,
	int sasArtifactId
)

Parameters

workspaceId
Type: System.Int32
The ID of the workspace for the structured analytics set
sasArtifactId
Type: System.Int32
The ID of the structured analytics set

Return Value

Type: Task< OperationResult>
Result object defining the success state of the call
Remarks

CancelAsync will return to the caller immeditely after requesting cancellation of an analysis. Use this method if you would like to cancel an operation and have no intent on performing an additional operation on this same structured analytics set immediately after cancellation is complete.
See Also

Reference