openapi: 3.0.1
info:
  title: Analytics.Conceptual.Service.Interfaces.Public.V1 AnnotationService Processing 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: Processing Module v1
paths:
  /relativity-processing/v1/file-deletion/get-processed-files-to-delete:
    get:
      tags:
      - Processing Module v1
      description: '[Public] IFileDeletionManager - '
      operationId: Relativity.Processing.V1.Services.IFileDeletionManager.ProcessFilesToDeleteAsync
      parameters:
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProcessFilesToDeleteAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetProcessedFilesToDeleteResponse'
  /relativity-processing/v1/file-deletion/confirm-processed-files-deletion:
    post:
      tags:
      - Processing Module v1
      description: '[Public] IFileDeletionManager - '
      operationId: Relativity.Processing.V1.Services.IFileDeletionManager.ConfirmProcessedFilesDeletionAsync
      parameters:
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfirmProcessedFilesDeletionAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
  /relativity-processing/v1/workspaces/{workspaceID}/field-mappings:
    put:
      tags:
      - Processing Module v1
      description: '[Public] IFieldMappingManager - '
      operationId: Relativity.Processing.V1.Services.IFieldMappingManager.UpdateExternalMappingAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateExternalMappingAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
  /relativity-processing/v1/workspaces/{workspaceID}/field-mappings/auto/guids:
    get:
      tags:
      - Processing Module v1
      description: '[Public] IFieldMappingManager - '
      operationId: Relativity.Processing.V1.Services.IFieldMappingManager.GetAutoMappedFieldGuidsAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
  /relativity-processing/v1/workspaces/{workspaceID}/field-mappings/available:
    get:
      tags:
      - Processing Module v1
      description: '[Public] IFieldMappingManager - '
      operationId: Relativity.Processing.V1.Services.IFieldMappingManager.IsFieldMappingAvailableAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: boolean
  /relativity-processing/v1/workspaces/{workspaceID}/field-mappings/invariant:
    get:
      tags:
      - Processing Module v1
      description: '[Public] IFieldMappingManager - '
      operationId: Relativity.Processing.V1.Services.IFieldMappingManager.GetInvariantFieldsAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetInvariantFieldsAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MappableSourceField'
  /relativity-processing/v1/workspaces/{workspaceID}/field-mappings/pages:
    post:
      tags:
      - Processing Module v1
      description: '[Public] IFieldMappingManager - '
      operationId: Relativity.Processing.V1.Services.IFieldMappingManager.GetInvariantFieldsPaginatedAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetInvariantFieldsPaginatedAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldMappingResponse'
  /relativity-processing/v1/workspaces/{workspaceID}/field-mappings/metadata-fields:
    post:
      tags:
      - Processing Module v1
      description: '[Public] IFieldMappingManager - '
      operationId: Relativity.Processing.V1.Services.IFieldMappingManager.GetMetadataFieldsAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetMetadataFieldsAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldMappingResponse'
  /relativity-processing/v1/workspaces/{workspaceID}/field-mappings/other-fields:
    post:
      tags:
      - Processing Module v1
      description: '[Public] IFieldMappingManager - '
      operationId: Relativity.Processing.V1.Services.IFieldMappingManager.GetOtherFieldsAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetOtherFieldsAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldMappingResponse'
  /relativity-processing/v1/workspaces/{workspaceID}/field-mappings/source-field:
    get:
      tags:
      - Processing Module v1
      description: '[Public] IFieldMappingManager - '
      operationId: Relativity.Processing.V1.Services.IFieldMappingManager.GetMappableSourceFieldAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetMappableSourceFieldAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MappableSourceField'
  /relativity-processing/v1/workspaces/{workspaceID}/field-mappings/external:
    get:
      tags:
      - Processing Module v1
      description: '[Public] IFieldMappingManager - '
      operationId: Relativity.Processing.V1.Services.IFieldMappingManager.ReadExternalMappingAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReadExternalMappingAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalMapping'
  /relativity-processing/v1/workspaces/{workspaceID}/data-sources/{dataSourceID}/field-mappings/relativity:
    post:
      tags:
      - Processing Module v1
      description: '[Public] IFieldMappingManager - '
      operationId: Relativity.Processing.V1.Services.IFieldMappingManager.GetAllMappedFieldsAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dataSourceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAllMappedFieldsAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ExternalMapping'
  /relativity-processing/v1/workspaces/{workspaceID}/field-mappings/catalog-fields:
    get:
      tags:
      - Processing Module v1
      description: '[Public] IFieldMappingManager - '
      operationId: Relativity.Processing.V1.Services.IFieldMappingManager.GetCatalogFieldsAsync
      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/CatalogField'
  /relativity-processing/v1/workspaces/{workspaceID}/field-mappings/invariant-catalog-field-mapping:
    get:
      tags:
      - Processing Module v1
      description: '[Public] IFieldMappingManager - '
      operationId: Relativity.Processing.V1.Services.IFieldMappingManager.GetInvariantFieldCatalogMapping
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
                format: Guid
  /relativity-processing/v1/workspaces/{workspaceID}/field-mappings/get-mappable-fields:
    get:
      tags:
      - Processing Module v1
      description: '[Public] IFieldMappingManager - '
      operationId: Relativity.Processing.V1.Services.IFieldMappingManager.GetNewMappableFieldsNonPaginatedAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetNewMappableFieldsNonPaginatedAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MappableFieldsResponse'
  /relativity-processing/v1/workspaces/{workspaceID}/field-mappings/validate-type:
    get:
      tags:
      - Processing Module v1
      description: '[Public] IFieldMappingManager - '
      operationId: Relativity.Processing.V1.Services.IFieldMappingManager.ValidateFieldTypeMappingAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateFieldTypeMappingAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: boolean
  /relativity-processing/v1/workspaces/{workspaceID}/field-mappings/validate-length:
    get:
      tags:
      - Processing Module v1
      description: '[Public] IFieldMappingManager - '
      operationId: Relativity.Processing.V1.Services.IFieldMappingManager.ValidateFieldLengthAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateFieldLengthAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: boolean
  /relativity-processing/v1/workspaces/{workspaceID}/field-mappings/validate-fields:
    put:
      tags:
      - Processing Module v1
      description: '[Public] IFieldMappingManager - '
      operationId: Relativity.Processing.V1.Services.IFieldMappingManager.ValidateFieldObjectsAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateFieldObjectsAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: boolean
  /relativity-processing/v1/workspaces/{workspaceID}/documents/{fileID}/metadata:
    get:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingDocumentManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingDocumentManager.GetDocumentMetadataAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/fileID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessingMetadataResponse'
  /relativity-processing/v1/workspaces/{workspaceID}/documents/{fileID}/errors:
    get:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingDocumentManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingDocumentManager.GetDocumentErrorHistoryAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/fileID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetDocumentErrorHistoryAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessingDocumentErrorHistoryResponse'
  /relativity-processing/v1/workspaces/{workspaceID}/documents/retry:
    post:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingDocumentManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingDocumentManager.RetryDeleteDocumentAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetryDeleteDocumentAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
  /relativity-processing/v1/workspaces/{workspaceID}/documents/retry-errors:
    post:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingDocumentManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingDocumentManager.RetryDocumentErrorsAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetryDocumentErrorsAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
  /relativity-processing/v1/workspaces/{workspaceID}/documents/publish:
    post:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingDocumentManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingDocumentManager.PublishDocumentsAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublishDocumentsAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
  /relativity-processing/v1/workspaces/{workspaceID}/documents/get-publish-job-errors:
    post:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingDocumentManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingDocumentManager.GetPublishJobErrorsAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetPublishJobErrorsAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublishJobErrorInfoResponse'
  /relativity-processing/v1/workspaces/{workspaceID}/documents/count:
    post:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingDocumentManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingDocumentManager.RetrievePublishableDocumentCountAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetrievePublishableDocumentCountAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: integer
  /relativity-processing/v1/workspaces/{workspaceID}/filters:
    post:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingFilterManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingFilterManager.CreateExpressionFilterAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateExpressionFilterAsync_RequestBody'
        required: true
      responses:
        '201':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessingFilter'
    get:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingFilterManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingFilterManager.GetFiltersAsync
      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/ProcessingFilter'
  /relativity-processing/v1/workspaces/{workspaceID}/filters/{filterID}/apply:
    post:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingFilterManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingFilterManager.ApplyFilterAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/filterID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplyFilterAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: integer
  /relativity-processing/v1/workspaces/{workspaceID}/filters/results/{filterID}:
    get:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingFilterManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingFilterManager.GetFilterResultAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/filterID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetFilterResultAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessingFilterData'
  /relativity-processing/v1/workspaces/{workspaceID}/filters/data-sources/{dataSourceID}/filters:
    get:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingFilterManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingFilterManager.GetFiltersByDataSourceAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dataSourceID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProcessingFilter'
  /relativity-processing/v1/workspaces/{workspaceID}/filters/{filterID}:
    put:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingFilterManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingFilterManager.UpdateExpressionFilterAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/filterID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateExpressionFilterAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessingFilter'
    delete:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingFilterManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingFilterManager.DeleteFilterAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/filterID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
  /relativity-processing/v1/workspaces/{workspaceID}/filters/documents:
    post:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingFilterManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingFilterManager.GetDiscoveredDocumentsAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetDiscoveredDocumentsAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessingFilterData'
  /relativity-processing/v1/workspaces/{workspaceID}/filters/document-ids:
    post:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingFilterManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingFilterManager.GetDiscoveredDocumentIdsAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetDiscoveredDocumentIdsAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessingFileIdResults'
  /relativity-processing/v1/workspaces/{workspaceID}/filters/csvs:
    post:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingFilterManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingFilterManager.PrepareDiscoveredDocumentListAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PrepareDiscoveredDocumentListAsync_RequestBody'
        required: true
      responses:
        '201':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrepareDiscoveredDocumentListResponse'
  /relativity-processing/v1/workspaces/{workspaceID}/filters/pivot-discovered-documents:
    post:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingFilterManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingFilterManager.PivotOnDiscoveredDocumentsAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PivotOnDiscoveredDocumentsAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GetDiscoveredDocumentsWithPivotOnResponse'
  /relativity-processing/v1/workspaces/{workspaceID}/filters/csvs/{requestGuid}:
    get:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingFilterManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingFilterManager.DownloadDiscoveredDocumentListAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/requestGuid'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IKeplerStream'
  /relativity-processing/v1/workspaces/{workspaceID}/custodians/{custodianID}:
    get:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingCustodianManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingCustodianManager.ReadAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/custodianID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessingCustodian'
    put:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingCustodianManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingCustodianManager.UpdateAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/custodianID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: integer
  /relativity-processing/v1/workspaces/{workspaceID}/custodians:
    post:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingCustodianManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingCustodianManager.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:
        '201':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: integer
  /relativity-processing/v1/workspaces/{workspaceID}/data-sources/{dataSourceID}:
    get:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingDataSourceManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingDataSourceManager.ReadAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dataSourceID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessingDataSource'
    put:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingDataSourceManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingDataSourceManager.UpdateAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/dataSourceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
  /relativity-processing/v1/workspaces/{workspaceID}/data-sources:
    post:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingDataSourceManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingDataSourceManager.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:
        '201':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: integer
  /relativity-processing/v1/workspaces/{workspaceID}/data-sources/{processingDataSourceID}/delete-validation:
    get:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingDataSourceManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingDataSourceManager.ValidateDeleteAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/processingDataSourceID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSourceValidateDeleteResponse'
  /relativity-processing/v1/workspaces/{workspaceID}/data-sources/source-location-paths:
    get:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingDataSourceManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingDataSourceManager.RetrieveProcessingDataSourceInputPathsForWorkspaceAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
  /relativity-processing/v1/workspaces/{workspaceID}/data-sources/profile-presets/{profileId}:
    get:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingDataSourceManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingDataSourceManager.RetrieveDefaultsFromProcessingProfile
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/profileId'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultProcessingDataSourceOptionsResponse'
  /relativity-processing/v1/workspaces/{workspaceID}/processing-jobs/{processingSetID}/cancel:
    post:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingJobManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingJobManager.SubmitCancelJobAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/processingSetID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '201':
          description: Successful Operation
  /relativity-processing/v1/workspaces/{workspaceID}/processing-jobs/{processingSetID}/discover:
    post:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingJobManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingJobManager.SubmitDiscoveryJobsAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/processingSetID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '201':
          description: Successful Operation
  /relativity-processing/v1/workspaces/{workspaceID}/processing-jobs/{processingSetID}/inventory:
    post:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingJobManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingJobManager.SubmitInventoryJobsAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/processingSetID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '201':
          description: Successful Operation
  /relativity-processing/v1/workspaces/{workspaceID}/processing-jobs/{processingSetID}/publish:
    post:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingJobManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingJobManager.SubmitPublishJobsAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/processingSetID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '201':
          description: Successful Operation
  /relativity-processing/v1/workspaces/{workspaceID}/processing-jobs/{processingSetID}/retry-errors:
    post:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingJobManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingJobManager.SubmitRetryErrorsJobsAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/processingSetID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '201':
          description: Successful Operation
  /relativity-processing/v1/workspaces/{workspaceID}/processing-sets/{processingSetID}:
    get:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingSetManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingSetManager.ReadAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/processingSetID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessingSet'
    put:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingSetManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingSetManager.UpdateAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/processingSetID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAsync_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: integer
  /relativity-processing/v1/workspaces/{workspaceID}/processing-sets:
    post:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingSetManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingSetManager.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:
        '201':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: integer
  /relativity-processing/v1/workspaces/{workspaceID}/processing-sets/documents:
    get:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingSetManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingSetManager.GetDocumentAggregates
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/x-csrf-header'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetDocumentAggregates_RequestBody'
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessingSetDocumentInfoSummary'
  /relativity-processing/v1/workspaces/{workspaceID}/processing-sets/{processingSetID}/summary:
    get:
      tags:
      - Processing Module v1
      description: '[Public] IProcessingSetManager - '
      operationId: Relativity.Processing.V1.Services.IProcessingSetManager.GetSummaryDataAsync
      parameters:
      - $ref: '#/components/parameters/workspaceID'
      - $ref: '#/components/parameters/processingSetID'
      - $ref: '#/components/parameters/x-csrf-header'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProcessingSetSummaryData'
components:
  schemas:
    PivotOnOption:
      title: PivotOnOption
      type: object
      properties:
        GroupByProperty:
          enum:
          - ContainerID
          - ProcessingFileId
          - FileSize
          - ParentDocumentId
          - DiscoverGroupId
          - ContainerName
          - ContainerExtension
          - IngestionError
          - ExtractedTextLocation
          - FileName
          - FileExtension
          - FileType
          - FolderPath
          - ImportSource
          - LogicalPath
          - MD5Hash
          - DocumentErrorMessage
          - OriginalPath
          - SHA1Hash
          - SHA256Hash
          - TextExtractionMethod
          - VirtualPath
          - IsContainer
          - IsEmbedded
          - OfficeEmbeddedItems
          - Unprocessable
          - IsPublished
          - CustodianArtifactId
          - DataSourceArtifactId
          - CustodianName
          - DataSourceName
          - IsDeleted
          - ErrorMessage
          - SenderDomain
          - SortDate
          - ErrorCategory
          - ErrorPhase
          - ErrorStatus
          - DedupeStatus
          - StorageId
          - Severity
          - ProcessingDupeHash
          type: string
        GroupByOrdering:
          enum:
          - Descending
          - Ascending
          type: string
        GroupByCount:
          type: integer
        PivotOnProperty:
          enum:
          - ContainerID
          - ProcessingFileId
          - FileSize
          - ParentDocumentId
          - DiscoverGroupId
          - ContainerName
          - ContainerExtension
          - IngestionError
          - ExtractedTextLocation
          - FileName
          - FileExtension
          - FileType
          - FolderPath
          - ImportSource
          - LogicalPath
          - MD5Hash
          - DocumentErrorMessage
          - OriginalPath
          - SHA1Hash
          - SHA256Hash
          - TextExtractionMethod
          - VirtualPath
          - IsContainer
          - IsEmbedded
          - OfficeEmbeddedItems
          - Unprocessable
          - IsPublished
          - CustodianArtifactId
          - DataSourceArtifactId
          - CustodianName
          - DataSourceName
          - IsDeleted
          - ErrorMessage
          - SenderDomain
          - SortDate
          - ErrorCategory
          - ErrorPhase
          - ErrorStatus
          - DedupeStatus
          - StorageId
          - Severity
          - ProcessingDupeHash
          type: string
          nullable: true
        PivotOnOrdering:
          enum:
          - Descending
          - Ascending
          type: string
        PivotOnCount:
          type: integer
    ProcessingSetRef:
      title: ProcessingSetRef
      type: object
      properties:
        ProcessingSetID:
          type: integer
        Name:
          type: string
    ReadExternalMappingAsync_RequestBody:
      title: ReadExternalMappingAsync_RequestBody
      type: object
      properties:
        fieldID:
          type: integer
        fieldSource:
          type: string
    ProcessingFilterResult:
      title: ProcessingFilterResult
      type: object
      properties:
        ContainerExtension:
          type: string
        ContainerID:
          type: integer
        ContainerName:
          type: string
        CustodianArtifactId:
          type: integer
        CustodianName:
          type: string
        DataSourceArtifactId:
          type: integer
        DataSourceName:
          type: string
        DiscoverGroupId:
          type: integer
        ErrorMessage:
          type: string
        ErrorCategory:
          type: string
        ErrorPhase:
          type: string
        ExtractedTextLocation:
          type: string
        FileExtension:
          type: string
        FileName:
          type: string
        FileSize:
          type: integer
        FileType:
          type: string
        FolderPath:
          type: string
        ImportSource:
          type: string
        IsContainer:
          type: boolean
        IsDeleted:
          type: boolean
        IsEmbedded:
          type: boolean
        IsPublished:
          type: boolean
        LogicalPath:
          type: string
        MD5Hash:
          type: string
        OfficeEmbeddedItems:
          type: boolean
        OriginalPath:
          type: string
        ParentDocumentId:
          type: integer
        ProcessingFileId:
          type: integer
        SHA1Hash:
          type: string
        SHA256Hash:
          type: string
        TextExtractionMethod:
          type: string
        Unprocessable:
          type: boolean
        VirtualPath:
          type: string
        SenderDomain:
          type: string
        SortDate:
          type: string
          format: date-time
          nullable: true
        ErrorStatus:
          type: string
        DedupeStatus:
          type: string
        StorageId:
          type: string
        Severity:
          type: string
        ProcessingDupeHash:
          type: string
    ApplyFilterAsync_RequestBody:
      title: ApplyFilterAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/ApplyProcessingFilterRequest'
    ProcessingCustodian:
      title: ProcessingCustodian
      type: object
      properties:
        Classification:
          type: array
          items:
            type: integer
        DocumentNumberingPrefix:
          type: string
        FirstName:
          type: string
        LastName:
          type: string
        Notes:
          type: string
        CustodianType:
          enum:
          - NotSet
          - Person
          - Other
          - Organization
          type: string
        CustodianID:
          type: integer
        Name:
          type: string
    CreateProcessingExpressionFilterRequest:
      title: CreateProcessingExpressionFilterRequest
      type: object
      properties:
        FilterName:
          type: string
        DataSourceIDs:
          type: array
          items:
            type: integer
        Expression:
          type: string
        IncludeFamily:
          type: boolean
    ProcessingSet:
      title: ProcessingSet
      type: object
      properties:
        EmailNotificationRecipients:
          type: array
          items:
            type: string
        Profile:
          $ref: '#/components/schemas/ProcessingProfileRef'
        ProcessingSetID:
          type: integer
        Name:
          type: string
    PrepareDiscoveredDocumentListAsync_RequestBody:
      title: PrepareDiscoveredDocumentListAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/GetDiscoveredDocumentListRequest'
    GetMetadataFieldsAsync_RequestBody:
      title: GetMetadataFieldsAsync_RequestBody
      type: object
      properties:
        skip:
          type: integer
        top:
          type: integer
        fieldMappingRequest:
          $ref: '#/components/schemas/FieldMappingRequest'
    UpdateAsync_RequestBody:
      title: UpdateAsync_RequestBody
      type: object
      properties:
        custodian:
          $ref: '#/components/schemas/ProcessingCustodian'
    PrepareDiscoveredDocumentListResponse:
      title: PrepareDiscoveredDocumentListResponse
      type: object
      properties:
        Guid:
          type: string
    CreateAsync_RequestBody:
      title: CreateAsync_RequestBody
      type: object
      properties:
        custodian:
          $ref: '#/components/schemas/ProcessingCustodian'
    GetNewMappableFieldsNonPaginatedAsync_RequestBody:
      title: GetNewMappableFieldsNonPaginatedAsync_RequestBody
      type: object
      properties:
        metadataFieldCount:
          type: integer
    GetDocumentAggregates_RequestBody:
      title: GetDocumentAggregates_RequestBody
      type: object
      properties:
        skip:
          type: integer
        top:
          type: integer
        sortColumnName:
          type: string
        sortDescending:
          type: boolean
    ValidateFieldTypeMappingAsync_RequestBody:
      title: ValidateFieldTypeMappingAsync_RequestBody
      type: object
      properties:
        fieldDataTypeId:
          type: integer
        sourceType:
          type: string
    PublishJobErrorInfoResponse:
      title: PublishJobErrorInfoResponse
      type: object
      properties:
        ErroredJobCount:
          type: integer
        ErroredFileCount:
          type: integer
        GroupIdsWithJobErrors:
          type: array
          items:
            type: integer
        ErrorArtifactIds:
          type: array
          items:
            type: integer
        GroupIdsCheckedCount:
          type: integer
    ProcessingMetadataResponse:
      title: ProcessingMetadataResponse
      type: object
      properties:
        ProcessingFileID:
          type: integer
        WorkspaceArtifactID:
          type: integer
        MetadataJson:
          type: string
        Errors:
          type: array
          items:
            type: string
    FieldSortingOption:
      title: FieldSortingOption
      type: object
      properties:
        FieldName:
          enum:
          - Name
          - DataType
          - Description
          - RelativityFieldName
          type: string
        SortingDirection:
          enum:
          - Asc
          - Desc
          type: string
    GetDiscoveredDocumentsWithPivotOnRequest:
      title: GetDiscoveredDocumentsWithPivotOnRequest
      type: object
      properties:
        Expression:
          type: string
        PivotOnOption:
          $ref: '#/components/schemas/PivotOnOption'
    GetFilterResultAsync_RequestBody:
      title: GetFilterResultAsync_RequestBody
      type: object
      properties:
        skip:
          type: integer
        top:
          type: integer
    IKeplerStream:
      title: IKeplerStream
      type: object
      properties:
        ContentType:
          type: string
        ContentDisposition:
          type: string
        CacheControl:
          type: string
        StatusCode:
          enum:
          - Continue
          - SwitchingProtocols
          - OK
          - Created
          - Accepted
          - NonAuthoritativeInformation
          - NoContent
          - ResetContent
          - PartialContent
          - MultipleChoices
          - Ambiguous
          - MovedPermanently
          - Moved
          - Found
          - Redirect
          - SeeOther
          - RedirectMethod
          - NotModified
          - UseProxy
          - Unused
          - TemporaryRedirect
          - RedirectKeepVerb
          - BadRequest
          - Unauthorized
          - PaymentRequired
          - Forbidden
          - NotFound
          - MethodNotAllowed
          - NotAcceptable
          - ProxyAuthenticationRequired
          - RequestTimeout
          - Conflict
          - Gone
          - LengthRequired
          - PreconditionFailed
          - RequestEntityTooLarge
          - RequestUriTooLong
          - UnsupportedMediaType
          - RequestedRangeNotSatisfiable
          - ExpectationFailed
          - UpgradeRequired
          - InternalServerError
          - NotImplemented
          - BadGateway
          - ServiceUnavailable
          - GatewayTimeout
          - HttpVersionNotSupported
          type: string
          nullable: true
        Headers:
          type: array
          items:
            type: string
            format: NameValueCollection
    GetMappableSourceFieldAsync_RequestBody:
      title: GetMappableSourceFieldAsync_RequestBody
      type: object
      properties:
        sourceName:
          type: string
    RetryDeleteDocumentAsync_RequestBody:
      title: RetryDeleteDocumentAsync_RequestBody
      type: object
      properties:
        documentsRequest:
          $ref: '#/components/schemas/ProcessingDocumentsRequest'
    GetDocumentErrorHistoryAsync_RequestBody:
      title: GetDocumentErrorHistoryAsync_RequestBody
      type: object
      properties:
        skip:
          type: integer
        top:
          type: integer
    ProcessingDataSource:
      title: ProcessingDataSource
      type: object
      properties:
        Custodian:
          type: integer
        DestinationFolder:
          type: integer
        DocumentNumberingPrefix:
          type: string
        InputPath:
          type: string
        IsNew:
          type: boolean
        OcrLanguages:
          type: array
          items:
            enum:
            - Afrikaans
            - Albanian
            - Arabic
            - Aymara
            - Basque
            - Bemba
            - Blackfoot
            - Breton
            - Bugotu
            - BulgarianCyrillic
            - ByelorussianCyrillic
            - Catalan
            - Chamorro
            - Chechen
            - ChuanaOrTswana
            - Corsican
            - Croatian
            - Crow
            - Czech
            - Danish
            - Dutch
            - English
            - Eskimo
            - Esperanto
            - Estonian
            - Faroese
            - Fijian
            - Finnish
            - French
            - Frisian
            - Friulian
            - GaelicIrish
            - GaelicScottish
            - Galician
            - GandaOrLuganda
            - German
            - Greek
            - Guarani
            - Hani
            - Hawaiian
            - Hebrew
            - Hungarian
            - Icelandic
            - Ido
            - Indonesian
            - Interlingua
            - Italian
            - Japanese
            - Kabardian
            - Kashubian
            - Kawa
            - Kikuyu
            - Kongo
            - Korean
            - Kpelle
            - Kurdish
            - Latin
            - Latvian
            - Lithuanian
            - Luba
            - LuleSami
            - Luxembourgian
            - MacedonianCyrillic
            - Malagasy
            - Malay
            - Malinke
            - Maltese
            - Maori
            - Mayan
            - Miao
            - Minankabaw
            - Mohawk
            - MoldavianCyrillic
            - Nahuatl
            - NorthernSami
            - Norwegian
            - Nyanja
            - Occidental
            - Ojibway
            - Papiamento
            - PidginEnglish
            - Polish
            - Portuguese
            - PortugueseBrazilian
            - Provencal
            - Quechua
            - Rhaetic
            - Romanian
            - Romany
            - Ruanda
            - Rundi
            - RussianCyrillic
            - Sami
            - Samoan
            - Sardinian
            - SerbianCyrillic
            - SerbianLatin
            - Shona
            - SimplifiedChinese
            - Sioux
            - Slovak
            - Slovenian
            - Somali
            - SothoOrSutoOrSesuto
            - SouthernSami
            - Spanish
            - Sundanese
            - Swahili
            - Swazi
            - Swedish
            - Tagalog
            - Tahitian
            - Thai
            - Tinpo
            - Tongan
            - TraditionalChinese
            - Tun
            - Turkish
            - UkrainianCyrillic
            - Vietnamese
            - Visayan
            - Welsh
            - WendOrSorbian
            - Wolof
            - Xhosa
            - Zapotec
            - Zulu
            type: string
        Order:
          type: integer
        ProcessingSet:
          $ref: '#/components/schemas/ProcessingSetRef'
        TimeZone:
          type: integer
        IsStartNumberVisible:
          type: boolean
          nullable: true
        StartNumber:
          type: integer
          nullable: true
        LevelTwoStartNumber:
          type: integer
          nullable: true
        LevelThreeStartNumber:
          type: integer
          nullable: true
        LevelFourStartNumber:
          type: integer
          nullable: true
        ProcessingDataSourceID:
          type: integer
        Name:
          type: string
    DefaultProcessingDataSourceOptionsResponse:
      title: DefaultProcessingDataSourceOptionsResponse
      type: object
      properties:
        OcrLanguages:
          type: array
          items:
            type: string
        TimeZone:
          type: integer
        DocumentNumberingPrefix:
          type: string
        DefaultDestinationFolder:
          type: integer
        NumberingType:
          type: string
        DefaultStartNumber:
          type: integer
          nullable: true
    ValidateFieldLengthAsync_RequestBody:
      title: ValidateFieldLengthAsync_RequestBody
      type: object
      properties:
        fieldLength:
          type: integer
          nullable: true
        fieldDataTypeId:
          type: integer
        sourceLength:
          type: integer
    ProcessingFileIdResults:
      title: ProcessingFileIdResults
      type: object
      properties:
        FilterID:
          type: integer
        TotalCount:
          type: integer
        Results:
          type: array
          items:
            type: integer
    UpdateExpressionFilterAsync_RequestBody:
      title: UpdateExpressionFilterAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/UpdateProcessingExpressionFilterRequest'
    GetInvariantFieldsPaginatedAsync_RequestBody:
      title: GetInvariantFieldsPaginatedAsync_RequestBody
      type: object
      properties:
        skip:
          type: integer
        top:
          type: integer
        fieldMappingRequest:
          $ref: '#/components/schemas/FieldMappingRequest'
    GetDiscoveredDocumentsAsync_RequestBody:
      title: GetDiscoveredDocumentsAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/GetDiscoveredDocumentsRequest'
    GetDiscoveredDocumentsRequest:
      title: GetDiscoveredDocumentsRequest
      type: object
      properties:
        StartingPointOfResult:
          type: integer
        NumberOfResults:
          type: integer
        Expression:
          type: string
        AuditedSourceID:
          type: integer
        SortingOptions:
          type: array
          items:
            $ref: '#/components/schemas/SortOption'
        ExcludeTotalCount:
          type: boolean
        IncludeDuplicateHash:
          type: boolean
    MappableFieldNonPaginated:
      title: MappableFieldNonPaginated
      type: object
      properties:
        InvariantName:
          type: string
        DataType:
          type: string
        Category:
          type: string
    GetDiscoveredDocumentsWithPivotOnResponse:
      title: GetDiscoveredDocumentsWithPivotOnResponse
      type: object
      properties:
        GroupByIdentifier:
          type: string
        PivotOnIdentifier:
          type: string
        ResultCount:
          type: integer
    ProcessingSetDocumentInfoSummary:
      title: ProcessingSetDocumentInfoSummary
      type: object
      properties:
        TotalPublishedDocuments:
          type: integer
        TotalPublishedDocumentSizeInBytes:
          type: number
        TotalProcessingSets:
          type: integer
        ProcessingSetDocumentInfo:
          type: array
          items:
            $ref: '#/components/schemas/ProcessingSetDocumentInfo'
    GetOtherFieldsAsync_RequestBody:
      title: GetOtherFieldsAsync_RequestBody
      type: object
      properties:
        skip:
          type: integer
        top:
          type: integer
        fieldMappingRequest:
          $ref: '#/components/schemas/FieldMappingRequest'
    GetInvariantFieldsAsync_RequestBody:
      title: GetInvariantFieldsAsync_RequestBody
      type: object
      properties:
        catalogFieldsOnly:
          type: boolean
          default: false
    ProcessFilesToDeleteAsync_RequestBody:
      title: ProcessFilesToDeleteAsync_RequestBody
      type: object
      properties:
        fileRequestSize:
          type: integer
    CatalogField:
      title: CatalogField
      type: object
      properties:
        ArtifactId:
          type: integer
          nullable: true
        CatalogFieldGuid:
          type: string
        FieldName:
          type: string
        Description:
          type: string
        FieldType:
          type: string
        Length:
          type: integer
        Category:
          type: string
    FieldMappingRequest:
      title: FieldMappingRequest
      type: object
      properties:
        Filter:
          $ref: '#/components/schemas/FieldFilter'
        SortingOption:
          $ref: '#/components/schemas/FieldSortingOption'
    RetryDocumentErrorsAsync_RequestBody:
      title: RetryDocumentErrorsAsync_RequestBody
      type: object
      properties:
        documentsRequest:
          $ref: '#/components/schemas/ProcessingDocumentsRequest'
    ValidateFieldObjectsAsync_RequestBody:
      title: ValidateFieldObjectsAsync_RequestBody
      type: object
      properties:
        model:
          $ref: '#/components/schemas/ExternalMapping'
        sourceField:
          $ref: '#/components/schemas/MappableSourceField'
    ProcessingSetDocumentInfo:
      title: ProcessingSetDocumentInfo
      type: object
      properties:
        ProcessingSetId:
          type: integer
        ProcessingSetName:
          type: string
        ProcessingSetDateCreated:
          type: string
          format: date-time
        PublishedDocumentCount:
          type: integer
        PublishedDocumentSizeInBytes:
          type: number
    DataSourceValidateDeleteResponse:
      title: DataSourceValidateDeleteResponse
      type: object
      properties:
        CanDelete:
          type: boolean
        Reasons:
          type: array
          items:
            type: string
    ExternalMapping:
      title: ExternalMapping
      type: object
      properties:
        MappingID:
          type: integer
        FieldID:
          type: integer
          nullable: true
        FieldGuid:
          type: string
          nullable: true
        RelativityFieldName:
          type: string
        FieldTypeID:
          type: integer
        EnableDataGrid:
          type: boolean
        ExternalFieldName:
          type: string
        ExternalFieldSource:
          type: string
        FriendlyName:
          type: string
        UseUnicodeEncoding:
          type: boolean
        CatalogLength:
          type: integer
          nullable: true
        CurrentLength:
          type: integer
          nullable: true
        ObjectTypeID:
          type: integer
        IsArtifactBaseField:
          type: boolean
        FieldCategory:
          type: integer
        AssociativeArtifactTypeID:
          type: integer
          nullable: true
    ProcessingDocumentsRequest:
      title: ProcessingDocumentsRequest
      type: object
      properties:
        ProcessingFileIDs:
          type: array
          items:
            type: integer
        Expression:
          type: string
    MappableSourceField:
      title: MappableSourceField
      type: object
      properties:
        Category:
          type: string
        SourceName:
          type: string
        FriendlyName:
          type: string
        Description:
          type: string
        DataType:
          type: string
        MappedFields:
          type: array
          items:
            type: string
        Length:
          type: integer
    RetrievePublishableDocumentCountAsync_RequestBody:
      title: RetrievePublishableDocumentCountAsync_RequestBody
      type: object
      properties:
        documentsRequest:
          $ref: '#/components/schemas/ProcessingDocumentsRequest'
    FieldMappingResponse:
      title: FieldMappingResponse
      type: object
      properties:
        TotalCount:
          type: integer
        MappableFields:
          type: array
          items:
            $ref: '#/components/schemas/MappableSourceField'
    ProcessingSetState:
      title: ProcessingSetState
      type: object
      properties:
        ProcessingSetID:
          type: integer
        InventoryStatus:
          type: string
        DiscoverStatus:
          type: string
        PublishStatus:
          type: string
        Canceled:
          type: boolean
        ProcessingProfileID:
          type: integer
    GetAllMappedFieldsAsync_RequestBody:
      title: GetAllMappedFieldsAsync_RequestBody
      type: object
      properties:
        fieldsToAppend:
          type: array
          items:
            type: string
    GetDiscoveredDocumentIdsAsync_RequestBody:
      title: GetDiscoveredDocumentIdsAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/GetDiscoveredDocumentsRequest'
    UpdateExternalMappingAsync_RequestBody:
      title: UpdateExternalMappingAsync_RequestBody
      type: object
      properties:
        fieldID:
          type: integer
        model:
          $ref: '#/components/schemas/ExternalMapping'
        validation:
          type: boolean
          default: true
    PivotOnDiscoveredDocumentsAsync_RequestBody:
      title: PivotOnDiscoveredDocumentsAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/GetDiscoveredDocumentsWithPivotOnRequest'
    FieldFilter:
      title: FieldFilter
      type: object
      properties:
        NameFilter:
          type: string
        DataTypeFilter:
          type: string
        DescriptionFilter:
          type: string
        RelativityFieldNameFilter:
          type: string
        SourceNameFilter:
          type: string
    ProcessingFilterData:
      title: ProcessingFilterData
      type: object
      properties:
        FilterID:
          type: integer
        TotalCount:
          type: integer
        Results:
          type: array
          items:
            $ref: '#/components/schemas/ProcessingFilterResult'
    ProcessingDocumentErrorInfo:
      title: ProcessingDocumentErrorInfo
      type: object
      properties:
        TimeStamp:
          type: string
          format: date-time
        Category:
          type: string
        ErrorMessage:
          type: string
        ErrorPhase:
          type: string
        RetryStatus:
          type: string
    ProcessingSetSummaryData:
      title: ProcessingSetSummaryData
      type: object
      properties:
        SetState:
          $ref: '#/components/schemas/ProcessingSetState'
        HasRunningJobs:
          type: boolean
        EnvironmentErrors:
          type: array
          items:
            type: string
        DataSourceIDs:
          type: array
          items:
            type: integer
        DataSourceHasDocumentLevelErrors:
          type: boolean
        DataSourceHasJobLevelErrors:
          type: boolean
        HasValidProcessingProfile:
          type: boolean
        IsStoreValid:
          type: boolean
    GetDiscoveredDocumentListRequest:
      title: GetDiscoveredDocumentListRequest
      type: object
      properties:
        Expression:
          type: string
        FileIDs:
          type: array
          items:
            type: integer
        Columns:
          type: array
          items:
            $ref: '#/components/schemas/ExportColumn'
        SortingOptions:
          type: array
          items:
            $ref: '#/components/schemas/SortOption'
        Culture:
          type: string
    ExportColumn:
      title: ExportColumn
      type: object
      properties:
        Property:
          enum:
          - ContainerID
          - ProcessingFileId
          - FileSize
          - ParentDocumentId
          - DiscoverGroupId
          - ContainerName
          - ContainerExtension
          - IngestionError
          - ExtractedTextLocation
          - FileName
          - FileExtension
          - FileType
          - FolderPath
          - ImportSource
          - LogicalPath
          - MD5Hash
          - DocumentErrorMessage
          - OriginalPath
          - SHA1Hash
          - SHA256Hash
          - TextExtractionMethod
          - VirtualPath
          - IsContainer
          - IsEmbedded
          - OfficeEmbeddedItems
          - Unprocessable
          - IsPublished
          - CustodianArtifactId
          - DataSourceArtifactId
          - CustodianName
          - DataSourceName
          - IsDeleted
          - ErrorMessage
          - SenderDomain
          - SortDate
          - ErrorCategory
          - ErrorPhase
          - ErrorStatus
          - DedupeStatus
          - StorageId
          - Severity
          - ProcessingDupeHash
          type: string
        Header:
          type: string
    ApplyProcessingFilterRequest:
      title: ApplyProcessingFilterRequest
      type: object
      properties:
        Priority:
          type: integer
    PublishDocumentsAsync_RequestBody:
      title: PublishDocumentsAsync_RequestBody
      type: object
      properties:
        documentsRequest:
          $ref: '#/components/schemas/ProcessingDocumentsRequest'
    CreateExpressionFilterAsync_RequestBody:
      title: CreateExpressionFilterAsync_RequestBody
      type: object
      properties:
        request:
          $ref: '#/components/schemas/CreateProcessingExpressionFilterRequest'
    SortOption:
      title: SortOption
      type: object
      properties:
        Property:
          enum:
          - ContainerID
          - ProcessingFileId
          - FileSize
          - ParentDocumentId
          - DiscoverGroupId
          - ContainerName
          - ContainerExtension
          - IngestionError
          - ExtractedTextLocation
          - FileName
          - FileExtension
          - FileType
          - FolderPath
          - ImportSource
          - LogicalPath
          - MD5Hash
          - DocumentErrorMessage
          - OriginalPath
          - SHA1Hash
          - SHA256Hash
          - TextExtractionMethod
          - VirtualPath
          - IsContainer
          - IsEmbedded
          - OfficeEmbeddedItems
          - Unprocessable
          - IsPublished
          - CustodianArtifactId
          - DataSourceArtifactId
          - CustodianName
          - DataSourceName
          - IsDeleted
          - ErrorMessage
          - SenderDomain
          - SortDate
          - ErrorCategory
          - ErrorPhase
          - ErrorStatus
          - DedupeStatus
          - StorageId
          - Severity
          - ProcessingDupeHash
          type: string
        Order:
          enum:
          - Descending
          - Ascending
          type: string
    ProcessingFilter:
      title: ProcessingFilter
      type: object
      properties:
        FilterID:
          type: integer
        FilterName:
          type: string
        Type:
          type: string
    UpdateProcessingExpressionFilterRequest:
      title: UpdateProcessingExpressionFilterRequest
      type: object
      properties:
        FilterName:
          type: string
        DataSourceIDs:
          type: array
          items:
            type: integer
        Expression:
          type: string
        IncludeFamily:
          type: boolean
    MappableFieldsResponse:
      title: MappableFieldsResponse
      type: object
      properties:
        MappableFields:
          type: array
          items:
            $ref: '#/components/schemas/MappableFieldNonPaginated'
    ConfirmProcessedFilesDeletionAsync_RequestBody:
      title: ConfirmProcessedFilesDeletionAsync_RequestBody
      type: object
      properties:
        requestGuid:
          type: string
    GetProcessedFilesToDeleteResponse:
      title: GetProcessedFilesToDeleteResponse
      type: object
      properties:
        RequestGuid:
          type: string
        Files:
          type: array
          items:
            $ref: '#/components/schemas/FileData'
        WorkspaceId:
          type: integer
    FileData:
      title: FileData
      type: object
      properties:
        FilePath:
          type: string
        FolderDepth:
          type: integer
    ProcessingProfileRef:
      title: ProcessingProfileRef
      type: object
      properties:
        ProcessingProfileID:
          type: integer
        Name:
          type: string
        IsNew:
          type: boolean
    GetPublishJobErrorsAsync_RequestBody:
      title: GetPublishJobErrorsAsync_RequestBody
      type: object
      properties:
        documentsRequest:
          $ref: '#/components/schemas/ProcessingDocumentsRequest'
    ProcessingDocumentErrorHistoryResponse:
      title: ProcessingDocumentErrorHistoryResponse
      type: object
      properties:
        TotalCount:
          type: integer
        DocumentErrorHistory:
          type: array
          items:
            $ref: '#/components/schemas/ProcessingDocumentErrorInfo'
  parameters:
    fileID:
      name: fileID
      in: path
      description: ''
      required: true
      schema:
        type: integer
    dataSourceID:
      name: dataSourceID
      in: path
      description: ''
      required: true
      schema:
        type: integer
    custodianID:
      name: custodianID
      in: path
      description: ''
      required: true
      schema:
        type: integer
    processingSetID:
      name: processingSetID
      in: path
      description: ''
      required: true
      schema:
        type: integer
    workspaceID:
      name: workspaceID
      in: path
      description: ''
      required: true
      schema:
        type: integer
    filterID:
      name: filterID
      in: path
      description: ''
      required: true
      schema:
        type: integer
    profileId:
      name: profileId
      in: path
      description: ''
      required: true
      schema:
        type: integer
    requestGuid:
      name: requestGuid
      in: path
      description: ''
      required: true
      schema:
        type: string
    processingDataSourceID:
      name: processingDataSourceID
      in: path
      description: ''
      required: true
      schema:
        type: integer
    x-csrf-header:
      name: x-csrf-header
      in: header
      description: ''
      required: true
      schema:
        type: string
        default: '-'