Relativity

Relativity Relativity Mass Operation Module v2 API

The Relativity Mass Operation Module v2 API from Relativity — 26 operation(s) for relativity mass operation module v2.

GitHub OpenAPI

Operations 26

POST /relativity-massoperation/v2/workspaces/{workspaceID}/publishmasscopyjobrequest #
POST /relativity-massoperation/v2/workspaces/{workspaceID}/masscopy #
POST /relativity-massoperation/v2/workspaces/{workspaceID}/publishmassmovejobrequest #
POST /relativity-massoperation/v2/workspaces/{workspaceID}/massmove #
POST /relativity-massoperation/v2/workspaces/{workspaceID}/publishmasseditjobrequest #
POST /relativity-massoperation/v2/workspaces/{workspaceID}/massedit #
POST /relativity-massoperation/v2/workspaces/{workspaceID}/publishmassdeletejobrequest #
POST /relativity-massoperation/v2/workspaces/{workspaceID}/massdelete #
POST /relativity-massoperation/v2/workspaces/{workspaceID}/publishmassreplacejobrequest #
POST /relativity-massoperation/v2/workspaces/{workspaceID}/massreplace #
POST /relativity-massoperation/v2/workspaces/{workspaceID}/publishmasssaveaslistjobrequest #
POST /relativity-massoperation/v2/workspaces/{workspaceID}/masssaveaslist #
POST /relativity-massoperation/v2/workspaces/{workspaceID}/publishmasstallysumaveragejobrequest #
POST /relativity-massoperation/v2/workspaces/{workspaceID}/masstallysumaverage #
POST /relativity-massoperation/v2/workspaces/{workspaceID}/publishmassexporttofilejobrequest #
POST /relativity-massoperation/v2/workspaces/{workspaceID}/massexporttofile #
POST /relativity-massoperation/v2/workspaces/{workspaceID}/initializemassoperation #
DELETE /relativity-massoperation/v2/workspaces/{workspaceID}/processes/{processID} #
DELETE /relativity-massoperation/v2/workspaces/{workspaceID}/processes/{processIdentifier} #
GET /relativity-massoperation/v2/workspaces/{workspaceID}/processes/{processID}/checkprogress #
GET /relativity-massoperation/v2/workspaces/{workspaceID}/processes/{processIdentifier}/checkprogress #
GET /relativity-massoperation/v2/workspaces/{workspaceID}/artifactType/{artifactTypeID}/processes/{processID}/massdeletestartup #
GET /relativity-massoperation/v2/processes/{processID}/massagentdeletestartup #
GET /relativity-massoperation/v2/workspaces/{workspaceID}/artifactType/{artifactTypeID}/processes/{processID}/validatemassedit #
GET /relativity-massoperation/v2/massoperationprocessstateextended #
GET /relativity-massoperation/v2/massoperationjobsrefreshinterval #

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-relativity-mass-operation-module-v2-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

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/relativity-relativity-mass-operation-module-v2-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

relativity-relativity-mass-operation-module-v2-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Analytics.Conceptual.Service.Interfaces.Public.V1 AnnotationService Relativity Mass Operation Module v2 API
  description: Analytics.Conceptual.Service.Interfaces.Public
  version: V1
servers:
- url: /Relativity.REST/api
  description: The URL prefix for all Kepler services
tags:
- name: Relativity Mass Operation Module v2
paths:
  /relativity-massoperation/v2/workspaces/{workspaceID}/publishmasscopyjobrequest:
    post:
      tags:
      - Relativity Mass Operation Module v2
      description: '[Public] IMassOperationManagerService - '
      operationId: Relativity.MassOperations.Service.V2.IMassOperationManagerService.PublishMassCopyJobRequestAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublishMassCopyJobRequestAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
  /relativity-massoperation/v2/workspaces/{workspaceID}/masscopy:
    post:
      tags:
      - Relativity Mass Operation Module v2
      description: '[Public] IMassOperationManagerService - '
      operationId: Relativity.MassOperations.Service.V2.IMassOperationManagerService.MassCopyAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MassCopyAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MassOperationResult'
  /relativity-massoperation/v2/workspaces/{workspaceID}/publishmassmovejobrequest:
    post:
      tags:
      - Relativity Mass Operation Module v2
      description: '[Public] IMassOperationManagerService - '
      operationId: Relativity.MassOperations.Service.V2.IMassOperationManagerService.PublishMassMoveJobRequestAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublishMassMoveJobRequestAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
  /relativity-massoperation/v2/workspaces/{workspaceID}/massmove:
    post:
      tags:
      - Relativity Mass Operation Module v2
      description: '[Public] IMassOperationManagerService - '
      operationId: Relativity.MassOperations.Service.V2.IMassOperationManagerService.MassMoveAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MassMoveAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MassOperationResult'
  /relativity-massoperation/v2/workspaces/{workspaceID}/publishmasseditjobrequest:
    post:
      tags:
      - Relativity Mass Operation Module v2
      description: '[Public] IMassOperationManagerService - '
      operationId: Relativity.MassOperations.Service.V2.IMassOperationManagerService.PublishMassEditJobRequestAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublishMassEditJobRequestAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
  /relativity-massoperation/v2/workspaces/{workspaceID}/massedit:
    post:
      tags:
      - Relativity Mass Operation Module v2
      description: '[Public] IMassOperationManagerService - '
      operationId: Relativity.MassOperations.Service.V2.IMassOperationManagerService.MassEditAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MassEditAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MassOperationResult'
  /relativity-massoperation/v2/workspaces/{workspaceID}/publishmassdeletejobrequest:
    post:
      tags:
      - Relativity Mass Operation Module v2
      description: '[Public] IMassOperationManagerService - '
      operationId: Relativity.MassOperations.Service.V2.IMassOperationManagerService.PublishMassDeleteJobRequestAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublishMassDeleteJobRequestAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
  /relativity-massoperation/v2/workspaces/{workspaceID}/massdelete:
    post:
      tags:
      - Relativity Mass Operation Module v2
      description: '[Public] IMassOperationManagerService - '
      operationId: Relativity.MassOperations.Service.V2.IMassOperationManagerService.MassDeleteAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MassDeleteAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MassOperationResult'
  /relativity-massoperation/v2/workspaces/{workspaceID}/publishmassreplacejobrequest:
    post:
      tags:
      - Relativity Mass Operation Module v2
      description: '[Public] IMassOperationManagerService - '
      operationId: Relativity.MassOperations.Service.V2.IMassOperationManagerService.PublishMassReplaceJobRequestAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublishMassReplaceJobRequestAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
  /relativity-massoperation/v2/workspaces/{workspaceID}/massreplace:
    post:
      tags:
      - Relativity Mass Operation Module v2
      description: '[Public] IMassOperationManagerService - '
      operationId: Relativity.MassOperations.Service.V2.IMassOperationManagerService.MassReplaceAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MassReplaceAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MassOperationResult'
  /relativity-massoperation/v2/workspaces/{workspaceID}/publishmasssaveaslistjobrequest:
    post:
      tags:
      - Relativity Mass Operation Module v2
      description: '[Public] IMassOperationManagerService - '
      operationId: Relativity.MassOperations.Service.V2.IMassOperationManagerService.PublishMassSaveAsListJobRequestAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublishMassSaveAsListJobRequestAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
  /relativity-massoperation/v2/workspaces/{workspaceID}/masssaveaslist:
    post:
      tags:
      - Relativity Mass Operation Module v2
      description: '[Public] IMassOperationManagerService - '
      operationId: Relativity.MassOperations.Service.V2.IMassOperationManagerService.MassSaveAsListAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MassSaveAsListAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MassOperationResult'
  /relativity-massoperation/v2/workspaces/{workspaceID}/publishmasstallysumaveragejobrequest:
    post:
      tags:
      - Relativity Mass Operation Module v2
      description: '[Public] IMassOperationManagerService - '
      operationId: Relativity.MassOperations.Service.V2.IMassOperationManagerService.PublishMassTallySumAverageJobRequestAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublishMassTallySumAverageJobRequestAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TallySumAverageResult'
  /relativity-massoperation/v2/workspaces/{workspaceID}/masstallysumaverage:
    post:
      tags:
      - Relativity Mass Operation Module v2
      description: '[Public] IMassOperationManagerService - '
      operationId: Relativity.MassOperations.Service.V2.IMassOperationManagerService.TallySumAverageAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TallySumAverageAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TallySumAverageResult'
  /relativity-massoperation/v2/workspaces/{workspaceID}/publishmassexporttofilejobrequest:
    post:
      tags:
      - Relativity Mass Operation Module v2
      description: '[Public] IMassOperationManagerService - '
      operationId: Relativity.MassOperations.Service.V2.IMassOperationManagerService.PublishMassExportToFileJobRequestAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublishMassExportToFileJobRequestAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IKeplerStream'
  /relativity-massoperation/v2/workspaces/{workspaceID}/massexporttofile:
    post:
      tags:
      - Relativity Mass Operation Module v2
      description: '[Public] IMassOperationManagerService - '
      operationId: Relativity.MassOperations.Service.V2.IMassOperationManagerService.MassExportToFileAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MassExportToFileAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IKeplerStream'
  /relativity-massoperation/v2/workspaces/{workspaceID}/initializemassoperation:
    post:
      tags:
      - Relativity Mass Operation Module v2
      description: '[Public] IMassOperationManagerService - '
      operationId: Relativity.MassOperations.Service.V2.IMassOperationManagerService.InitializeMassOperationAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InitializeMassOperationAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InitializeMassOperationResult'
  /relativity-massoperation/v2/workspaces/{workspaceID}/processes/{processID}:
    delete:
      tags:
      - Relativity Mass Operation Module v2
      description: '[Public] IMassOperationManagerService - '
      operationId: Relativity.MassOperations.Service.V2.IMassOperationManagerService.CancelAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/processID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
  /relativity-massoperation/v2/workspaces/{workspaceID}/processes/{processIdentifier}:
    delete:
      tags:
      - Relativity Mass Operation Module v2
      description: '[Public] IMassOperationManagerService - '
      operationId: Relativity.MassOperations.Service.V2.IMassOperationManagerService.CancelAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/processIdentifier'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
  /relativity-massoperation/v2/workspaces/{workspaceID}/processes/{processID}/checkprogress:
    get:
      tags:
      - Relativity Mass Operation Module v2
      description: '[Public] IMassOperationManagerService - '
      operationId: Relativity.MassOperations.Service.V2.IMassOperationManagerService.CheckProgress
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/processID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MassOperationProcessState'
  /relativity-massoperation/v2/workspaces/{workspaceID}/processes/{processIdentifier}/checkprogress:
    get:
      tags:
      - Relativity Mass Operation Module v2
      description: '[Public] IMassOperationManagerService - '
      operationId: Relativity.MassOperations.Service.V2.IMassOperationManagerService.CheckProgress
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/processIdentifier'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MassOperationProcessState'
  ? /relativity-massoperation/v2/workspaces/{workspaceID}/artifactType/{artifactTypeID}/processes/{processID}/massdeletestartup
  : get:
      tags:
      - Relativity Mass Operation Module v2
      description: '[Public] IMassOperationManagerService - '
      operationId: Relativity.MassOperations.Service.V2.IMassOperationManagerService.GetMassDeleteStartupInformationAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/artifactTypeID'
      - $ref: '#/components/parameters/processID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MassDeleteStartupResult'
  /relativity-massoperation/v2/processes/{processID}/massagentdeletestartup:
    get:
      tags:
      - Relativity Mass Operation Module v2
      description: '[Public] IMassOperationManagerService - '
      operationId: Relativity.MassOperations.Service.V2.IMassOperationManagerService.GetMassAgentDeleteStartupInformationAsync
      parameters:
      - $ref: '#/components/parameters/processID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MassAgentDeleteStartupResult'
  /relativity-massoperation/v2/workspaces/{workspaceID}/artifactType/{artifactTypeID}/processes/{processID}/validatemassedit:
    get:
      tags:
      - Relativity Mass Operation Module v2
      description: '[Public] IMassOperationManagerService - '
      operationId: Relativity.MassOperations.Service.V2.IMassOperationManagerService.ValidateMassEditAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/artifactTypeID'
      - $ref: '#/components/parameters/processID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: boolean
  /relativity-massoperation/v2/massoperationprocessstateextended:
    get:
      tags:
      - Relativity Mass Operation Module v2
      description: '[Public] IMassOperationManagerService - '
      operationId: Relativity.MassOperations.Service.V2.IMassOperationManagerService.GetMassOperationProcessStateExtendedAsync
      parameters:
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MassOperationProcessStateExtendedResult'
  /relativity-massoperation/v2/massoperationjobsrefreshinterval:
    get:
      tags:
      - Relativity Mass Operation Module v2
      description: '[Public] IMassOperationManagerService - '
      operationId: Relativity.MassOperations.Service.V2.IMassOperationManagerService.GetMassOperationJobsRefreshInterval
      parameters:
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UInt32'
components:
  schemas:
    MassDeleteAsync_RequestBody:
      title: MassDeleteAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/MassDeleteRequest'
    MassDeleteRequest:
      title: MassDeleteRequest
      type: object
      properties:
        DocumentDeleteOptions:
          enum:
          - DeleteDocumentAndAllAssociatedFiles
          - DeleteOnlyImages
          - DeleteOnlyNatives
          - DeleteOnlyNativesAndImages
          type: string
        ForceDelete:
          type: boolean
        Type:
          enum:
          - Edit
          - Delete
          - Replace
          - Move
          - Copy
          - Report
          - SendToCaseMap
          - Tif
          - Print
          - Export
          - Cluster
          - Tally
          - SaveAsList
          - Custom
          type: string
        PromoteDuplicatesFromOtherSources:
          type: boolean
        SnapshotAuditSelectionForOperation:
          type: boolean
        ArtifactTypeID:
          type: integer
        Query:
          $ref: '#/components/schemas/QueryRequest'
    MassEditJobRequest:
      title: MassEditJobRequest
      type: object
      properties:
        Type:
          enum:
          - Edit
          - Delete
          - Replace
          - Move
          - Copy
          - Report
          - SendToCaseMap
          - Tif
          - Print
          - Export
          - Cluster
          - Tally
          - SaveAsList
          - Custom
          type: string
        Fields:
          type: array
          items:
            $ref: '#/components/schemas/EditField'
        ArtifactTypeID:
          type: integer
        MassProcessID:
          type: integer
    ReplaceField:
      title: ReplaceField
      type: object
      properties:
        ReplaceAction:
          $ref: '#/components/schemas/ReplaceAction'
        ReplaceOptions:
          $ref: '#/components/schemas/ReplaceOptions'
        Name:
          type: string
        ArtifactID:
          type: integer
        ViewFieldID:
          type: integer
        Guid:
          type:
          - string
          - 'null'
    MassReplaceAsync_RequestBody:
      title: MassReplaceAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/MassReplaceRequest'
    MassReplaceRequest:
      title: MassReplaceRequest
      type: object
      properties:
        Type:
          enum:
          - Edit
          - Delete
          - Replace
          - Move
          - Copy
          - Report
          - SendToCaseMap
          - Tif
          - Print
          - Export
          - Cluster
          - Tally
          - SaveAsList
          - Custom
          type: string
        Fields:
          type: array
          items:
            $ref: '#/components/schemas/ReplaceField'
        ArtifactTypeID:
          type: integer
        Query:
          $ref: '#/components/schemas/QueryRequest'
    MassOperationProcessState:
      title: MassOperationProcessState
      type: object
      properties:
        ProcessIdentifier:
          type: string
        Name:
          type: string
        State:
          enum:
          - Idle
          - Running
          - Completed
          - HandleException
          - UnhandledException
          - RunningWarning
          - Canceled
          - Cancelling
          - CompletedWithError
          - NotStarted
          - Pausing
          - Paused
          type: string
        Status:
          type: string
        IsCanceled:
          type: boolean
        TotalOperations:
          type: integer
        OperationsCompleted:
          type: integer
        ExceptionMessage:
          type: string
        CancelReason:
          enum:
          - UserInitiated
          - AgentShutdown
          - Unknown
          - JobOrphaned
          - NotApplicable
          type: string
    InitializeMassOperationRequest:
      title: InitializeMassOperationRequest
      type: object
      properties:
        ArtifactTypeID:
          type: integer
        Query:
          $ref: '#/components/schemas/QueryRequest'
        DatabaseTokenRequired:
          type: boolean
    EditField:
      title: EditField
      type: object
      properties:
        Value:
          $ref: '#/components/schemas/Object'
        Name:
          type: string
        ArtifactID:
          type: integer
        ViewFieldID:
          type: integer
        Guid:
          type:
          - string
          - 'null'
    ReplaceAction:
      title: ReplaceAction
      type: object
      properties:
        Options:
          enum:
          - Text
          - Field
          type: string
        ReplacementText:
          type: string
        ReplacementField:
          $ref: '#/components/schemas/FieldRef'
    Object:
      title: Object
      type: object
    PublishMassMoveJobRequestAsync_RequestBody:
      title: PublishMassMoveJobRequestAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/MassMoveJobRequest'
    TallySumAverageAsync_RequestBody:
      title: TallySumAverageAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/MassTallySumAverageRequest'
    TallySumAverageResult:
      title: TallySumAverageResult
      type: object
      properties:
        Value:
          type: string
        Count:
          type: number
    MassDeleteStartupResult:
      title: MassDeleteStartupResult
      type: object
      properties:
        IsCascadeDeletable:
          type: boolean
        HasDependencies:
          type: boolean
        HasDeleteObjectDependenciesPermission:
          type: boolean
        SnapshotAuditSettingFromObjectType:
          type: boolean
        PPDEventHandlerToggleValue:
          type: boolean
        SnapshotAuditOverrideOptionToggleValue:
          type: boolean
    ReplaceOptions:
      title: ReplaceOptions
      type: object
      properties:
        Options:
          enum:
          - ReplaceEntireField
          - AppendToEnd
          - InsertAtBeginning
          - SearchFor
          type: string
        Value:
          type: string
    SearchProvider:
      title: SearchProvider
      type: object
      properties:
        SearchIndex:
          $ref: '#/components/schemas/SearchIndexRef'
        Input:
          type: string
    MassCopyRequest:
      title: MassCopyRequest
      type: object
      properties:
        ParentArtifactID:
          type: integer
        Type:
          enum:
          - Edit
          - Delete
          - Replace
          - Move
          - Copy
          - Report
          - SendToCaseMap
          - Tif
          - Print
          - Export
          - Cluster
          - Tally
          - SaveAsList
          - Custom
          type: string
        ArtifactTypeID:
          type: integer
        Query:
          $ref: '#/components/schemas/QueryRequest'
    PublishMassTallySumAverageJobRequestAsync_RequestBody:
      title: PublishMassTallySumAverageJobRequestAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/MassTallySumAverageJobRequest'
    PublishMassReplaceJobRequestAsync_RequestBody:
      title: PublishMassReplaceJobRequestAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/MassReplaceJobRequest'
    MassReplaceJobRequest:
      title: MassReplaceJobRequest
      type: object
      properties:
        Type:
          enum:
          - Edit
          - Delete
          - Replace
          - Move
          - Copy
          - Report
          - SendToCaseMap
          - Tif
          - Print
          - Export
          - Cluster
          - Tally
          - SaveAsList
          - Custom
          type: string
        Fields:
          type: array
          items:
            $ref: '#/components/schemas/ReplaceField'
        ArtifactTypeID:
          type: integer
        MassProcessID:
          type: integer
    PublishMassCopyJobRequestAsync_RequestBody:
      title: PublishMassCopyJobRequestAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/MassCopyJobRequest'
    MassSaveAsListJobRequest:
      title: MassSaveAsListJobRequest
      type: object
      properties:
        Notes:
          type: string
        ListName:
          type: string
        ExistingListArtifactID:
          type: integer
        Options:
          enum:
          - CreateNewList
          - ReplaceExistingList
          type: string
        Type:
          enum:
          - Edit
          - Delete
          - Replace
          - Move
          - Copy
          - Report
          - SendToCaseMap
          - Tif
          - Print
          - Export
          - Cluster
          - Tally
          - SaveAsList
          - Custom
          type: string
        ArtifactTypeID:
          type: integer
        MassProcessID:
          type: integer
    MassDeleteJobRequest:
      title: MassDeleteJobRequest
      type: object
      properties:
        DocumentDeleteOptions:
          enum:
          - DeleteDocumentAndAllAssociatedFiles
          - DeleteOnlyImages
          - DeleteOnlyNatives
          - DeleteOnlyNativesAndImages
          type: string
        ForceDelete:
          type: boolean
        Type:
          enum:
          - Edit
          - Delete
          - Replace
          - Move
          - Copy
          - Report
          - SendToCaseMap
          - Tif
          - Print
          - Export
          - Cluster
          - Tally
          - SaveAsList
          - Custom
          type: string
        PromoteDuplicatesFromOtherSources:
          type: boolean
        SnapshotAuditSelectionForOperation:
          type: boolean
        ArtifactTypeID:
          type: integer
        MassProcessID:
          type: integer
    Sort:
      title: Sort
      type: object
      properties:
        FieldIdentifier:
          $ref: '#/components/schemas/FieldRef'
        Order:
          type: integer
        Direction:
          enum:
          - Ascending
          - Descending
          type: string
    ObjectTypeRef:
      title: ObjectTypeRef
      type: object
      properties:
        ArtifactID:
          type: integer
        Name:
          type: string
        Guid:
          type:
          - string
          - 'null'
        ArtifactTypeID:
          type: integer
    InitializeMassOperationResult:
      title: InitializeMassOperationResult
      type: object
      properties:
        ProcessID:
          type: integer
        ObjectCount:
          type: integer
        DatabaseToken:
          type: string
    SampleParameters:
      title: SampleParameters
      type: object
      properties:
        ExistingToken:
          type:
          - string
          - 'null'
        MarginOfError:
          type: number
        ConfidenceLevel:
          type: number
        FixedSampleSize:
          type: integer
        SamplingPercentage:
          type: number
    MassExportToFileRequest:
      title: MassExportToFileRequest
      type: object
      properties:
        Type:
          enum:
          - Edit
          - Delete
          - Replace
          - Move
          - Copy
          - Report
          - SendToCaseMap
          - Tif
          - Print
          - Export
          - Cluster
          - Tally
          - SaveAsList
          - Custom
          type: string
        ViewID:
          type: integer
        ViewFields:
          type: array
          items:
            $ref: '#/components/schemas/FieldRef'
        EscapeFormulas:
          type: boolean
        HasRank:
          type: boolean
        SearchProviderArtifactID:
          type:
          - integer
          - 'null'
        ExportFileFormat:
          enum:
          - Csv
          - Dat
          - Xls
          type: string
        ExportEncodingType:
          enum:
          - JapaneseShiftJIS
          - ChineseGB2312
          - Korean
          - ChineseTraditional
          - Unicode
          - UnicodeBigEndian
          - WesternEuropean
          - JapaneseJIS
          - ChineseGB18030
          - UnicodeUTF8
          type: string
        ArtifactTypeID:
          type: integer
        Query:
          $ref: '#/components/schemas/QueryRequest'
    MassOperationResult:
      title: MassOperationResult
      type: object
      properties:
        ProcessID:
          type: integer
    QueryRequest:
      title: QueryRequest
      type: object
      prop

# --- truncated at 32 KB (45 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/relativity/refs/heads/main/openapi/relativity-relativity-mass-operation-module-v2-api-openapi.yml