Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Relativity

Relativity Processing Module v1 API

The Processing Module v1 API from Relativity — 51 operation(s) for processing module v1.

Documentation Provider Profile APIs.io OpenAPI GitHub

Relativity Processing Module v1 API is one of 51 APIs that Relativity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Processing Module v1. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, rate-limit docs, and a getting-started guide.

This API exposes 56 operations across 51 paths, and defines 74 schemas. It is described by OpenAPI 3.0.1, at version V1.

Requests are made against a single base URL, /Relativity.REST/api.

56 operations 51 paths 74 schemas 1 DELETE25 GET24 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
V1
Base URL
https://{host}/Relativity.REST/api/relativity-object-model/v1
Resource Areas
1

Paths & Operations 56

Across 51 paths, the API surfaces 56 operations — 1 DELETE, 25 GET, 24 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Processing Module v1 56
GET
/relativity-processing/v1/file-deletion/get-processed-files-to-delete
[Public] IFileDeletionManager -
Relativity.Processing.V1.Services.IFileDeletionManager.ProcessFilesToDeleteAsync 1 param body → 200
POST
/relativity-processing/v1/file-deletion/confirm-processed-files-deletion
[Public] IFileDeletionManager -
Relativity.Processing.V1.Services.IFileDeletionManager.ConfirmProcessedFilesDeletionAsync 1 param body → 200
PUT
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings
[Public] IFieldMappingManager -
Relativity.Processing.V1.Services.IFieldMappingManager.UpdateExternalMappingAsync 2 params body → 200
GET
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings/auto/guids
[Public] IFieldMappingManager -
Relativity.Processing.V1.Services.IFieldMappingManager.GetAutoMappedFieldGuidsAsync 2 params → 200
GET
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings/available
[Public] IFieldMappingManager -
Relativity.Processing.V1.Services.IFieldMappingManager.IsFieldMappingAvailableAsync 2 params → 200
GET
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings/invariant
[Public] IFieldMappingManager -
Relativity.Processing.V1.Services.IFieldMappingManager.GetInvariantFieldsAsync 2 params body → 200
POST
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings/pages
[Public] IFieldMappingManager -
Relativity.Processing.V1.Services.IFieldMappingManager.GetInvariantFieldsPaginatedAsync 2 params body → 200
POST
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings/metadata-fields
[Public] IFieldMappingManager -
Relativity.Processing.V1.Services.IFieldMappingManager.GetMetadataFieldsAsync 2 params body → 200
POST
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings/other-fields
[Public] IFieldMappingManager -
Relativity.Processing.V1.Services.IFieldMappingManager.GetOtherFieldsAsync 2 params body → 200
GET
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings/source-field
[Public] IFieldMappingManager -
Relativity.Processing.V1.Services.IFieldMappingManager.GetMappableSourceFieldAsync 2 params body → 200
GET
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings/external
[Public] IFieldMappingManager -
Relativity.Processing.V1.Services.IFieldMappingManager.ReadExternalMappingAsync 2 params body → 200
POST
/relativity-processing/v1/workspaces/{workspaceID}/data-sources/{dataSourceID}/field-mappings/relativity
[Public] IFieldMappingManager -
Relativity.Processing.V1.Services.IFieldMappingManager.GetAllMappedFieldsAsync 3 params body → 200
GET
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings/catalog-fields
[Public] IFieldMappingManager -
Relativity.Processing.V1.Services.IFieldMappingManager.GetCatalogFieldsAsync 2 params → 200
GET
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings/invariant-catalog-field-mapping
[Public] IFieldMappingManager -
Relativity.Processing.V1.Services.IFieldMappingManager.GetInvariantFieldCatalogMapping 2 params → 200
GET
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings/get-mappable-fields
[Public] IFieldMappingManager -
Relativity.Processing.V1.Services.IFieldMappingManager.GetNewMappableFieldsNonPaginatedAsync 2 params body → 200
GET
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings/validate-type
[Public] IFieldMappingManager -
Relativity.Processing.V1.Services.IFieldMappingManager.ValidateFieldTypeMappingAsync 2 params body → 200
GET
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings/validate-length
[Public] IFieldMappingManager -
Relativity.Processing.V1.Services.IFieldMappingManager.ValidateFieldLengthAsync 2 params body → 200
PUT
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings/validate-fields
[Public] IFieldMappingManager -
Relativity.Processing.V1.Services.IFieldMappingManager.ValidateFieldObjectsAsync 2 params body → 200
GET
/relativity-processing/v1/workspaces/{workspaceID}/documents/{fileID}/metadata
[Public] IProcessingDocumentManager -
Relativity.Processing.V1.Services.IProcessingDocumentManager.GetDocumentMetadataAsync 3 params → 200
GET
/relativity-processing/v1/workspaces/{workspaceID}/documents/{fileID}/errors
[Public] IProcessingDocumentManager -
Relativity.Processing.V1.Services.IProcessingDocumentManager.GetDocumentErrorHistoryAsync 3 params body → 200
POST
/relativity-processing/v1/workspaces/{workspaceID}/documents/retry
[Public] IProcessingDocumentManager -
Relativity.Processing.V1.Services.IProcessingDocumentManager.RetryDeleteDocumentAsync 2 params body → 200
POST
/relativity-processing/v1/workspaces/{workspaceID}/documents/retry-errors
[Public] IProcessingDocumentManager -
Relativity.Processing.V1.Services.IProcessingDocumentManager.RetryDocumentErrorsAsync 2 params body → 200
POST
/relativity-processing/v1/workspaces/{workspaceID}/documents/publish
[Public] IProcessingDocumentManager -
Relativity.Processing.V1.Services.IProcessingDocumentManager.PublishDocumentsAsync 2 params body → 200
POST
/relativity-processing/v1/workspaces/{workspaceID}/documents/get-publish-job-errors
[Public] IProcessingDocumentManager -
Relativity.Processing.V1.Services.IProcessingDocumentManager.GetPublishJobErrorsAsync 2 params body → 200
POST
/relativity-processing/v1/workspaces/{workspaceID}/documents/count
[Public] IProcessingDocumentManager -
Relativity.Processing.V1.Services.IProcessingDocumentManager.RetrievePublishableDocumentCountAsync 2 params body → 200
POST
/relativity-processing/v1/workspaces/{workspaceID}/filters
[Public] IProcessingFilterManager -
Relativity.Processing.V1.Services.IProcessingFilterManager.CreateExpressionFilterAsync 2 params body → 201
GET
/relativity-processing/v1/workspaces/{workspaceID}/filters
[Public] IProcessingFilterManager -
Relativity.Processing.V1.Services.IProcessingFilterManager.GetFiltersAsync 2 params → 200
POST
/relativity-processing/v1/workspaces/{workspaceID}/filters/{filterID}/apply
[Public] IProcessingFilterManager -
Relativity.Processing.V1.Services.IProcessingFilterManager.ApplyFilterAsync 3 params body → 200
GET
/relativity-processing/v1/workspaces/{workspaceID}/filters/results/{filterID}
[Public] IProcessingFilterManager -
Relativity.Processing.V1.Services.IProcessingFilterManager.GetFilterResultAsync 3 params body → 200
GET
/relativity-processing/v1/workspaces/{workspaceID}/filters/data-sources/{dataSourceID}/filters
[Public] IProcessingFilterManager -
Relativity.Processing.V1.Services.IProcessingFilterManager.GetFiltersByDataSourceAsync 3 params → 200
PUT
/relativity-processing/v1/workspaces/{workspaceID}/filters/{filterID}
[Public] IProcessingFilterManager -
Relativity.Processing.V1.Services.IProcessingFilterManager.UpdateExpressionFilterAsync 3 params body → 200
DELETE
/relativity-processing/v1/workspaces/{workspaceID}/filters/{filterID}
[Public] IProcessingFilterManager -
Relativity.Processing.V1.Services.IProcessingFilterManager.DeleteFilterAsync 3 params → 200
POST
/relativity-processing/v1/workspaces/{workspaceID}/filters/documents
[Public] IProcessingFilterManager -
Relativity.Processing.V1.Services.IProcessingFilterManager.GetDiscoveredDocumentsAsync 2 params body → 200
POST
/relativity-processing/v1/workspaces/{workspaceID}/filters/document-ids
[Public] IProcessingFilterManager -
Relativity.Processing.V1.Services.IProcessingFilterManager.GetDiscoveredDocumentIdsAsync 2 params body → 200
POST
/relativity-processing/v1/workspaces/{workspaceID}/filters/csvs
[Public] IProcessingFilterManager -
Relativity.Processing.V1.Services.IProcessingFilterManager.PrepareDiscoveredDocumentListAsync 2 params body → 201
POST
/relativity-processing/v1/workspaces/{workspaceID}/filters/pivot-discovered-documents
[Public] IProcessingFilterManager -
Relativity.Processing.V1.Services.IProcessingFilterManager.PivotOnDiscoveredDocumentsAsync 2 params body → 200
GET
/relativity-processing/v1/workspaces/{workspaceID}/filters/csvs/{requestGuid}
[Public] IProcessingFilterManager -
Relativity.Processing.V1.Services.IProcessingFilterManager.DownloadDiscoveredDocumentListAsync 3 params → 200
GET
/relativity-processing/v1/workspaces/{workspaceID}/custodians/{custodianID}
[Public] IProcessingCustodianManager -
Relativity.Processing.V1.Services.IProcessingCustodianManager.ReadAsync 3 params → 200
PUT
/relativity-processing/v1/workspaces/{workspaceID}/custodians/{custodianID}
[Public] IProcessingCustodianManager -
Relativity.Processing.V1.Services.IProcessingCustodianManager.UpdateAsync 3 params body → 200
POST
/relativity-processing/v1/workspaces/{workspaceID}/custodians
[Public] IProcessingCustodianManager -
Relativity.Processing.V1.Services.IProcessingCustodianManager.CreateAsync 2 params body → 201
GET
/relativity-processing/v1/workspaces/{workspaceID}/data-sources/{dataSourceID}
[Public] IProcessingDataSourceManager -
Relativity.Processing.V1.Services.IProcessingDataSourceManager.ReadAsync 3 params → 200
PUT
/relativity-processing/v1/workspaces/{workspaceID}/data-sources/{dataSourceID}
[Public] IProcessingDataSourceManager -
Relativity.Processing.V1.Services.IProcessingDataSourceManager.UpdateAsync 3 params body → 200
POST
/relativity-processing/v1/workspaces/{workspaceID}/data-sources
[Public] IProcessingDataSourceManager -
Relativity.Processing.V1.Services.IProcessingDataSourceManager.CreateAsync 2 params body → 201
GET
/relativity-processing/v1/workspaces/{workspaceID}/data-sources/{processingDataSourceID}/delete-validation
[Public] IProcessingDataSourceManager -
Relativity.Processing.V1.Services.IProcessingDataSourceManager.ValidateDeleteAsync 3 params → 200
GET
/relativity-processing/v1/workspaces/{workspaceID}/data-sources/source-location-paths
[Public] IProcessingDataSourceManager -
Relativity.Processing.V1.Services.IProcessingDataSourceManager.RetrieveProcessingDataSourceInputPathsForWorkspaceAsync 2 params → 200
GET
/relativity-processing/v1/workspaces/{workspaceID}/data-sources/profile-presets/{profileId}
[Public] IProcessingDataSourceManager -
Relativity.Processing.V1.Services.IProcessingDataSourceManager.RetrieveDefaultsFromProcessingProfile 3 params → 200
POST
/relativity-processing/v1/workspaces/{workspaceID}/processing-jobs/{processingSetID}/cancel
[Public] IProcessingJobManager -
Relativity.Processing.V1.Services.IProcessingJobManager.SubmitCancelJobAsync 3 params → 201
POST
/relativity-processing/v1/workspaces/{workspaceID}/processing-jobs/{processingSetID}/discover
[Public] IProcessingJobManager -
Relativity.Processing.V1.Services.IProcessingJobManager.SubmitDiscoveryJobsAsync 3 params → 201
POST
/relativity-processing/v1/workspaces/{workspaceID}/processing-jobs/{processingSetID}/inventory
[Public] IProcessingJobManager -
Relativity.Processing.V1.Services.IProcessingJobManager.SubmitInventoryJobsAsync 3 params → 201
POST
/relativity-processing/v1/workspaces/{workspaceID}/processing-jobs/{processingSetID}/publish
[Public] IProcessingJobManager -
Relativity.Processing.V1.Services.IProcessingJobManager.SubmitPublishJobsAsync 3 params → 201
POST
/relativity-processing/v1/workspaces/{workspaceID}/processing-jobs/{processingSetID}/retry-errors
[Public] IProcessingJobManager -
Relativity.Processing.V1.Services.IProcessingJobManager.SubmitRetryErrorsJobsAsync 3 params → 201
GET
/relativity-processing/v1/workspaces/{workspaceID}/processing-sets/{processingSetID}
[Public] IProcessingSetManager -
Relativity.Processing.V1.Services.IProcessingSetManager.ReadAsync 3 params → 200
PUT
/relativity-processing/v1/workspaces/{workspaceID}/processing-sets/{processingSetID}
[Public] IProcessingSetManager -
Relativity.Processing.V1.Services.IProcessingSetManager.UpdateAsync 3 params body → 200
POST
/relativity-processing/v1/workspaces/{workspaceID}/processing-sets
[Public] IProcessingSetManager -
Relativity.Processing.V1.Services.IProcessingSetManager.CreateAsync 2 params body → 201
GET
/relativity-processing/v1/workspaces/{workspaceID}/processing-sets/documents
[Public] IProcessingSetManager -
Relativity.Processing.V1.Services.IProcessingSetManager.GetDocumentAggregates 2 params body → 200
GET
/relativity-processing/v1/workspaces/{workspaceID}/processing-sets/{processingSetID}/summary
[Public] IProcessingSetManager -
Relativity.Processing.V1.Services.IProcessingSetManager.GetSummaryDataAsync 3 params → 200

Schemas 74

The contract defines 74 schemas that model the data the API accepts and returns. The most detailed are ProcessingFilterResult (40 properties), ExternalMapping (16 properties), ProcessingDataSource (16 properties), ProcessingCustodian (8 properties). Each schema is shown below with its type and property counts.

PivotOnOption
object
6 properties
ProcessingSetRef
object
2 properties
ReadExternalMappingAsync_RequestBody
object
2 properties
ProcessingFilterResult
object
40 properties
ApplyFilterAsync_RequestBody
object
1 property
ProcessingCustodian
object
8 properties
CreateProcessingExpressionFilterRequest
object
4 properties
ProcessingSet
object
4 properties
PrepareDiscoveredDocumentListAsync_RequestBody
object
1 property
GetMetadataFieldsAsync_RequestBody
object
3 properties
UpdateAsync_RequestBody
object
1 property
PrepareDiscoveredDocumentListResponse
object
1 property
CreateAsync_RequestBody
object
1 property
GetNewMappableFieldsNonPaginatedAsync_RequestBody
object
1 property
GetDocumentAggregates_RequestBody
object
4 properties
ValidateFieldTypeMappingAsync_RequestBody
object
2 properties
PublishJobErrorInfoResponse
object
5 properties
ProcessingMetadataResponse
object
4 properties
FieldSortingOption
object
2 properties
GetDiscoveredDocumentsWithPivotOnRequest
object
2 properties
GetFilterResultAsync_RequestBody
object
2 properties
IKeplerStream
object
5 properties
GetMappableSourceFieldAsync_RequestBody
object
1 property
RetryDeleteDocumentAsync_RequestBody
object
1 property
GetDocumentErrorHistoryAsync_RequestBody
object
2 properties
ProcessingDataSource
object
16 properties
DefaultProcessingDataSourceOptionsResponse
object
6 properties
ValidateFieldLengthAsync_RequestBody
object
3 properties
ProcessingFileIdResults
object
3 properties
UpdateExpressionFilterAsync_RequestBody
object
1 property
GetInvariantFieldsPaginatedAsync_RequestBody
object
3 properties
GetDiscoveredDocumentsAsync_RequestBody
object
1 property
GetDiscoveredDocumentsRequest
object
7 properties
MappableFieldNonPaginated
object
3 properties
GetDiscoveredDocumentsWithPivotOnResponse
object
3 properties
ProcessingSetDocumentInfoSummary
object
4 properties
GetOtherFieldsAsync_RequestBody
object
3 properties
GetInvariantFieldsAsync_RequestBody
object
1 property
ProcessFilesToDeleteAsync_RequestBody
object
1 property
CatalogField
object
7 properties
FieldMappingRequest
object
2 properties
RetryDocumentErrorsAsync_RequestBody
object
1 property
ValidateFieldObjectsAsync_RequestBody
object
2 properties
ProcessingSetDocumentInfo
object
5 properties
DataSourceValidateDeleteResponse
object
2 properties
ExternalMapping
object
16 properties
ProcessingDocumentsRequest
object
2 properties
MappableSourceField
object
7 properties
RetrievePublishableDocumentCountAsync_RequestBody
object
1 property
FieldMappingResponse
object
2 properties
ProcessingSetState
object
6 properties
GetAllMappedFieldsAsync_RequestBody
object
1 property
GetDiscoveredDocumentIdsAsync_RequestBody
object
1 property
UpdateExternalMappingAsync_RequestBody
object
3 properties
PivotOnDiscoveredDocumentsAsync_RequestBody
object
1 property
FieldFilter
object
5 properties
ProcessingFilterData
object
3 properties
ProcessingDocumentErrorInfo
object
5 properties
ProcessingSetSummaryData
object
8 properties
GetDiscoveredDocumentListRequest
object
5 properties
ExportColumn
object
2 properties
ApplyProcessingFilterRequest
object
1 property
PublishDocumentsAsync_RequestBody
object
1 property
CreateExpressionFilterAsync_RequestBody
object
1 property
SortOption
object
2 properties
ProcessingFilter
object
3 properties
UpdateProcessingExpressionFilterRequest
object
4 properties
MappableFieldsResponse
object
1 property
ConfirmProcessedFilesDeletionAsync_RequestBody
object
1 property
GetProcessedFilesToDeleteResponse
object
3 properties
FileData
object
2 properties
ProcessingProfileRef
object
3 properties
GetPublishJobErrorsAsync_RequestBody
object
1 property
ProcessingDocumentErrorHistoryResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

relativity-processing-module-v1-api-openapi.yml Raw ↑

Other APIs Relativity publishes across the network.

Relativity AnnotationService API
AE Profile APIs.io
Relativity ArchiveJobs API
AE Profile APIs.io
Relativity ARM Module v1 API
AE Profile APIs.io
Relativity ARM Module v3 API
AE Profile APIs.io
Relativity BillableSummaryReports API
AE Profile APIs.io
Relativity BillingConfiguration API
AE Profile APIs.io
Relativity BillingInsights API
AE Profile APIs.io
Relativity Client Side Libraries Module API
AE Profile APIs.io
Relativity ColdStorage API
AE Profile APIs.io
Relativity CollectAPI API
AE Profile APIs.io
Relativity Conceptual Analytics v1 API
AE Profile APIs.io
Relativity Directory API
AE Profile APIs.io
#Processing Module v1
← Back to R APIs
API Details
ID
relativity:relativity-processing-module-v1-api
Base URL
https://{host}/Relativity.REST/api/relativity-object-model/v1
Docs
https://platform.relativity.com/RelativityOne/Content/REST_API/REST_API.htm
Provider
Relativity
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network