The following information applies to the Relativity release 9.5.196.102. For earlier versions of the Index Manager API, see the Relativity 9.4 developer documentation.
Build analytics indexes with REST
Note: You must install the Analytics application in your Relativity environment to automate workflows with the Analytics Index Manager service. For more information, see Upgrading or installing your Analytics server on the Relativity Documentation site.
This page contains the following sections:
- Guidelines for the Analytics Index Manager service
- Create an analytics index
- Read an analytics index
- Update an analytics index
- Get index status
- Submit an analytics index job
- Cancel an index job
- Delete an analytics index
See these related pages:
Guidelines for the Analytics Index Manager service
Use the following guidelines when working with the Structured Analytics Manager service:
- Execute only valid operations for the state of an Analytics index - Only certain operations are valid for the current state of your index. See the following examples:
- A call to cancel a running index job is only valid when an a job is currently running for the index.
- You cannot build an index that hasn't been populated.
To get a list of valid operations, get the index status. On the returned status object, examine the ConsoleButtons property for a list of valid operations to call. You can also get additional information about the job from the StatusText and AdditionalStatusText properties . If you attempt to execute an invalid operation, you receive validation error.
- Monitor the analysis progress - After submitting an index job, make calls to get status of the job to monitor the progress.
Create an analytics index
To create an analytics index , send a POST request to the following Index Manager service URL:
/Relativity.REST/API/Analytics.Conceptual.Service.Interfaces.IAnalyticsModule/workspaces/{workspace artifact ID}/indexes |
The request payload must include valid JSON representation of the index object with the following properties:
Required
- AnalyticsServer – the analytics server to be used to build the index.
- Name – The friendly name of the index.
- IndexTypeIdentifier – the type of index, Conceptual (LSI-based) or Classification (SVM-based).
- Order – Order in which index appears in dropdowns. Defaults to 0.
- SearchableSet – the saved search to populate the searchable set.
Optional
- ConceptStopWords – the words to suppress from the index. You can add or remove stop words from the list. Separate each word with a hard return. The default values are derived from the [EDDSDBO].[ContentAnalystDefaultNoiseWords] table.
- ContinueIndexStepsToCompletion – automatically complete all necessary step to activate an Analytics Index after starting a step.
- Dimensions - the number of dimensions of the concept space into which documents are mapped when the index is built. More dimensions increase the conceptual values applied to documents and refine the relationships between documents.
- EmailNotificationRecipients – the list of emails recipients to be notified during index population and build.
- EnableEmailHeaderFilter – remove common header fields (such as To, From, and Date) and reply-indicator lines, but it don't remove content from the Subject line. Use this filter to ensure that the headers in the concept space don't overshadow the authored content. Defaults to False.
- OptimizeTrainingSet – select only conceptually relevant documents from the training set saved search. For example, documents that are very large, very small, or have a lot of numbers are automatically excluded from training in order to improve index quality. Defaults to False.
- RemoveDocumentsThatErroredDuringPopulation – remove documents from being populated that have errored in a previous population.
- RemoveEnglishSignaturesAndFooters – remove signatures and footers in English language emails from the text stored in the Analytics index. By default, this is set to Yes for new indexes and No for existing ones. Setting this to Yes enables the email header filter, disables the Go Words and OCR filters, and removes documents greater than 30 MB from the searchable set. Defaults to False.
- RepeatedContentFilters – repeated content filters associated with the index.
- TrainingSet – the saved search to populate the training set.
Note: For both TrainingSet and SearchableSet, the Artifact ID value of the SavedSearchRef object can be set to 0 to use the built-in search for all documents in a workspace, or -1 for default training set/default searchable. Setting the values to 0 can have a negative impact on system performance.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 | { "index" :{ "AnalyticsServer" :{ "ArtifactID" :1018616 }, "ConceptStopWords" : "a able about above according accordingly across actually after afterwards again against ain't all allow allows almost alone along already also although always am among amongst an and another any anybody anyhow anyone anything anyway anyways anywhere apart appear appreciate appropriate apr are aren't around as a's aside ask asking associated at aug available away awfully b back bcc be became because become becomes becoming been before beforehand behind being believe below beside besides best better between beyond both brief but by c came can cannot cant can't cause causes cc cdt certain certainly changes clearly c'mon co com come comes concerning consequently consider considering contain containing contains corresponding could couldn't course c's cst currently d date day dec definitely described despite did didn't different do does doesn't doing done don't down downwards during e each edt edu eg eight either else elsewhere enough entirely especially est et etc even ever every everybody everyone everything everywhere ex exactly example except f far feb few fifth first five followed following follows for former formerly forth four fri from further furthermore g get gets getting given gives go goes going gone good got gotten great greetings h had hadn't happens hardly has hasn't have haven't having he hello help hence her here hereafter hereby herein here's hereupon hers herself he's hi him himself his hither hopefully how howbeit however i i'd ie if ignored i'll i'm immediate in inasmuch inc indeed indicate indicated indicates inner insofar instead into inward is isn't it it'd it'll its it's itself i've j jan jul jun just k keep keeps kept know known knows l last lately later latter latterly least less lest let let's life like liked likely little long look looking looks ltd m made mainly make man many mar may maybe mdt me mean meanwhile men merely might mon more moreover most mostly mr mst much must my myself n name namely nd near nearly necessary need needs neither never nevertheless new next nine no nobody non none noone nor normally not nothing nov novel now nowhere o obviously oct of off often oh ok okay old on once one ones only onto or other others otherwise ought our ours ourselves out outside over overall own p particular particularly pdt people per perhaps placed please plus possible presumably probably provides pst q que quite qv r rather rd re really reasonably regarding regardless regards relatively respectively right s said same sat saw say saying says second secondly see seeing seem seemed seeming seems seen self selves sensible sent sep serious seriously seven several shall she should shouldn't since six so some somebody somehow someone something sometime sometimes somewhat somewhere soon sorry specified specify specifying state still sub subject such sun sup sure t take taken tell tends th than thank thanks thanx that thats that's the their theirs them themselves then thence there thereafter thereby therefore therein theres there's thereupon these they they'd they'll they're they've think third this thorough thoroughly those though three through throughout thru thu thus time to together too took toward towards tried tries truly try trying t's tue twice two u un under unfortunately unless unlikely until unto up upon us use used useful uses using usually uucp v value various very via viz vs w want wants was wasn't way we wed we'd welcome well we'll went were we're weren't we've what whatever what's when whence whenever where whereafter whereas whereby wherein where's whereupon wherever whether which while whither who whoever whole whom who's whose why will willing wish with within without wonder won't work world would wouldn't x y year years yes yet you you'd you'll your you're yours yourself yourselves you've z zero" , "Dimensions" :100, "EmailNotificationRecipients" :[ ], "Name" : "Jane Doe Case Analytics Index" , "OptimizeTrainingSet" : true , "Order" :1, "RemoveEnglishSignaturesAndFooters" : true , "EnableEmailHeaderFilter" : true , "RepeatedContentFilters" :[ ], "SearchableSet" :{ "ArtifactID" :1038051 }, "TrainingSet" :{ "ArtifactID" :1038051 }, "Active" : true , "IndexTypeIdentifier" : "Conceptual" } } |
The response returns HTTP status code 201 for success and the Artifact ID of the created index object.
Errors:
- PermissionException – An exception representing the case where the user does not have permission to perform an attempted action, for example access a workspace, a searchable or training set, or perform index operations.
- ValidationException – An exception representing the case where an invalid or malformed request is made, for example, an invalid value is specified for an index property.
Read an analytics index
To read an analytics index, send a GET request to the following Index Manager service URL.
/Relativity.REST/API/Analytics.Conceptual.Service.Interfaces.IAnalyticsModule/workspaces/{workspace artifact ID}/indexes/{index artifact ID} |
The response returns an index object with the following properties:
- ArtifactID – The Artifact ID of the Artifact.
- Guids – The GUIDs .
- AnalyticsServer – the analytics server to be used to build the index. The value is a ResourceServerRef object.
- ConceptStopWords – the words to suppress from the index. You can add or remove stop words from the list. Separate each word with a hard return. The default values are derived from the [EDDSDBO].[ContentAnalystDefaultNoiseWords] table.
- Dimensions - the number of dimensions of the concept space into which documents are mapped when the index is built. More dimensions increase the conceptual values applied to documents and refine the relationships between documents.
- EmailNotificationRecipients – the list of emails recipients to be notified during index population and build.
- Name – The friendly name of the index.
- IndexTypeIdentifier – the type of index, Conceptual (LSI-based) or Classification (SVM-based).
- OptimizeTrainingSet – select only conceptually relevant documents from the training set saved search. For example, documents that are very large, very small, or have a lot of numbers are automatically excluded from training in order to improve index quality. Defaults to false.
- Order – Order in which index appears in dropdowns. Defaults to 0.
- RemoveEnglishSignaturesAndFooters – remove signatures and footers in English language emails from the text stored in the Analytics index. By default, this is set to Yes for new indexes and No for existing ones. Setting this to Yes enables the email header filter, disables the Go Words and OCR filters, and removes documents greater than 30 MB from the searchable set. Defaults to false.
- EnableEmailHeaderFilter – remove common header fields (such as To, From, and Date) and reply-indicator lines, but it don't remove content from the Subject line. Use this filter to ensure that the headers in the concept space don't overshadow the authored content. Defaults to false.
- RepeatedContentFilters – repeated content filters associated with the index.
- SearchableSet – the saved search to populate the searchable set. The value is a SavedSearchRef object.
- TrainingSet – the saved search to populate the training set. The value is a SavedSearchRef object.
- Active – Indicates whether or not the search provider associated with the index has been activated.
- RemoveDocumentsThatErroredDuringPopulation – remove documents from being populated that have errored in a previous population.
- ContinueIndexStepsToCompletion – automatically complete all necessary step to activate an Analytics Index after starting a step.
- LastErrorMessage – the last error message to occur on the index.
- IndexLastUsedOn – the time this index was last used
This JSON sample represents an index object:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 | { "ArtifactID" : 1118331, "Guids" : [], "AnalyticsServer" : { "ArtifactID" : 1018616 }, "ConceptStopWords" : "a able about above according accordingly across actually after afterwards again against ain't all allow allows almost alone along already also although always am among amongst an and another any anybody anyhow anyone anything anyway anyways anywhere apart appear appreciate appropriate apr are aren't around as a's aside ask asking associated at aug available away awfully b back bcc be became because become becomes becoming been before beforehand behind being believe below beside besides best better between beyond both brief but by c came can cannot cant can't cause causes cc cdt certain certainly changes clearly c'mon co com come comes concerning consequently consider considering contain containing contains corresponding could couldn't course c's cst currently d date day dec definitely described despite did didn't different do does doesn't doing done don't down downwards during e each edt edu eg eight either else elsewhere enough entirely especially est et etc even ever every everybody everyone everything everywhere ex exactly example except f far feb few fifth first five followed following follows for former formerly forth four fri from further furthermore g get gets getting given gives go goes going gone good got gotten great greetings h had hadn't happens hardly has hasn't have haven't having he hello help hence her here hereafter hereby herein here's hereupon hers herself he's hi him himself his hither hopefully how howbeit however i i'd ie if ignored i'll i'm immediate in inasmuch inc indeed indicate indicated indicates inner insofar instead into inward is isn't it it'd it'll its it's itself i've j jan jul jun just k keep keeps kept know known knows l last lately later latter latterly least less lest let let's life like liked likely little long look looking looks ltd m made mainly make man many mar may maybe mdt me mean meanwhile men merely might mon more moreover most mostly mr mst much must my myself n name namely nd near nearly necessary need needs neither never nevertheless new next nine no nobody non none noone nor normally not nothing nov novel now nowhere o obviously oct of off often oh ok okay old on once one ones only onto or other others otherwise ought our ours ourselves out outside over overall own p particular particularly pdt people per perhaps placed please plus possible presumably probably provides pst q que quite qv r rather rd re really reasonably regarding regardless regards relatively respectively right s said same sat saw say saying says second secondly see seeing seem seemed seeming seems seen self selves sensible sent sep serious seriously seven several shall she should shouldn't since six so some somebody somehow someone something sometime sometimes somewhat somewhere soon sorry specified specify specifying state still sub subject such sun sup sure t take taken tell tends th than thank thanks thanx that thats that's the their theirs them themselves then thence there thereafter thereby therefore therein theres there's thereupon these they they'd they'll they're they've think third this thorough thoroughly those though three through throughout thru thu thus time to together too took toward towards tried tries truly try trying t's tue twice two u un under unfortunately unless unlikely until unto up upon us use used useful uses using usually uucp v value various very via viz vs w want wants was wasn't way we wed we'd welcome well we'll went were we're weren't we've what whatever what's when whence whenever where whereafter whereas whereby wherein where's whereupon wherever whether which while whither who whoever whole whom who's whose why will willing wish with within without wonder won't work world would wouldn't x y year years yes yet you you'd you'll your you're yours yourself yourselves you've z zero" , "Dimensions" : 100, "EmailNotificationRecipients" : [], "Name" : "John Doe Case Analytics Index" , "OptimizeTrainingSet" : true , "Order" : 1, "RemoveEnglishSignaturesAndFooters" : true , "EnableEmailHeaderFilter" : true , "RepeatedContentFilters" : [], "SearchableSet" : { "ArtifactID" : 1038051 }, "TrainingSet" : { "ArtifactID" : 1038051 }, "Active" : true , "IndexTypeIdentifier" : "Conceptual" , "RemoveDocumentsThatErroredDuringPopulation" : true , "ContinueIndexStepsToCompletion" : true , "LastErrorMessage" : "" , "IndexLastUsedOn" : "2017-05-09T19:22:17" } |
Errors:
- NotFoundException – An exception representing the case where an item is not available or does not exist, for example, when reading or deleting an Analytics index.
- PermissionException – An exception representing the case where the user does not have permission to perform an attempted action, for example access a workspace, a searchable or training set, or perform index operations.
Update an analytics index
To update an Analytics index, send a PUT request to the following Index Manager service URL.
/Relativity.REST/API/Analytics.Conceptual.Service.Interfaces.IAnalyticsModule/workspaces/{workspace artifact ID}/indexes/{index artifact ID} |
The request payload must include valid JSON representation of the index object with the following properties. You can update the following properties of an Analytics index object:
- AnalyticsServer
- ConceptStopWords
- ContinueIndexStepsToCompletion
- Dimensions
- EmailNotificationRecipients
- EnableEmailHeaderFilter
- Name
- OptimizeTrainingSet
- Order
- RemoveDocumentsThatErroredDuringPopulation
- RemoveEnglishSignaturesAndFooters
- RepeatedContentFilters
- TrainingSet
- SearchableSet
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | { "index" : { "AnalyticsServer" : { "ArtifactID" : 1018616 }, "ConceptStopWords" : "a able about above according accordingly across actually after afterwards again against ain't all allow allows almost alone along already also although always am among amongst an and another any anybody anyhow anyone anything anyway anyways anywhere apart appear appreciate appropriate apr are aren't around as a's aside ask asking associated at aug available away awfully b back bcc be became because become becomes becoming been before beforehand behind being believe below beside besides best better between beyond both brief but by c came can cannot cant can't cause causes cc cdt certain certainly changes clearly c'mon co com come comes concerning consequently consider considering contain containing contains corresponding could couldn't course c's cst currently d date day dec definitely described despite did didn't different do does doesn't doing done don't down downwards during e each edt edu eg eight either else elsewhere enough entirely especially est et etc even ever every everybody everyone everything everywhere ex exactly example except f far feb few fifth first five followed following follows for former formerly forth four fri from further furthermore g get gets getting given gives go goes going gone good got gotten great greetings h had hadn't happens hardly has hasn't have haven't having he hello help hence her here hereafter hereby herein here's hereupon hers herself he's hi him himself his hither hopefully how howbeit however i i'd ie if ignored i'll i'm immediate in inasmuch inc indeed indicate indicated indicates inner insofar instead into inward is isn't it it'd it'll its it's itself i've j jan jul jun just k keep keeps kept know known knows l last lately later latter latterly least less lest let let's life like liked likely little long look looking looks ltd m made mainly make man many mar may maybe mdt me mean meanwhile men merely might mon more moreover most mostly mr mst much must my myself n name namely nd near nearly necessary need needs neither never nevertheless new next nine no nobody non none noone nor normally not nothing nov novel now nowhere o obviously oct of off often oh ok okay old on once one ones only onto or other others otherwise ought our ours ourselves out outside over overall own p particular particularly pdt people per perhaps placed please plus possible presumably probably provides pst q que quite qv r rather rd re really reasonably regarding regardless regards relatively respectively right s said same sat saw say saying says second secondly see seeing seem seemed seeming seems seen self selves sensible sent sep serious seriously seven several shall she should shouldn't since six so some somebody somehow someone something sometime sometimes somewhat somewhere soon sorry specified specify specifying state still sub subject such sun sup sure t take taken tell tends th than thank thanks thanx that thats that's the their theirs them themselves then thence there thereafter thereby therefore therein theres there's thereupon these they they'd they'll they're they've think third this thorough thoroughly those though three through throughout thru thu thus time to together too took toward towards tried tries truly try trying t's tue twice two u un under unfortunately unless unlikely until unto up upon us use used useful uses using usually uucp v value various very via viz vs w want wants was wasn't way we wed we'd welcome well we'll went were we're weren't we've what whatever what's when whence whenever where whereafter whereas whereby wherein where's whereupon wherever whether which while whither who whoever whole whom who's whose why will willing wish with within without wonder won't work world would wouldn't x y year years yes yet you you'd you'll your you're yours yourself yourselves you've z zero" , "Dimensions" : 120, "EmailNotificationRecipients" : [], "Name" : "Jane Doe Case Analytics Index" , "OptimizeTrainingSet" : true , "Order" : 2, "RemoveEnglishSignaturesAndFooters" : true , "EnableEmailHeaderFilter" : true , "RepeatedContentFilters" : [], "SearchableSet" : { "ArtifactID" : 1038051 }, "TrainingSet" : { "ArtifactID" : 1038051 }, "Active" : false } } |
The response returns HTTP status code 201 for success.
Errors:
- PermissionException – An exception representing the case where the user does not have permission to perform an attempted action, for example access a workspace, a searchable or training set, or perform index operations.
- ValidationException – An exception representing the case where an invalid or malformed request is made, for example, an invalid value is specified for an index property.
Get index status
To get an index status, send a GET request to the following Index Manager service URL.
/Relativity.REST/API/Analytics.Conceptual.Service.Interfaces.IAnalyticsModule/workspaces/{workspaceArtifactID}/indexes/{indexArtifactID}/status |
The response returns an index status object with the following properties:
- Active – Indicates if the index is active and able to be queried.
- ConsoleButtons – list of console buttons and links with their current states. The states can be used to determine what job steps can be run for the index. For more information, see AnalyticsIndexJobType enum in Analytics Index Manager API.
- CurrentStep – the current job step, if a multi-step job is in progress.
- DocLevelErrorsExist – indicates if there are documents in error in the training set.
- LastErrorMessage – the last error that occurred on this index
- OverallTimeElapsed – the total time of the current job, if there is one.
- PercentageComplete – the completed percentage of the current job step, if it has one.
- PercentDenominator – the denominator value to generate the percentage of the current job step, if there is one.
- PercentNumerator – the numerator value to generate the percentage of the current job step, if there is one.
- SearchableSetCount – the count of items in the searchable set if the index is new or active in its final state.
- SecondaryPercentageComplete – the completed percentage of a stage of a job step, if it has one.
- SecondaryStatusText – additional status text.
- StatusText – the main status text of the index.
- StepTimeElapsed – the elapsed time of the current job step, if there is one.
- TotalSteps – the total number of job steps, if a multi step job is in progress.
- TrainingSetCount – the count of items in the training set if the index is new or active in its final state.
This JSON sample represents an index status object:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 | { "Active" : true , "ConsoleButtons" : [ { "DisplayText" : "Populate Index: Full" , "Identifier" : "populateIndexFull" , "Class" : "consoleButtonEnabled" , "HelpText" : "" , "Enabled" : true }, { "DisplayText" : "Cancel Full Population" , "Identifier" : "cancelPopulateIndexFull" , "Class" : "consoleButtonHide" , "HelpText" : "Cannot cancel full population if index is not populating." , "Enabled" : false }, { "DisplayText" : "Populate Index: Incremental" , "Identifier" : "populateIndexIncremental" , "Class" : "consoleButtonEnabled" , "HelpText" : "" , "Enabled" : true }, { "DisplayText" : "Cancel Incremental Population" , "Identifier" : "cancelPopulateIndexIncremental" , "Class" : "consoleButtonHide" , "HelpText" : "Cannot cancel incremental population if index is not populating." , "Enabled" : false }, { "DisplayText" : "Retry Errors" , "Identifier" : "retryErrors" , "Class" : "consoleButtonDisabled" , "HelpText" : "There are no errors to retry." , "Enabled" : false }, { "DisplayText" : "Cancel Retry Errors" , "Identifier" : "cancelRetryErrors" , "Class" : "consoleButtonHide" , "HelpText" : "Cannot cancel retry errors if index is not populating." , "Enabled" : false }, { "DisplayText" : "Remove Documents in Error" , "Identifier" : "removeDocumentsInError" , "Class" : "consoleButtonDisabled" , "HelpText" : "There are no errored documents to remove." , "Enabled" : false }, { "DisplayText" : "Build Index" , "Identifier" : "buildIndex" , "Class" : "consoleButtonDisabled" , "HelpText" : "Index cannot be built while the index is active." , "Enabled" : false }, { "DisplayText" : "Activate" , "Identifier" : "activate" , "Class" : "consoleButtonHide" , "HelpText" : "Index cannot be activated unless it is not active." , "Enabled" : false }, { "DisplayText" : "Deactivate" , "Identifier" : "deactivate" , "Class" : "consoleButtonEnabled" , "HelpText" : "" , "Enabled" : true }, { "DisplayText" : "Show Document Errors" , "Identifier" : "showDocumentErrors" , "Class" : "consoleLinkDisabled" , "HelpText" : "There are no errors to show." , "Enabled" : false }, { "DisplayText" : "Show Population Statistics" , "Identifier" : "showPopulationStatistics" , "Class" : "consoleLinkEnabled" , "HelpText" : "" , "Enabled" : true }, { "DisplayText" : "Show Index Statistics" , "Identifier" : "showIndexStatistics" , "Class" : "consoleLinkEnabled" , "HelpText" : "" , "Enabled" : true } ], "DocLevelErrorsExist" : false , "SearchableSetCount" : 73966, "StatusText" : "Active" , "TrainingSetCount" : 63403 } |
Errors:
- NotFoundException – An exception representing the case where an item is not available or does not exist, for example, when reading or deleting an Analytics index.
- PermissionException – An exception representing the case where the user does not have permission to perform an attempted action, for example access a workspace, a searchable or training set, or perform index operations.
Submit an analytics index job
To submit an analytics index job, send a POST request to the following Index Manager service URL.
1 | /Relativity.REST/API/Analytics.Conceptual.Service.Interfaces.IAnalyticsModule/workspaces/{workspaceArtifactID}/indexes/{indexArtifactID}/job |
The request payload must include valid JSON representations of the index job type. Valid values include:
- FullPopulation – run a full index population.
- IncrementalPopulation – run an incremental population.
- RetryErrors – retry errors that occurred during population.
- RemoveDocumentsInError – remove documents in error.
- BuildIndex – run a full index build.
- Activate – activate the index for querying.
- Deactivate – disable queries on the index.
1 2 3 | { "jobType" : "FullPopulation" } |
The response does not contain any data. Success or failure are indicated by the HTTP status code.
Errors:
- NotFoundException – An exception representing the case where an item is not available or does not exist, for example, when reading or deleting an Analytics index.
- PermissionException – An exception representing the case where the user does not have permission to perform an attempted action, for example access a workspace, a searchable or training set, or perform index operations.
- ValidationException – An exception representing the case where an invalid or malformed request is made, for example, an invalid value is specified for an index property.
Cancel an index job
To cancel a running index job, issue a DELETE request to the following Index Manager service URL.
/Relativity.REST/API/Analytics.Conceptual.Service.Interfaces.IAnalyticsModule/workspaces/{workspaceArtifactID}/indexes/{indexArtifactID}/job |
The response does not contain any data. Success or failure are indicated by the HTTP status code.
Errors:
- DeletionDependencyException – An exception representing the case where an object deletion fails because it is referenced by dependencies, for example when attempting to delete an Analytics index that is being used.
- NotFoundException – An exception representing the case where an item is not available or does not exist, for example, when reading or deleting an Analytics index.
- PermissionException – An exception representing the case where the user does not have permission to perform an attempted action, for example access a workspace, a searchable or training set, or perform index operations.
Delete an analytics index
To delete an index, issue a DELETE request to the following Index Manager service URL.
/Relativity.REST/API/Analytics.Conceptual.Service.Interfaces.IAnalyticsModule/workspaces/{workspaceArtifactID}/indexes/{indexArtifactID} |
The response does not contain any data. Success or failure are indicated by the HTTP status code.
Errors:
- DeletionDependencyException – An exception representing the case where an object deletion fails because it is referenced by dependencies, for example when attempting to delete an Analytics index that is being used.
- NotFoundException – An exception representing the case where an item is not available or does not exist, for example, when reading or deleting an Analytics index.
- PermissionException – An exception representing the case where the user does not have permission to perform an attempted action, for example access a workspace, a searchable or training set, or perform index operations.