Relativity

Relativity DtSearchIndex Module v1 API

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

GitHub OpenAPI

Documentation

📖
Documentation
https://platform.relativity.com/RelativityOne/Content/REST_API/REST_API.htm
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/relativity/refs/heads/main/rate-limits/relativity-rate-limits.yml
📖
Documentation
https://platform.relativity.com/RelativityOne/Content/Relativity_Platform/Platform_APIs.htm
📖
GettingStarted
https://platform.relativity.com/RelativityOne/Content/Getting_Started/Basic_REST_API_concepts.htm
📖
Documentation
https://help.relativity.com/RelativityOne/Content/Management_Console/Cost_Explorer.htm

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/relativity/refs/heads/main/openapi/relativity-dtsearchindex-module-v1-api-openapi.yml

Other Resources

🔗
Plans
https://raw.githubusercontent.com/api-evangelist/relativity/refs/heads/main/plans/relativity-plans-pricing.yml
🔗
FinOps
https://raw.githubusercontent.com/api-evangelist/relativity/refs/heads/main/finops/relativity-finops.yml
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/relativity/refs/heads/main/graphql/relativity-graphql.md

OpenAPI Specification

relativity-dtsearchindex-module-v1-api-openapi.yml Raw ↑ 
openapi: 3.0.1
info:
  title: Analytics.Conceptual.Service.Interfaces.Public.V1 AnnotationService DtSearchIndex Module v1 API
  description: Analytics.Conceptual.Service.Interfaces.Public
  version: V1
servers:
- url: /Relativity.REST/api
  description: The URL prefix for all Kepler services
tags:
- name: DtSearchIndex Module v1
paths:
  /relativity-dtsearch/v1/workload-discovery/{agentGuid}/workload:
    get:
      tags:
      - DtSearchIndex Module v1
      description: '[Private] IWorkloadDiscoveryManager - '
      operationId: Relativity.DTSearch.V1.WorkloadDiscoveryManager.IWorkloadDiscoveryManager.GetWorkloadAsync
      parameters:
      - $ref: '#/components/parameters/agentGuid'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workload'
  /relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/consistency-check-is-affected:
    get:
      tags:
      - DtSearchIndex Module v1
      description: '[Private] IConsistencyCheckManager - '
      operationId: Relativity.DTSearch.V1.ConsistencyCheckManager.IConsistencyCheckManager.GetIsAffectedAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dtSearchArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: boolean
  /relativity-dtsearch/v1/GetArchiveLocationAsync:
    get:
      tags:
      - DtSearchIndex Module v1
      description: '[Testing] IArmTestService - '
      operationId: Relativity.DTSearch.V1.ArmTestService.IArmTestService.GetArchiveLocationAsync
      parameters:
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: string
  /relativity-dtsearch/v1/SetDtSearchIndexLocationToNullAsync:
    post:
      tags:
      - DtSearchIndex Module v1
      description: '[Testing] IArmTestService - '
      operationId: Relativity.DTSearch.V1.ArmTestService.IArmTestService.SetDtSearchIndexLocationToNullAsync
      parameters:
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetDtSearchIndexLocationToNullAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: integer
  /relativity-dtsearch/v1/SetDtSearchIndexLocationToEmptyStringAsync:
    post:
      tags:
      - DtSearchIndex Module v1
      description: '[Testing] IArmTestService - '
      operationId: Relativity.DTSearch.V1.ArmTestService.IArmTestService.SetDtSearchIndexLocationToEmptyStringAsync
      parameters:
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetDtSearchIndexLocationToEmptyStringAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: integer
  /relativity-dtsearch/v1/workspaces/{workspaceID}/saved-searches:
    get:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetSearchableSetAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NameIDPair'
  /relativity-dtsearch/v1/workspaces/{workspaceID}/{searchableSetID}/saved-search-contains-long-text-field:
    get:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.SearchableSetContainsLongTextField
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/searchableSetID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: boolean
  /relativity-dtsearch/v1/workspaces/{workspaceID}/index-shares:
    get:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetIndexShareLocationAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NameIDPair'
  /relativity-dtsearch/v1/workspaces/{workspaceID}/{resourcePoolID}/index-shares:
    get:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetIndexShareLocationAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/resourcePoolID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NameIDPair'
  /relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/all:
    get:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetAllIndexesInWorkspaceAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DtSearchIndexServiceResponse'
    post:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetAllIndexesInWorkspaceFilteredAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAllIndexesInWorkspaceFilteredAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DtSearchIndexServiceResponse'
  /relativity-dtsearch/v1/workspaces/{workspaceID}/default-alphabet-file:
    get:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetDefaultAlphabetFileForWorkspace
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: string
  /relativity-dtsearch/v1/workspaces/{workspaceID}/default-noise-words-file:
    get:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetDefaultNoiseWordsFileForWorkspace
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: string
  /relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/index-option-details:
    get:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetIndexOptionDetailsAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dtSearchArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DtSearchIndexOptionDetailsResponse'
  /relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/current-index-details-table:
    get:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetCurrentIndexDetailsAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dtSearchArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DtSearchSubIndexTableResponse'
    post:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.CurrentIndexDetailsAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dtSearchArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CurrentIndexDetailsAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DtSearchSubIndexTableResponse'
  /relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/sub-index-details:
    get:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetSubIndexDetailsAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dtSearchArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DtSearchSubIndexResponse'
  /relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/index-job-progress:
    get:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetIndexJobProgressAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dtSearchArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DtSearchIndexJobProgressResponse'
  /relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/index-status:
    get:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetIndexIDAndStatusAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dtSearchArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DtSearchIndexStatus'
  /relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/index-statistics:
    get:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetIndexStatisticsAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dtSearchArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DtSearchIndexStatisticsResponse'
  /relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/document-errors:
    get:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetDocumentErrorsAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dtSearchArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DtSearchIndexDocumentErrorResponse'
    post:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetFilteredDocumentErrorsAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dtSearchArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetFilteredDocumentErrorsAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DtSearchIndexDocumentErrorFilteredResponse'
  /relativity-dtsearch/v1/workspaces/{workspaceID}/resource-pool-worker-count:
    get:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetWorkspaceResourcePoolWorkerCount
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DtSearchResourceWorkerCount'
  /relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/delete-sub-index:
    post:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.DeleteSubIndex
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dtSearchArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteSubIndex_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
  /relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/build-index:
    post:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.BuildIndexAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dtSearchArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BuildIndexAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
  /relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/full-build-index:
    post:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.FullBuildIndexAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dtSearchArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FullBuildIndexAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
  /relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/incremental-build-index:
    post:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.IncrementalBuildIndexAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dtSearchArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IncrementalBuildIndexAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
  /relativity-dtsearch/v1/workspaces/{workspaceID}/swap-index:
    post:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.SwapIndexAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SwapIndexAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
  /relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/move-index:
    post:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.MoveIndexAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dtSearchArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
  /relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/compress-index:
    post:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.CompressIndexAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dtSearchArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
  /relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/threshold-compress-index:
    post:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.ThresholdCompressIndexAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dtSearchArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ThresholdCompressIndexAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
  /relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/activate-index:
    post:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.ActivateIndexAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dtSearchArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
  /relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/deactivate-index:
    post:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.DeactivateIndexAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dtSearchArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
  /relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/cancel-build:
    post:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.CancelBuildIndexAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dtSearchArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
  /relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/retry-errors:
    post:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.RetryErrorsAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dtSearchArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
  /relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes:
    post:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.CreateAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: integer
  /relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}:
    put:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.UpdateAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dtSearchArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
    get:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.ReadAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dtSearchArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DtSearchIndexResponse'
  /relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/{includeMetaData}/{includeActions}:
    get:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.ReadAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dtSearchArtifactID'
      - $ref: '#/components/parameters/includeMetaData'
      - $ref: '#/components/parameters/includeActions'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DtSearchIndexResponse'
  /relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/delete-index:
    delete:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.DeleteAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dtSearchArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
  /relativity-dtsearch/v1/workspaces/{workspaceID}/dtsearch-indexes/{dtSearchArtifactID}/copy-index:
    post:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.CopyAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dtSearchArtifactID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
  /relativity-dtsearch/v1/workspaces/{workspaceID}/health-check:
    get:
      tags:
      - DtSearchIndex Module v1
      description: '[Public] IDtSearchIndexManager - '
      operationId: Relativity.DTSearch.V1.DTSearchIndexManager.IDtSearchIndexManager.GetHealthCheck
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
  /relativity-dtsearch/v1/dtsearch-queue-admin/jobs:
    get:
      tags:
      - DtSearchIndex Module v1
      description: '[Internal] IDtSearchQueueAdminManager - '
      operationId: Relativity.DTSearch.V1.DTSearchQueueAdminManager.IDtSearchQueueAdminManager.GetAllJobsAsync
      parameters:
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DtSearchQueueAdminServiceResponse'
    post:
      tags:
      - DtSearchIndex Module v1
      description: '[Internal] IDtSearchQueueAdminManager - '
      operationId: Relativity.DTSearch.V1.DTSearchQueueAdminManager.IDtSearchQueueAdminManager.GetAllJobsFilteredAsync
      parameters:
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAllJobsFilteredAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DtSearchQueueAdminServiceResponse'
    put:
      tags:
      - DtSearchIndex Module v1
      description: '[Internal] IDtSearchQueueAdminManager - '
      operationId: Relativity.DTSearch.V1.DTSearchQueueAdminManager.IDtSearchQueueAdminManager.UpdateJobPriorityAsync
      parameters:
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateJobPriorityAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: integer
components:
  schemas:
    DtSearchQueueAdmin:
      title: DtSearchQueueAdmin
      type: object
      properties:
        WorkspaceId:
          type: integer
        Status:
          type: string
        JobType:
          type: string
        Priority:
          type: integer
        SubmittedDate:
          type: string
          format: date-time
        DtSearchIndexArtifactId:
          type: integer
        JobID:
          type: string
    DtSearchIndexOptionDetailsResponse:
      title: DtSearchIndexOptionDetailsResponse
      type: object
      properties:
        AlphabetInSql:
          type: boolean
        AlphabetOnDisk:
          type: boolean
        AlphabetMatchesDefault:
          type: boolean
        AlphabetIsDirty:
          type: boolean
        NoiseWordsInSql:
          type: boolean
        NoiseWordsOnDisk:
          type: boolean
        NoiseWordsMatchDefault:
          type: boolean
        NoiseWordsAreDirty:
          type: boolean
        IndexIsCorrupted:
          type: boolean
    DtSearchIndexFilter:
      title: DtSearchIndexFilter
      type: object
      properties:
        Condition:
          type: array
          items:
            $ref: '#/components/schemas/DtSearchIndexFilterCondition'
        Field:
          type: string
        isAdvanced:
          type: boolean
    DeleteSubIndex_RequestBody:
      title: DeleteSubIndex_RequestBody
      type: object
      properties:
        dtSearchSubIndexIDs:
          type: array
          items:
            type: integer
    DtSearchSubIndexTableResponse:
      title: DtSearchSubIndexTableResponse
      type: object
      properties:
        TotalCount:
          type: integer
    DtSearchIndexSort:
      title: DtSearchIndexSort
      type: object
      properties:
        Field:
          

# --- truncated at 32 KB (46 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/relativity/refs/heads/main/openapi/relativity-dtsearchindex-module-v1-api-openapi.yml