How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Relativity DtSearchIndex Module v1 API

The DtSearchIndex Module v1 API from Relativity — 39 operation(s) for dtsearchindex module v1.

Documentation Provider Profile APIs.io OpenAPI GitHub

Relativity DtSearchIndex Module v1 API is one of 51 APIs that Relativity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include DtSearchIndex Module v1. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, rate-limit docs, and a getting-started guide.

This API exposes 45 operations across 39 paths, and defines 46 schemas. It is described by OpenAPI 3.2.0, at version V1.

Requests are made against a single base URL, /Relativity.REST/api.

45 operations 39 paths 46 schemas 1 DELETE22 GET20 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.2.0

API Version

V1

Base URL

https://{host}/Relativity.REST/api/relativity-object-model/v1

Resource Areas

1

Paths & Operations 45

Across 39 paths, the API surfaces 45 operations — 1 DELETE, 22 GET, 20 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

DtSearchIndex Module v1 45

GET

/relativity-dtsearch/v1/workload-discovery/{agentGuid}/workload

[Private] IWorkloadDiscoveryManager -

Relativity.DTSearch.V1.WorkloadDiscoveryManager.IWorkloadDiscoveryManager.GetWorkloadAsync 2 params → 200

GET

/relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/consistency-check-is-affected

[Private] IConsistencyCheckManager -

Relativity.DTSearch.V1.ConsistencyCheckManager.IConsistencyCheckManager.GetIsAffectedAsync 3 params → 200

GET

/relativity-dtsearch/v1/GetArchiveLocationAsync

[Testing] IArmTestService -

Relativity.DTSearch.V1.ArmTestService.IArmTestService.GetArchiveLocationAsync 1 param → 200

POST

/relativity-dtsearch/v1/SetDtSearchIndexLocationToNullAsync

[Testing] IArmTestService -

Relativity.DTSearch.V1.ArmTestService.IArmTestService.SetDtSearchIndexLocationToNullAsync 1 param body → 200

POST

/relativity-dtsearch/v1/SetDtSearchIndexLocationToEmptyStringAsync

[Testing] IArmTestService -

Relativity.DTSearch.V1.ArmTestService.IArmTestService.SetDtSearchIndexLocationToEmptyStringAsync 1 param body → 200

GET

/relativity-dtsearch/v1/workspaces/{workspaceID}/saved-searches

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetSearchableSetAsync 2 params → 200

GET

/relativity-dtsearch/v1/workspaces/{workspaceID}/{searchableSetID}/saved-search-contains-long-text-field

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.SearchableSetContainsLongTextField 3 params → 200

GET

/relativity-dtsearch/v1/workspaces/{workspaceID}/index-shares

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetIndexShareLocationAsync 2 params → 200

GET

/relativity-dtsearch/v1/workspaces/{workspaceID}/{resourcePoolID}/index-shares

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetIndexShareLocationAsync 3 params → 200

GET

/relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/all

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetAllIndexesInWorkspaceAsync 2 params → 200

POST

/relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/all

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetAllIndexesInWorkspaceFilteredAsync 2 params body → 200

GET

/relativity-dtsearch/v1/workspaces/{workspaceID}/default-alphabet-file

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetDefaultAlphabetFileForWorkspace 2 params → 200

GET

/relativity-dtsearch/v1/workspaces/{workspaceID}/default-noise-words-file

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetDefaultNoiseWordsFileForWorkspace 2 params → 200

GET

/relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/index-option-details

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetIndexOptionDetailsAsync 3 params → 200

GET

/relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/current-index-details-table

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetCurrentIndexDetailsAsync 3 params → 200

POST

/relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/current-index-details-table

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.CurrentIndexDetailsAsync 3 params body → 200

GET

/relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/sub-index-details

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetSubIndexDetailsAsync 3 params → 200

GET

/relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/index-job-progress

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetIndexJobProgressAsync 3 params → 200

GET

/relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/index-status

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetIndexIDAndStatusAsync 3 params → 200

GET

/relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/index-statistics

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetIndexStatisticsAsync 3 params → 200

GET

/relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/document-errors

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetDocumentErrorsAsync 3 params → 200

POST

/relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/document-errors

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetFilteredDocumentErrorsAsync 3 params body → 200

GET

/relativity-dtsearch/v1/workspaces/{workspaceID}/resource-pool-worker-count

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetWorkspaceResourcePoolWorkerCount 2 params → 200

POST

/relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/delete-sub-index

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.DeleteSubIndex 3 params body → 200

POST

/relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/build-index

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.BuildIndexAsync 3 params body → 200

POST

/relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/full-build-index

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.FullBuildIndexAsync 3 params body → 200

POST

/relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/incremental-build-index

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.IncrementalBuildIndexAsync 3 params body → 200

POST

/relativity-dtsearch/v1/workspaces/{workspaceID}/swap-index

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.SwapIndexAsync 2 params body → 200

POST

/relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/move-index

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.MoveIndexAsync 3 params → 200

POST

/relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/compress-index

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.CompressIndexAsync 3 params → 200

POST

/relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/threshold-compress-index

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.ThresholdCompressIndexAsync 3 params body → 200

POST

/relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/activate-index

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.ActivateIndexAsync 3 params → 200

POST

/relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/deactivate-index

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.DeactivateIndexAsync 3 params → 200

POST

/relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/cancel-build

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.CancelBuildIndexAsync 3 params → 200

POST

/relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/retry-errors

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.RetryErrorsAsync 3 params → 200

POST

/relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.CreateAsync 2 params body → 200

PUT

/relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.UpdateAsync 3 params body → 200

GET

/relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.ReadAsync 3 params → 200

GET

/relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/{includeMetaData}/{includeActions}

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.ReadAsync 5 params → 200

DELETE

/relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/delete-index

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.DeleteAsync 3 params → 200

POST

/relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/copy-index

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.CopyAsync 3 params → 200

GET

/relativity-dtsearch/v1/workspaces/{workspaceID}/health-check

[Public] IDtSearchIndexManager -

Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetHealthCheck 2 params → 200

GET

/relativity-dtsearch/v1/dtsearch-queue-admin/jobs

[Internal] IDtSearchQueueAdminManager -

Relativity.DTSearch.V1.DTSearchQueueAdminManager.IDtSearchQueueAdminManager.GetAllJobsAsync 1 param → 200

POST

/relativity-dtsearch/v1/dtsearch-queue-admin/jobs

[Internal] IDtSearchQueueAdminManager -

Relativity.DTSearch.V1.DTSearchQueueAdminManager.IDtSearchQueueAdminManager.GetAllJobsFilteredAsync 1 param body → 200

PUT

/relativity-dtsearch/v1/dtsearch-queue-admin/jobs

[Internal] IDtSearchQueueAdminManager -

Relativity.DTSearch.V1.DTSearchQueueAdminManager.IDtSearchQueueAdminManager.UpdateJobPriorityAsync 1 param body → 200

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are DateTimeOffset (19 properties), DtSearchIndexRequest (18 properties), DtSearchIndexJobProgressResponse (17 properties), DtSearchSubIndexResponse (13 properties). Each schema is shown below with its type and property counts.

GetFilteredDocumentErrorsAsync_RequestBody

object

1 property

DateTimeOffset

object

19 properties

SetDtSearchIndexLocationToNullAsync_RequestBody

object

1 property

UpdateAsync_RequestBody

object

1 property

DtSearchQueueAdminFilterSort

object

2 properties

UpdateJobPriorityAsync_RequestBody

object

1 property

DtSearchIndexFilterRequest

object

4 properties

DtSearchQueueAdmin

object

7 properties

CurrentIndexDetailsAsync_RequestBody

object

1 property

DtSearchQueueAdminUpdateRequest

object

IncrementalBuildIndexAsync_RequestBody

object

1 property

DtSearchQueueAdminServiceResponse

object

2 properties

DtSearchIndexStatisticsResponse

object

6 properties

DtSearchIndexRequest

object

18 properties

CreateAsync_RequestBody

object

1 property

BuildIndexAsync_RequestBody

object

1 property

DtSearchIndexServiceResponse

object

2 properties

DtSearchIndexOptionDetailsResponse

object

9 properties

GetAllIndexesInWorkspaceFilteredAsync_RequestBody

object

1 property

DeleteSubIndex_RequestBody

object

1 property

SubIndexJobStateDetailsResponse

object

2 properties

SubIndexEngineJobStateResponse

object

5 properties

DtSearchIndexJobProgressResponse

object

17 properties

DtSearchQueueAdminFilterRequest

object

4 properties

GetAllJobsFilteredAsync_RequestBody

object

1 property

FullBuildIndexAsync_RequestBody

object

1 property

DtSearchSubIndexTableResponse

object

1 property

DtSearchResourceWorkerCount

object

4 properties

DtSearchQueueAdminFilter

object

3 properties

Workload

object

1 property

DtSearchQueueAdminFilterCondition

object

3 properties

DtSearchIndexResponse

object

ThresholdCompressIndexAsync_RequestBody

object

1 property

DtSearchIndexFilter

object

3 properties

TimeSpan

object

11 properties

SwapIndexAsync_RequestBody

object

2 properties

DtSearchDocumentProgressResponse

object

5 properties

SetDtSearchIndexLocationToEmptyStringAsync_RequestBody

object

1 property

DtSearchIndexSort

object

3 properties

DtSearchIndex

object

5 properties

DtSearchIndexDocumentErrorFilteredResponse

object

NameIDPair

object

2 properties

DtSearchIndexStatus

object

3 properties

DtSearchIndexDocumentErrorResponse

object

3 properties

DtSearchIndexFilterCondition

object

3 properties

DtSearchSubIndexResponse

object

13 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Relativity publishes across the network.

Relativity AnnotationService API

AE Profile APIs.io

Relativity ArchiveJobs API

AE Profile APIs.io

Relativity ARM Module v1 API

AE Profile APIs.io

Relativity ARM Module v3 API

AE Profile APIs.io

Relativity BillableSummaryReports API

AE Profile APIs.io

Relativity BillingConfiguration API

AE Profile APIs.io

Relativity BillingInsights API

AE Profile APIs.io

Relativity Client Side Libraries Module API

AE Profile APIs.io

Relativity ColdStorage API

AE Profile APIs.io

Relativity CollectAPI API

AE Profile APIs.io

Relativity Conceptual Analytics v1 API

AE Profile APIs.io

Relativity Directory API

AE Profile APIs.io

#DtSearchIndex Module v1

← Back to R APIs

Call it yourself

curl for this page

Search the network for this

curl "https://api.apievangelist.com/v1/search?q=relativity-dtsearchindex-module-v1-api&limit=10"

Everything under a tag

curl "https://api.apievangelist.com/v1/tags/relativity-dtsearchindex-module-v1-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Where this information came from

This is an independent, third-party profile of Relativity DtSearchIndex Module v1 API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.