#This file was generated by Kepler.OasGenerator Version 1.13.5 { "openapi": "3.0.1", "info": { "title": "Relativity.Processing.V1", "description": "Relativity.Processing", "version": "V1" }, "servers": [ { "url": "/Relativity.REST/api", "description": "The URL prefix for all Kepler services" } ], "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/fileRequestSize" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "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/requestGuid" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "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/fieldID" }, { "$ref": "#/components/parameters/validation" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalMapping" } } }, "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/catalogFieldsOnly" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "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/skip" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldMappingRequest" } } }, "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/skip" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldMappingRequest" } } }, "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/skip" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldMappingRequest" } } }, "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/sourceName" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "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/fieldID" }, { "$ref": "#/components/parameters/fieldSource" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "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/fieldsToAppend" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "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/metadataFieldCount" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MappableFieldsResponse" } } } } } } }, "/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/skip" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "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/ProcessingDocumentsRequest" } } }, "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/ProcessingDocumentsRequest" } } }, "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/ProcessingDocumentsRequest" } } }, "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/ProcessingDocumentsRequest" } } }, "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/ProcessingDocumentsRequest" } } }, "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/CreateProcessingExpressionFilterRequest" } } }, "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/ApplyProcessingFilterRequest" } } }, "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/skip" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "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/UpdateProcessingExpressionFilterRequest" } } }, "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/GetDiscoveredDocumentsRequest" } } }, "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/GetDiscoveredDocumentsRequest" } } }, "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/GetDiscoveredDocumentListRequest" } } }, "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/GetDiscoveredDocumentsWithPivotOnRequest" } } }, "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_Path" }, { "$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/ProcessingCustodian" } } }, "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/ProcessingCustodian" } } }, "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/ProcessingDataSource" } } }, "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/ProcessingDataSource" } } }, "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}/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/ProcessingSet" } } }, "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/ProcessingSet" } } }, "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/skip" }, { "$ref": "#/components/parameters/top" }, { "$ref": "#/components/parameters/sortColumnName" }, { "$ref": "#/components/parameters/sortDescending" }, { "$ref": "#/components/parameters/x-csrf-header" } ], "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": { "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" } } }, "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 } } }, "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" } } }, "FieldMappingRequest": { "title": "FieldMappingRequest", "type": "object", "properties": { "Filter": { "$ref": "#/components/schemas/FieldFilter" }, "SortingOption": { "$ref": "#/components/schemas/FieldSortingOption" } } }, "FieldFilter": { "title": "FieldFilter", "type": "object", "properties": { "NameFilter": { "type": "string" }, "DataTypeFilter": { "type": "string" }, "DescriptionFilter": { "type": "string" }, "RelativityFieldNameFilter": { "type": "string" }, "SourceNameFilter": { "type": "string" } } }, "FieldSortingOption": { "title": "FieldSortingOption", "type": "object", "properties": { "FieldName": { "enum": [ "Name", "DataType", "Description", "RelativityFieldName" ], "type": "string" }, "SortingDirection": { "enum": [ "Asc", "Desc" ], "type": "string" } } }, "FieldMappingResponse": { "title": "FieldMappingResponse", "type": "object", "properties": { "TotalCount": { "type": "integer" }, "MappableFields": { "type": "array", "items": { "$ref": "#/components/schemas/MappableSourceField" } } } }, "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" } } }, "MappableFieldsResponse": { "title": "MappableFieldsResponse", "type": "object", "properties": { "MappableFields": { "type": "array", "items": { "$ref": "#/components/schemas/MappableFieldNonPaginated" } } } }, "MappableFieldNonPaginated": { "title": "MappableFieldNonPaginated", "type": "object", "properties": { "InvariantName": { "type": "string" }, "DataType": { "type": "string" }, "Category": { "type": "string" } } }, "ProcessingMetadataResponse": { "title": "ProcessingMetadataResponse", "type": "object", "properties": { "ProcessingFileID": { "type": "integer" }, "WorkspaceArtifactID": { "type": "integer" }, "MetadataJson": { "type": "string" }, "Errors": { "type": "array", "items": { "type": "string" } } } }, "ProcessingDocumentErrorHistoryResponse": { "title": "ProcessingDocumentErrorHistoryResponse", "type": "object", "properties": { "TotalCount": { "type": "integer" }, "DocumentErrorHistory": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessingDocumentErrorInfo" } } } }, "ProcessingDocumentErrorInfo": { "title": "ProcessingDocumentErrorInfo", "type": "object", "properties": { "TimeStamp": { "type": "string", "format": "date-time" }, "Category": { "type": "string" }, "ErrorMessage": { "type": "string" }, "ErrorPhase": { "type": "string" }, "RetryStatus": { "type": "string" } } }, "ProcessingDocumentsRequest": { "title": "ProcessingDocumentsRequest", "type": "object", "properties": { "ProcessingFileIDs": { "type": "array", "items": { "type": "integer" } }, "Expression": { "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" } } }, "CreateProcessingExpressionFilterRequest": { "title": "CreateProcessingExpressionFilterRequest", "type": "object", "properties": { "FilterName": { "type": "string" }, "DataSourceIDs": { "type": "array", "items": { "type": "integer" } }, "Expression": { "type": "string" }, "IncludeFamily": { "type": "boolean" } } }, "ProcessingFilter": { "title": "ProcessingFilter", "type": "object", "properties": { "FilterID": { "type": "integer" }, "FilterName": { "type": "string" }, "Type": { "type": "string" } } }, "ApplyProcessingFilterRequest": { "title": "ApplyProcessingFilterRequest", "type": "object", "properties": { "Priority": { "type": "integer" } } }, "ProcessingFilterData": { "title": "ProcessingFilterData", "type": "object", "properties": { "FilterID": { "type": "integer" }, "TotalCount": { "type": "integer" }, "Results": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessingFilterResult" } } } }, "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" } } }, "UpdateProcessingExpressionFilterRequest": { "title": "UpdateProcessingExpressionFilterRequest", "type": "object", "properties": { "FilterName": { "type": "string" }, "DataSourceIDs": { "type": "array", "items": { "type": "integer" } }, "Expression": { "type": "string" }, "IncludeFamily": { "type": "boolean" } } }, "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" } } }, "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" ], "type": "string" }, "Order": { "enum": [ "Descending", "Ascending" ], "type": "string" } } }, "ProcessingFileIdResults": { "title": "ProcessingFileIdResults", "type": "object", "properties": { "FilterID": { "type": "integer" }, "TotalCount": { "type": "integer" }, "Results": { "type": "array", "items": { "type": "integer" } } } }, "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" } } } }, "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" ], "type": "string" }, "Header": { "type": "string" } } }, "PrepareDiscoveredDocumentListResponse": { "title": "PrepareDiscoveredDocumentListResponse", "type": "object", "properties": { "Guid": { "type": "string" } } }, "GetDiscoveredDocumentsWithPivotOnRequest": { "title": "GetDiscoveredDocumentsWithPivotOnRequest", "type": "object", "properties": { "Expression": { "type": "string" }, "PivotOnOption": { "$ref": "#/components/schemas/PivotOnOption" } } }, "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" ], "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" ], "type": "string", "nullable": true }, "PivotOnOrdering": { "enum": [ "Descending", "Ascending" ], "type": "string" }, "PivotOnCount": { "type": "integer" } } }, "GetDiscoveredDocumentsWithPivotOnResponse": { "title": "GetDiscoveredDocumentsWithPivotOnResponse", "type": "object", "properties": { "GroupByIdentifier": { "type": "string" }, "PivotOnIdentifier": { "type": "string" }, "ResultCount": { "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" } } } }, "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" } } }, "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", "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", "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", "Tinpo", "Tongan", "TraditionalChinese", "Tun", "Turkish", "UkrainianCyrillic", "Visayan", "Welsh", "WendOrSorbian", "Wolof", "Xhosa", "Zapotec", "Zulu", "Arabic", "Hebrew", "Thai", "Vietnamese" ], "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" } } }, "ProcessingSetRef": { "title": "ProcessingSetRef", "type": "object", "properties": { "ProcessingSetID": { "type": "integer" }, "Name": { "type": "string" } } }, "DataSourceValidateDeleteResponse": { "title": "DataSourceValidateDeleteResponse", "type": "object", "properties": { "CanDelete": { "type": "boolean" }, "Reasons": { "type": "array", "items": { "type": "string" } } } }, "ProcessingSet": { "title": "ProcessingSet", "type": "object", "properties": { "EmailNotificationRecipients": { "type": "array", "items": { "type": "string" } }, "Profile": { "$ref": "#/components/schemas/ProcessingProfileRef" }, "ProcessingSetID": { "type": "integer" }, "Name": { "type": "string" } } }, "ProcessingProfileRef": { "title": "ProcessingProfileRef", "type": "object", "properties": { "ProcessingProfileID": { "type": "integer" }, "Name": { "type": "string" }, "IsNew": { "type": "boolean" } } }, "ProcessingSetDocumentInfoSummary": { "title": "ProcessingSetDocumentInfoSummary", "type": "object", "properties": { "TotalPublishedDocuments": { "type": "integer" }, "TotalPublishedDocumentSizeInBytes": { "type": "number" }, "TotalProcessingSets": { "type": "integer" }, "ProcessingSetDocumentInfo": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessingSetDocumentInfo" } } } }, "ProcessingSetDocumentInfo": { "title": "ProcessingSetDocumentInfo", "type": "object", "properties": { "ProcessingSetId": { "type": "integer" }, "ProcessingSetName": { "type": "string" }, "ProcessingSetDateCreated": { "type": "string", "format": "date-time" }, "PublishedDocumentCount": { "type": "integer" }, "PublishedDocumentSizeInBytes": { "type": "number" } } }, "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" } } }, "ProcessingSetState": { "title": "ProcessingSetState", "type": "object", "properties": { "ProcessingSetID": { "type": "integer" }, "InventoryStatus": { "type": "string" }, "DiscoverStatus": { "type": "string" }, "PublishStatus": { "type": "string" }, "Canceled": { "type": "boolean" }, "ProcessingProfileID": { "type": "integer" } } } }, "parameters": { "fileRequestSize": { "name": "fileRequestSize", "in": "query", "description": "", "required": true, "schema": { "type": "integer" } }, "x-csrf-header": { "name": "x-csrf-header", "in": "header", "description": "", "required": true, "schema": { "type": "string", "default": "-" } }, "requestGuid": { "name": "requestGuid", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, "workspaceID": { "name": "workspaceID", "in": "path", "description": "", "required": true, "schema": { "type": "integer" } }, "fieldID": { "name": "fieldID", "in": "query", "description": "", "required": true, "schema": { "type": "integer" } }, "validation": { "name": "validation", "in": "query", "description": "", "schema": { "type": "boolean", "default": true } }, "catalogFieldsOnly": { "name": "catalogFieldsOnly", "in": "query", "description": "", "schema": { "type": "boolean", "default": false } }, "skip": { "name": "skip", "in": "query", "description": "", "required": true, "schema": { "type": "integer" } }, "top": { "name": "top", "in": "query", "description": "", "required": true, "schema": { "type": "integer" } }, "sourceName": { "name": "sourceName", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, "fieldSource": { "name": "fieldSource", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, "dataSourceID": { "name": "dataSourceID", "in": "path", "description": "", "required": true, "schema": { "type": "integer" } }, "fieldsToAppend": { "name": "fieldsToAppend", "in": "query", "description": "", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, "metadataFieldCount": { "name": "metadataFieldCount", "in": "query", "description": "", "required": true, "schema": { "type": "integer" } }, "fileID": { "name": "fileID", "in": "path", "description": "", "required": true, "schema": { "type": "integer" } }, "filterID": { "name": "filterID", "in": "path", "description": "", "required": true, "schema": { "type": "integer" } }, "requestGuid_Path": { "name": "requestGuid", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, "custodianID": { "name": "custodianID", "in": "path", "description": "", "required": true, "schema": { "type": "integer" } }, "processingDataSourceID": { "name": "processingDataSourceID", "in": "path", "description": "", "required": true, "schema": { "type": "integer" } }, "processingSetID": { "name": "processingSetID", "in": "path", "description": "", "required": true, "schema": { "type": "integer" } }, "sortColumnName": { "name": "sortColumnName", "in": "query", "description": "", "required": true, "schema": { "type": "string" } }, "sortDescending": { "name": "sortDescending", "in": "query", "description": "", "required": true, "schema": { "type": "boolean" } } } } }