IIndexManager Interface

Analytics Core API Documentation
Relativity Analytics Index Manager

Namespace:  Analytics.Conceptual.Service.Interfaces
Assembly:  Analytics.Conceptual.Service.Interfaces (in Analytics.Conceptual.Service.Interfaces.dll) Version: 10.1.2.93
Syntax

public interface IIndexManager : IDisposable

The IIndexManager type exposes the following members.

Methods

  NameDescription
Public methodCancelJobAsync
Cancels the current job for an Analytics index. HTTP Verb: DELETE HTTP Route: ~/workspaces/{workspaceID:int}/indexes/{indexID:int}/job HTTP Success Status Code: 200 OK
Public methodCreateAsync
Creates an analytics index RDO. HTTP Verb: POST HTTP Route: ~/workspaces/{workspaceID:int}/indexes HTTP Success Status Code: 201 Created
Public methodDeleteAsync
Deletes an analytics index. HTTP Verb: DELETE HTTP Route: ~/workspaces/{workspaceID:int}/indexes/{indexID:int} HTTP Success Status Code: 200 OK
Public methodGetStatusAsync
Gets the current status of an analytics index. HTTP Verb: GET HTTP Route: ~/workspaces/{workspaceID:int}/indexes/{indexID:int}/status HTTP Success Status Code: 200 OK
Public methodReadAsync
Reads an analytics index. HTTP Verb: GET HTTP Route: ~/workspaces/{workspaceID:int}/indexes/{indexID:int} HTTP Success Status Code: 200 OK
Public methodSubmitJobAsync
Creates a job for an Analytics index. HTTP Verb: POST HTTP Route: ~/workspaces/{workspaceID:int}/indexes/{indexID:int}/job HTTP Success Status Code: 201 Created
Public methodUpdateAsync
Updates an analytics index. HTTP Verb: PUT HTTP Route: ~/workspaces/{workspaceID:int}/indexes/{indexID:int} HTTP Success Status Code: 200 OK
Top
See Also

Reference