Relativity's dtSearch engine provides advanced search functionality such as proximity, stemming, fuzzy searches, and Boolean operators. For more information, see dtSearch on the Relativity
In order to perform a dtSearch search, you must build and activate a dtSearch index. The dtSearch Index Manager API exposes these operations, and others, letting you programmatically manage dtSearch Indexes. A sample use case for the dtSearch Manager API is creating a custom application to programmatically run through the stages of index build rather than manually performing these tasks through the Relativity UI.
You can also use the dtSearch Manager API services through the .NET interfaces. These interfaces support the same functionality as available through REST. For more information, see dtSearch Manager API.
This page contains the following information:
To begin developing with the dtSearch Manager services, complete the following prerequisites:
The dtSearch Manager API supports create, read, update, and delete operations on dtSearch indexes.
To create a new dtSearch, send a POST request to the following URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/{{workspaceID}}/dtsearch-indexes
Set the {{workspaceID}} variable to the Artifact ID of the workspace where you want to add a new dtSearch. See the following sample URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/1039620/dtsearch-indexes
The request contains the following fields. For more information, about the dtSearch index fields, see dtSearch on the Relativity documentation site.
{ "dtSearchIndexRequest":{ "Name":"dtsearchIndex", "Order":10, "SearchSearchID":1129095, "RecognizeDates":false, "SkipNumericValues":false, "AccentSensitive":false, "IndexShareCodeArtifactID":1016154, "EmailAddress":"", "NoiseWords":"a\r\nabout\r\nafter\r\nall\r\nalso\r\nan\r\nand\r\nanother\r\nany\r\nare\r\nas\r\nat\r\nbe\r\nbecause\r\nbeen\r\nbefore\r\nbeing\r\nbetween\r\nboth\r\nbut\r\nby\r\ncame\r\ncan\r\ncome\r\ncould\r\ndid\r\ndo\r\neach\r\neven\r\nfor\r\nfrom\r\nfurther\r\nfurthermore\r\nget\r\ngot\r\nhad\r\nhas\r\nhave\r\nhe\r\nher\r\nhere\r\nhi\r\nhim\r\nhimself\r\nhis\r\nhow\r\nhowever\r\ni\r\nif\r\nin\r\nindeed\r\ninto\r\nis\r\nit\r\nits\r\njust\r\nlike\r\nmade\r\nmany\r\nme\r\nmight\r\nmore\r\nmoreover\r\nmost\r\nmuch\r\nmust\r\nmy\r\nnever\r\nnot\r\nnow\r\nof\r\non\r\nonly\r\nor\r\nother\r\nour\r\nout\r\nover\r\nsaid\r\nsame\r\nsee\r\nshe\r\nshould\r\nsince\r\nsome\r\nstill\r\nsuch\r\ntake\r\nthan\r\nthat\r\nthe\r\ntheir\r\nthem\r\nthen\r\nthere\r\ntherefore\r\nthese\r\nthey\r\nthis\r\nthose\r\nthrough\r\nthus\r\nto\r\ntoo\r\nunder\r\nup\r\nvery\r\nwas\r\nway\r\nwe\r\nwell\r\nwere\r\nwhat\r\nwhen\r\nwhere\r\nwhich\r\nwhile\r\nwho\r\nwill\r\nwith\r\nwould\r\nyou\r\nyour\r\n", "AlphabetText":"dtSearch Alphabet File\n\n[Letters] // Original letter, lower case, upper case, unaccented\n 0 0 0 0\n 1 1 1 1\n 2 2 2 2\n 3 3 3 3\n 4 4 4 4\n 5 5 5 5\n 6 6 6 6\n 7 7 7 7\n 8 8 8 8\n 9 9 9 9\n A a A A\n B b B B\n C c C C\n D d D D\n E e E E\n F f F F\n G g G G\n H h H H\n I i I I\n J j J J\n K k K K\n L l L L\n M m M M\n N n N N\n O o O O\n P p P P\n Q q Q Q\n R r R R\n S s S S\n T t T T\n U u U U\n V v V V\n W w W W\n X x X X\n Y y Y Y\n Z z Z Z\n _ _ _ _\n a a A a\n b b B b\n c c C c\n d d D d\n e e E e\n f f F f\n g g G g\n h h H h\n i i I i\n j j J j\n k k K k\n l l L l\n m m M m\n n n N n\n o o O o\n p p P p\n q q Q q\n r r R r\n s s S s\n t t T t\n u u U u\n v v V v\n w w W w\n x x X x\n y y Y y\n z z Z z\n\n[Hyphens]\n -\n\n[Spaces]\n \\09\\0a\\0c\\0d !@\"#$&'()*+,./:;<=>?[\\5c]^`{|}~\n\n[Ignore]\n \u0001\u0002\u0003\u0004\u0005\u0006\u0007\\08\u000b\u000e\u000f\u0010\u0011\u0012\u0013\u0014\u0015\u0016\u0017\u0018\u0019\u001a\u001b\u001c\u001d\u001e\u001f%\n\n[End]\nCJKRanges = 2e80-ac00 ac00-d7af f900-faff fe30-fe4f \n", "SubIndexSize":250000, "FragmentationThreshold":9, "Priority":1, "DirtySettings":"<dtSearchDirtySetting><Upgraded>False</Upgraded><AccentSensitiveChanged>False</AccentSensitiveChanged><AlphabetChanged>False</AlphabetChanged><AutoRecognizeChanged>False</AutoRecognizeChanged><NoiseWordsChanged>False</NoiseWordsChanged></dtSearchDirtySetting>" } }
When the request is successful, the response contains the Artifact ID of the new dtSearch index. It also returns the status code of 200.
You can retrieve the metadata for a dtSearch index. Send a GET request to the following URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/{{workspaceID}}/dtsearch-indexes/{{RelativitySearchProviderID}}
Set the {{workspaceID}} variable to the Artifact ID of the workspace containing the dtSearch. Set the {{RelativitySearchProviderID}} variable to the Artifact ID of the dtSearch. See the following sample URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/1017652/dtsearch-indexes/1039620
The response contains the following fields. It also returns the status code of 200.
{ "ID": 2, "Name": "dtsearch-test", "SearchableSearchID": 1038051, "RelativitySearchProviderID": 1039620, "RecognizeDates": false, "SkipNumericValues": false, "AccentSensitive": false, "IndexShareCodeArtifactID": 1016154, "EmailAddress": "", "NoiseWords": "a\r\nabout\r\nafter\r\nall\r\nalso\r\nan\r\nand\r\nanother\r\nany\r\nare\r\nas\r\nat\r\nbe\r\nbecause\r\nbeen\r\nbefore\r\nbeing\r\nbetween\r\nboth\r\nbut\r\nby\r\ncame\r\ncan\r\ncome\r\ncould\r\ndid\r\ndo\r\neach\r\neven\r\nfor\r\nfrom\r\nfurther\r\nfurthermore\r\nget\r\ngot\r\nhad\r\nhas\r\nhave\r\nhe\r\nher\r\nhere\r\nhi\r\nhim\r\nhimself\r\nhis\r\nhow\r\nhowever\r\ni\r\nif\r\nin\r\nindeed\r\ninto\r\nis\r\nit\r\nits\r\njust\r\nlike\r\nmade\r\nmany\r\nme\r\nmight\r\nmore\r\nmoreover\r\nmost\r\nmuch\r\nmust\r\nmy\r\nnever\r\nnot\r\nnow\r\nof\r\non\r\nonly\r\nor\r\nother\r\nour\r\nout\r\nover\r\nsaid\r\nsame\r\nsee\r\nshe\r\nshould\r\nsince\r\nsome\r\nstill\r\nsuch\r\ntake\r\nthan\r\nthat\r\nthe\r\ntheir\r\nthem\r\nthen\r\nthere\r\ntherefore\r\nthese\r\nthey\r\nthis\r\nthose\r\nthrough\r\nthus\r\nto\r\ntoo\r\nunder\r\nup\r\nvery\r\nwas\r\nway\r\nwe\r\nwell\r\nwere\r\nwhat\r\nwhen\r\nwhere\r\nwhich\r\nwhile\r\nwho\r\nwill\r\nwith\r\nwould\r\nyou\r\nyour\r\n", "AlphabetText":"dtSearch Alphabet File\n\n[Letters] // Original letter, lower case, upper case, unaccented\n 0 0 0 0\n 1 1 1 1\n 2 2 2 2\n 3 3 3 3\n 4 4 4 4\n 5 5 5 5\n 6 6 6 6\n 7 7 7 7\n 8 8 8 8\n 9 9 9 9\n A a A A\n B b B B\n C c C C\n D d D D\n E e E E\n F f F F\n G g G G\n H h H H\n I i I I\n J j J J\n K k K K\n L l L L\n M m M M\n N n N N\n O o O O\n P p P P\n Q q Q Q\n R r R R\n S s S S\n T t T T\n U u U U\n V v V V\n W w W W\n X x X X\n Y y Y Y\n Z z Z Z\n _ _ _ _\n a a A a\n b b B b\n c c C c\n d d D d\n e e E e\n f f F f\n g g G g\n h h H h\n i i I i\n j j J j\n k k K k\n l l L l\n m m M m\n n n N n\n o o O o\n p p P p\n q q Q q\n r r R r\n s s S s\n t t T t\n u u U u\n v v V v\n w w W w\n x x X x\n y y Y y\n z z Z z\n\n[Hyphens]\n -\n\n[Spaces]\n \\09\\0a\\0c\\0d !@\"#$&'()*+,./:;<=>?[\\5c]^`{|}~\n\n[Ignore]\n \\08\u000b%\n\n[End]\nCJKRanges = 0e00-0e4e 3040-30ff 4e00-9fff \n", "LastBuildError": "", "Status": "No documents indexed", "SubIndexSize": 250000, "DirtySettings": "", "LastBuildStartTime": "2020-07-06T20:30:56.623", "LastBuildEndTime": "2020-07-06T20:31:15.847", "LastIndexStartTime": "2020-07-06T20:31:07.783", "FragmentationThreshold": 9 }
You can update the settings on a dtSearch index such as its name, order, and other fields. To update a dtSearch index, send a PUT request to the following URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/{{workspaceID}}/dtsearch-indexes/{{RelativitySearchProviderID}}
Set the {{workspaceID}} variable to the Artifact ID of the workspace containing the dtSearch. Set the {{RelativitySearchProviderID}} variable to the Artifact ID of the dtSearch. See the following sample URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/1017652/dtsearch-indexes/1039620
{ "ID": 2, "Name": "IndexName-2", "SearchableSearchID": 1038051, "RelativitySearchProviderID": 1039620, "RecognizeDates": false, "SkipNumericValues": false, "AccentSensitive": false, "IndexShareCodeArtifactID": 1016154, "EmailAddress": "", "NoiseWords": "a\r\nabout\r\nafter\r\nall\r\nalso\r\nan\r\nand\r\nanother\r\nany\r\nare\r\nas\r\nat\r\nbe\r\nbecause\r\nbeen\r\nbefore\r\nbeing\r\nbetween\r\nboth\r\nbut\r\nby\r\ncame\r\ncan\r\ncome\r\ncould\r\ndid\r\ndo\r\neach\r\neven\r\nfor\r\nfrom\r\nfurther\r\nfurthermore\r\nget\r\ngot\r\nhad\r\nhas\r\nhave\r\nhe\r\nher\r\nhere\r\nhi\r\nhim\r\nhimself\r\nhis\r\nhow\r\nhowever\r\ni\r\nif\r\nin\r\nindeed\r\ninto\r\nis\r\nit\r\nits\r\njust\r\nlike\r\nmade\r\nmany\r\nme\r\nmight\r\nmore\r\nmoreover\r\nmost\r\nmuch\r\nmust\r\nmy\r\nnever\r\nnot\r\nnow\r\nof\r\non\r\nonly\r\nor\r\nother\r\nour\r\nout\r\nover\r\nsaid\r\nsame\r\nsee\r\nshe\r\nshould\r\nsince\r\nsome\r\nstill\r\nsuch\r\ntake\r\nthan\r\nthat\r\nthe\r\ntheir\r\nthem\r\nthen\r\nthere\r\ntherefore\r\nthese\r\nthey\r\nthis\r\nthose\r\nthrough\r\nthus\r\nto\r\ntoo\r\nunder\r\nup\r\nvery\r\nwas\r\nway\r\nwe\r\nwell\r\nwere\r\nwhat\r\nwhen\r\nwhere\r\nwhich\r\nwhile\r\nwho\r\nwill\r\nwith\r\nwould\r\nyou\r\nyour\r\n", "AlphabetText":"dtSearch Alphabet File\n\n[Letters] // Original letter, lower case, upper case, unaccented\n 0 0 0 0\n 1 1 1 1\n 2 2 2 2\n 3 3 3 3\n 4 4 4 4\n 5 5 5 5\n 6 6 6 6\n 7 7 7 7\n 8 8 8 8\n 9 9 9 9\n A a A A\n B b B B\n C c C C\n D d D D\n E e E E\n F f F F\n G g G G\n H h H H\n I i I I\n J j J J\n K k K K\n L l L L\n M m M M\n N n N N\n O o O O\n P p P P\n Q q Q Q\n R r R R\n S s S S\n T t T T\n U u U U\n V v V V\n W w W W\n X x X X\n Y y Y Y\n Z z Z Z\n _ _ _ _\n a a A a\n b b B b\n c c C c\n d d D d\n e e E e\n f f F f\n g g G g\n h h H h\n i i I i\n j j J j\n k k K k\n l l L l\n m m M m\n n n N n\n o o O o\n p p P p\n q q Q q\n r r R r\n s s S s\n t t T t\n u u U u\n v v V v\n w w W w\n x x X x\n y y Y y\n z z Z z\n\n[Hyphens]\n -\n\n[Spaces]\n \\09\\0a\\0c\\0d !@\"#$&'()*+,./:;<=>?[\\5c]^`{|}~\n\n[Ignore]\n \\08\u000b%\n\n[End]\nCJKRanges = 0e00-0e4e 3040-30ff 4e00-9fff \n", "LastBuildError": "", "Status": "No documents indexed", "SubIndexSize": 250000, "DirtySettings": "", "LastBuildStartTime": "2020-07-06T20:30:56.623", "LastBuildEndTime": "2020-07-06T20:31:15.847", "LastIndexStartTime": "2020-07-06T20:31:07.783", "FragmentationThreshold": 9 }
When the request is successful, it returns the status code of 200.
To delete a dtSearch index, send a DELETE request to the following URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/{{workspaceID}}/dtsearch-indexes/{{RelativitySearchProviderID}}/delete-index
Set the {{workspaceID}} variable to the Artifact ID of the workspace containing the dtSearch. Set the {{RelativitySearchProviderID}} variable to the Artifact ID of the dtSearch. See the following sample URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/1017652/dtsearch-indexes/1039620/delete-index
When the request is successful, it returns the status code of 200.
The dtSearch Manager API supports programmatically managing index builds, activation, and other operations performed in Relativity on the dtSearch index console. For more information, see dtSearch on the Relativity
You must run a full build after initially creating a dtSearch index. To run a full build of a dtSearch index, send a POST request to the following URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/{{workspaceID}}/dtsearch-indexes/{{RelativitySearchProviderID}}/full-build-index
Set the {{workspaceID}} variable to the Artifact ID of the workspace containing the dtSearch. Set the {{RelativitySearchProviderID}} variable to the Artifact ID of the dtSearch. See the following sample URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/1017652/dtsearch-indexes/1039620/full-build-index
The body of the request contains the following:
{"isActive":true}
When the request is successful, it returns the status code of 200.
You can run an incremental build after adding or removing documents from your search. To run an incremental build of a dtSearch index, send a POST request to the following URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/{{workspaceID}}/dtsearch-indexes/{{RelativitySearchProviderID}}/incremental-build-index
Set the {{workspaceID}} variable to the Artifact ID of the workspace containing the dtSearch. Set the {{RelativitySearchProviderID}} variable to the Artifact ID of the dtSearch. See the following sample URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/1039620/dtsearch-indexes/1130118/incremental-build-index
The body of the request contains the following:
{"isActive":true}
When the request is successful, it returns the status code of 200.
You can run the following to first initiate an incremental dtSearch index build operation, if possible, or else run a full dtSearch index build operation. Send a POST request to the following URL:
<host>/Relativity.Rest/API/Relativity.Compute.DtSearchIndexes/workspace/{{workspaceID}}/dtSearchIndexes/{{RelativitySearchProviderID}/buildIndex
Set the {{workspaceID}} variable to the Artifact ID of the workspace containing the dtSearch. Set the {{RelativitySearchProviderID}} variable to the Artifact ID of the dtSearch. See the following sample URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/1039620/dtsearch-indexes/1130118/build-index
The body of the request contains the following:
{"isActive":true}
When the request is successful, it returns the status code of 200.
To cancel an index build, send a POST request to the following URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/{{workspaceID}}/dtsearch-indexes/{{RelativitySearchProviderID}}/cancel-build
Set the {{workspaceID}} variable to the Artifact ID of the workspace containing the dtSearch. Set the {{RelativitySearchProviderID}} variable to the Artifact ID of the dtSearch. See the following sample URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/1039620/dtsearch-indexes/1130118/cancel-build
When the request is successful, it returns the status code of 200.
To activate a dtSearch index for searching, send a POST request to the following URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/{{workspaceID}}/dtsearch-indexes/{{RelativitySearchProviderID}}/activate-index
Set the {{workspaceID}} variable to the Artifact ID of the workspace containing the dtSearch. Set the {{RelativitySearchProviderID}} variable to the Artifact ID of the dtSearch. See the following sample URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/1039620/dtsearch-indexes/1130118/activate-index
When the request is successful, it returns the status code of 200.
You can compress a dtSearch index returning all sub-indexes with a fragmentation level greater than zero to a fragmentation level of zero. To compress an index, send a POST request to the following URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/{{workspaceID}}/dtsearch-indexes/{{RelativitySearchProviderID}}/compress-index
Set the {{workspaceID}} variable to the Artifact ID of the workspace containing the dtSearch. Set the {{RelativitySearchProviderID}} variable to the Artifact ID of the dtSearch. See the following sample URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/1039620/dtsearch-indexes/1130118/compress-index
The body of the request contains the following:
{"isActive":true}
When the request is successful, it returns the status code of 200.
To deactivate an index, send a POST request to the following URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/{{workspaceID}}/dtsearch-indexes/{{RelativitySearchProviderID}}/deactivate-index
Set the {{workspaceID}} variable to the Artifact ID of the workspace containing the dtSearch. Set the {{RelativitySearchProviderID}} variable to the Artifact ID of the dtSearch. See the following sample URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/1039620/dtsearch-indexes/1130118/deactivate-index
When the request is successful, it returns the status code of 200.
You can swap your index with a replacement index in order to use its resources while your index builds or is inactive or disabled for any reason. To swap indexes, send a POST request to the following URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/{{workspaceID}}/dtsearch-indexes/swap-index
Set the {{workspaceID}} variable to the Artifact ID of the workspace containing the dtSearch. See the following sample URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/1039620/dtsearch-indexes/swap-index
The body of the request contains the following:
{ "oldSearchProviderID":1130118, "newSearchProviderID":1128030 }
When the request is successful, it returns the status code of 200.
To retry errors that occurred during the index build, send a POST request to the following URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/{{workspaceID}}/dtsearch-indexes/{{RelativitySearchProviderID}}/retry-errors
Set the {{workspaceID}} variable to the Artifact ID of the workspace containing the dtSearch. Set the {{RelativitySearchProviderID}} variable to the Artifact ID of the dtSearch. See the following sample URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/1039620/dtsearch-indexes/1130118/retry-errors
When the request is successful, it returns the status code of 200.
To get the progress on an index build, send a GET request to the following URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/{{workspaceID}}/dtsearch-indexes/{{RelativitySearchProviderID}}/index-job-progress
Set the {{workspaceID}} variable to the Artifact ID of the workspace containing the dtSearch. Set the {{RelativitySearchProviderID}} variable to the Artifact ID of the dtSearch. See the following sample URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/1039620/dtsearch-indexes/1130117/index-job-progress
The response contains the following fields:
{ "IndexName": "IndexName-2", "JobType": "No Active Job", "JobStatus": "No documents indexed", "JobStage": -999, "IsStageInError": false, "TotalIndexed": 0, "TotalErrored": 0, "ProgressPercentage": 0.0, "JobDurationString": "01:33:30", "IndexBuildDurationString": "01:33:19", "ErrorMessage": "", "CanActivate": false }
The dtSearch Manager API provides the following helper methods for returning workspace parameters for populating dtSearch saved search properties.
To get a list of active indexes for a given workspace, send a GET request to the following URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/{{workspaceID}}/dtsearch-indexes/index-shares
Set the {{workspaceID}} variable to the Artifact ID of the workspace containing the dtSearch. See the following sample URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/3549690/dtsearch-indexes/index-shares
[ { "Name":"\\\\fileshareuncpath\\directoryname\\dtSearchPath\\", "ID":1016154 } { "Name":"\\\\fileshareuncpath2\\directoryname2\\dtSearchPath2\\", "ID":1016155 } ]
To get a list of saved searches for a given workspace, send a GET request to the following URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/{{workspaceID}}/dtsearch-indexes/saved-search
Set the {{workspaceID}} variable to the Artifact ID of the workspace containing the dtSearch. See the following sample URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/3549690/dtsearch-indexes/saved-search
The response contains the following fields:
[ { "Name":"All Documents", "ID":1038052 }, { "Name":"Extracted Text Only", "ID":1038051 }, { "Name":"Produced Documents", "ID":1036361 } ]
To get a list of index share locations for a given workspace, send a GET request to the following URL:
<host>/Relativity.Rest/API/Relativity.Compute.DtSearchIndexes/workspace/{{workspaceID}}/dtSearchIndexes/indexshares
Set the {{workspaceID}} variable to the Artifact ID of the workspace containing the dtSearch. See the following sample URL:
<host>/Relativity.Rest/API/Relativity.Compute.DtSearchIndexes/workspace/3549690/dtSearchIndexes/indexshares
[ { "Name":"\\\\fileshareuncpath\\directoryname\\dtSearchPath\\", "ID":1016154 } { "Name":"\\\\fileshareuncpath2\\directoryname2\\dtSearchPath2\\", "ID":1016155 } ]
To get statistical data for a given index, send a GET request to the following URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/{{workspaceID}}/dtsearch-indexes/{{RelativitySearchProviderID}}/index-statistics
Set the {{workspaceID}} variable to the Artifact ID of the workspace containing the dtSearch. Set the {{RelativitySearchProviderID}} variable to the Artifact ID of the dtSearch. See the following sample URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/1017652/dtsearch-indexes/1039620/index-statistics
The response contains the following fields:
{ "DocumentCount":300, "IndexSize":29952863, "LastBuiltOn":"2019-06-13T16:38:02", "LastModifiedOn":"2019-06-13T16:38:02", "BuildTime":"00:00:16" }
To get a list of document-level errors that occurred during the index build, send a GET request to the following URL:
<host>/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/{{workspaceID}}/dtsearch-indexes/{{RelativitySearchProviderID}}/document-errors
Set the {{workspaceID}} variable to the Artifact ID of the workspace containing the dtSearch. Set the {{RelativitySearchProviderID}} variable to the Artifact ID of the dtSearch. See the following sample URL:
/Relativity.Rest/API/relativity-dtsearch/v1/workspaces/1017652/dtsearch-indexes/1039620/document-errors
[ { "ArtifactID": 1054057, "ErrorMessage": "Error during read -> Invalid URI: The format of the URI could not be determined." }, { "ArtifactID" : 1054058, "ErrorMessage: "Error during read -> Unable to locate file" } ]
Community Updates |
|||
Aero Developer FAQ | Evolving the Platform | Most recent release notes | |
Learn more | Learn more | Learn more |
Additional Resources |
|||
![]() |
![]() |
||
Access Third-Party Tools with GitHub | Create .NET Apps Faster with NuGet | ||
Visit github | visit nuget |