IStructuredAnalyticsManager. RunAsync Method (Int32, Int32, AnalysisSettings, CancellationToken)

 Structured Analytics API Documentation
Executes an analysis of a structured analytics set, and uses a token to propagate a cancellation request.

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
Copy
Task<OperationResult> RunAsync(
	int workspaceId,
	int sasArtifactId,
	AnalysisSettings settings,
	CancellationToken cancellationToken
)

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
settings
Type: Relativity.StructuredAnalytics.Services.Interfaces.StructuredAnalytics.Models.AnalysisSettings
The settings that define how the analysis will execute
cancellationToken
Type: System.Threading.CancellationToken
Token for cancelling the call to run full analysis

Return Value

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

Reference

IStructuredAnalyticsManager Interface
RunAsync Overload
Relativity.StructuredAnalytics.Services.Interfaces.StructuredAnalytics Namespace