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

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

OpenAPI Specification

relativity-relativity-mass-operation-module-v2-api-openapi.yml Raw ↑ 
openapi: 3.0.1
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:
    Object:
      title: Object
      type: object
    ReplaceAction:
      title: ReplaceAction
      type: object
      properties:
        Options:
          enum:
          - Text
          - Field
          type: string
        ReplacementText:
          type: string
        ReplacementField:
          $ref: '#/components/schemas/FieldRef'
    ObjectTypeRef:
      title: ObjectTypeRef
      type: object
      properties:
        ArtifactID:
          type: integer
        Name:
          type: string
        Guid:
          type: string
          nullable: true
        ArtifactTypeID:
          type: integer
    PublishMassEditJobRequestAsync_RequestBody:
      title: PublishMassEditJobRequestAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/MassEditJobRequest'
    MassCopyAsync_RequestBody:
      title: MassCopyAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/MassCopyRequest'
    MassExportToFileJobRequest:
      title: MassExportToFileJobRequest
      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
          nullable: true
        ExportFileFormat:
          enum:
          - Csv
          - Dat
          - Xls
          type: string
        ExportEncodingType:
          enum:
          - JapaneseShiftJIS
          - ChineseGB2312
          - Korean
          - ChineseTraditional
          - Unicode
          - UnicodeBigEndian
          - WesternEuropean
          - JapaneseJIS
          - ChineseGB18030
          - UnicodeUTF8
          type: string
        ArtifactTypeID:
          type: integer
        MassProcessID:
          type: integer
    EditField:
      title: EditField
      type: object
      properties:
        Value:
          $ref: '#/components/schemas/Object'
        Name:
          type: string
        ArtifactID:
          type: integer
        ViewFieldID:
          type: integer
        Guid:
          type: string
          nullable: true
    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
    FieldRef:
      title: FieldRef
      type: object
      properties:
        Name:
          type: string
        ArtifactID:
          type: integer
        ViewFieldID:
          type: integer
        Guid:
          type: string
          nullable: true
    MassMoveJobRequest:
      title: MassMoveJobRequest
      type: object
      properties:
        DestinationFolderArtifactID:
          type: integer
        Type:
          enum:
          - Edit
          - Delete
          - Replace
          - Move
          - Copy
          - Report
          - SendToCaseMap
          - Tif
          - Print
          - Export
          - Cluster
          - Tally
          - SaveAsList
          - Custom
          type: string
        ArtifactTypeID:
          type: integer
        MassProcessID:
          type: integer
    MassMoveAsync_RequestBody:
      title: MassMoveAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/MassMoveRequest'
    MassMoveRequest:
      title: MassMoveRequest
      type: object
      properties:
        DestinationFolderArtifactID:
          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'
    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'
    PublishMassReplaceJobRequestAsync_RequestBody:
      title: PublishMassReplaceJobRequestAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/MassReplaceJobRequest'
    InitializeMassOperationResult:
      title: InitializeMassOperationResult
      type: object
      properties:
        ProcessID:
          type: integer
        ObjectCount:
          type: integer
        DatabaseToken:
          type: string
    PublishMassTallySumAverageJobRequestAsync_RequestBody:
      title: PublishMassTallySumAverageJobRequestAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/MassTallySumAverageJobRequest'
    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
    MinPerResourcePoolResult:
      title: MinPerResourcePoolResult
      type: object
      properties:
        AgentName:
          type: string
        ResourcePoolName:
          type: string
    MassEditRequest:
      title: MassEditRequest
      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
        Query:
          $ref: '#/components/schemas/QueryRequest'
    SampleParameters:
      title: SampleParameters
      type: object
      properties:
        ExistingToken:
          type: string
          nullable: true
        MarginOfError:
          type: number
        ConfidenceLevel:
          type: number
        FixedSampleSize:
          type: integer
        SamplingPercentage:
          type: number
    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
    InitializeMassOperationAsync_RequestBody:
      title: InitializeMassOperationAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/InitializeMassOperationRequest'
    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'
    MassOperationProcessStateExtendedResult:
      title: MassOperationProcessStateExtendedResult
      type: object
      properties:
        WorkspaceId:
          type: integer
        WorkspaceName:
          type: string
        MassOperationType:
          type: string
        Status:
          type: string
        StatusMessage:
          type: string
        ProcessIdentifier:
          type: string
        StartedDateTime:
          type: string
          format: date-time
        ArtifactType:
          type: string
        ArtifactCount:
          type: integer
        MassOpsProgress:
          type: number
        MassOperationFriendlyName:
          type: string
        CancelReason:
          enum:
          - UserInitiated
          - AgentShutdown
          - Unknown
          - JobOrphaned
          - NotApplicable
          type: string
    MassTallySumAverageJobRequest:
      title: MassTallySumAverageJobRequest
      type: object
      properties:
        Field:
          $ref: '#/components/schemas/FieldRef'
        Operation:
          enum:
          - Tally
          - Sum
          - Average
          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
    PublishMassCopyJobRequestAsync_RequestBody:
      title: PublishMassCopyJobRequestAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/MassCopyJobRequest'
    PublishMassExportToFileJobRequestAsync_RequestBody:
      title: PublishMassExportToFileJobRequestAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/MassExportToFileJobRequest'
    MassTallySumAverageRequest:
      title: MassTallySumAverageRequest
      type: object
      properties:
        Field:
          $ref: '#/components/schemas/FieldRef'
        Operation:
          enum:
          - Tally
          - Sum
          - Average
          type: string
        Type:
          enum:
          - Edit
          - Delete
          - Replace
          - Move
          - Copy
          - Report
          - SendToCaseMap
          - Tif
          - Print
          - Export
          - Cluster
          - Tally
          - SaveAsList
          - Custom
          type: string
        ArtifactTypeID:
          type: integer
        Query:
       

# --- 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