Relativity Processing Module v1 API
The Processing Module v1 API from Relativity — 51 operation(s) for processing module v1.
Relativity Processing Module v1 API is one of 52 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.2.0, 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.
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
Relativity processing V1 services IFile deletion manager process files to…
POST
/relativity-processing/v1/file-deletion/confirm-processed-files-deletion
Relativity processing V1 services IFile deletion manager confirm processed…
PUT
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings
Relativity processing V1 services IField mapping manager update external…
GET
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings/auto/guids
Relativity processing V1 services IField mapping manager get auto mapped field…
GET
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings/available
Relativity processing V1 services IField mapping manager is field mapping…
GET
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings/invariant
Relativity processing V1 services IField mapping manager get invariant fields…
POST
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings/pages
Relativity processing V1 services IField mapping manager get invariant fields…
POST
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings/metadata-fields
Relativity processing V1 services IField mapping manager get metadata fields…
POST
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings/other-fields
Relativity processing V1 services IField mapping manager get other fields async
GET
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings/source-field
Relativity processing V1 services IField mapping manager get mappable source…
GET
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings/external
Relativity processing V1 services IField mapping manager read external mapping…
POST
/relativity-processing/v1/workspaces/{workspaceID}/data-sources/{dataSourceID}/field-mappings/relativity
Relativity processing V1 services IField mapping manager get all mapped fields…
GET
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings/catalog-fields
Relativity processing V1 services IField mapping manager get catalog fields…
GET
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings/invariant-catalog-field-mapping
Relativity processing V1 services IField mapping manager get invariant field…
GET
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings/get-mappable-fields
Relativity processing V1 services IField mapping manager get new mappable…
GET
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings/validate-type
Relativity processing V1 services IField mapping manager validate field type…
GET
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings/validate-length
Relativity processing V1 services IField mapping manager validate field length…
PUT
/relativity-processing/v1/workspaces/{workspaceID}/field-mappings/validate-fields
Relativity processing V1 services IField mapping manager validate field objects…
GET
/relativity-processing/v1/workspaces/{workspaceID}/documents/{fileID}/metadata
Relativity processing V1 services IProcessing document manager get document…
GET
/relativity-processing/v1/workspaces/{workspaceID}/documents/{fileID}/errors
Relativity processing V1 services IProcessing document manager get document…
POST
/relativity-processing/v1/workspaces/{workspaceID}/documents/retry
Relativity processing V1 services IProcessing document manager retry delete…
POST
/relativity-processing/v1/workspaces/{workspaceID}/documents/retry-errors
Relativity processing V1 services IProcessing document manager retry document…
POST
/relativity-processing/v1/workspaces/{workspaceID}/documents/publish
Relativity processing V1 services IProcessing document manager publish…
POST
/relativity-processing/v1/workspaces/{workspaceID}/documents/get-publish-job-errors
Relativity processing V1 services IProcessing document manager get publish job…
POST
/relativity-processing/v1/workspaces/{workspaceID}/documents/count
Relativity processing V1 services IProcessing document manager retrieve…
POST
/relativity-processing/v1/workspaces/{workspaceID}/filters
Relativity processing V1 services IProcessing filter manager create expression…
GET
/relativity-processing/v1/workspaces/{workspaceID}/filters
Relativity processing V1 services IProcessing filter manager get filters async
POST
/relativity-processing/v1/workspaces/{workspaceID}/filters/{filterID}/apply
Relativity processing V1 services IProcessing filter manager apply filter async
GET
/relativity-processing/v1/workspaces/{workspaceID}/filters/results/{filterID}
Relativity processing V1 services IProcessing filter manager get filter result…
GET
/relativity-processing/v1/workspaces/{workspaceID}/filters/data-sources/{dataSourceID}/filters
Relativity processing V1 services IProcessing filter manager get filters by…
PUT
/relativity-processing/v1/workspaces/{workspaceID}/filters/{filterID}
Relativity processing V1 services IProcessing filter manager update expression…
DELETE
/relativity-processing/v1/workspaces/{workspaceID}/filters/{filterID}
Relativity processing V1 services IProcessing filter manager delete filter async
POST
/relativity-processing/v1/workspaces/{workspaceID}/filters/documents
Relativity processing V1 services IProcessing filter manager get discovered…
POST
/relativity-processing/v1/workspaces/{workspaceID}/filters/document-ids
Relativity processing V1 services IProcessing filter manager get discovered…
POST
/relativity-processing/v1/workspaces/{workspaceID}/filters/csvs
Relativity processing V1 services IProcessing filter manager prepare discovered…
POST
/relativity-processing/v1/workspaces/{workspaceID}/filters/pivot-discovered-documents
Relativity processing V1 services IProcessing filter manager pivot on…
GET
/relativity-processing/v1/workspaces/{workspaceID}/filters/csvs/{requestGuid}
Relativity processing V1 services IProcessing filter manager download…
GET
/relativity-processing/v1/workspaces/{workspaceID}/custodians/{custodianID}
Relativity processing V1 services IProcessing custodian manager read async
PUT
/relativity-processing/v1/workspaces/{workspaceID}/custodians/{custodianID}
Relativity processing V1 services IProcessing custodian manager update async
POST
/relativity-processing/v1/workspaces/{workspaceID}/custodians
Relativity processing V1 services IProcessing custodian manager create async
GET
/relativity-processing/v1/workspaces/{workspaceID}/data-sources/{dataSourceID}
Relativity processing V1 services IProcessing data source manager read async
PUT
/relativity-processing/v1/workspaces/{workspaceID}/data-sources/{dataSourceID}
Relativity processing V1 services IProcessing data source manager update async
POST
/relativity-processing/v1/workspaces/{workspaceID}/data-sources
Relativity processing V1 services IProcessing data source manager create async
GET
/relativity-processing/v1/workspaces/{workspaceID}/data-sources/{processingDataSourceID}/delete-validation
Relativity processing V1 services IProcessing data source manager validate…
GET
/relativity-processing/v1/workspaces/{workspaceID}/data-sources/source-location-paths
Relativity processing V1 services IProcessing data source manager retrieve…
GET
/relativity-processing/v1/workspaces/{workspaceID}/data-sources/profile-presets/{profileId}
Relativity processing V1 services IProcessing data source manager retrieve…
POST
/relativity-processing/v1/workspaces/{workspaceID}/processing-jobs/{processingSetID}/cancel
Relativity processing V1 services IProcessing job manager submit cancel job…
POST
/relativity-processing/v1/workspaces/{workspaceID}/processing-jobs/{processingSetID}/discover
Relativity processing V1 services IProcessing job manager submit discovery jobs…
POST
/relativity-processing/v1/workspaces/{workspaceID}/processing-jobs/{processingSetID}/inventory
Relativity processing V1 services IProcessing job manager submit inventory jobs…
POST
/relativity-processing/v1/workspaces/{workspaceID}/processing-jobs/{processingSetID}/publish
Relativity processing V1 services IProcessing job manager submit publish jobs…
POST
/relativity-processing/v1/workspaces/{workspaceID}/processing-jobs/{processingSetID}/retry-errors
Relativity processing V1 services IProcessing job manager submit retry errors…
GET
/relativity-processing/v1/workspaces/{workspaceID}/processing-sets/{processingSetID}
Relativity processing V1 services IProcessing set manager read async
PUT
/relativity-processing/v1/workspaces/{workspaceID}/processing-sets/{processingSetID}
Relativity processing V1 services IProcessing set manager update async
POST
/relativity-processing/v1/workspaces/{workspaceID}/processing-sets
Relativity processing V1 services IProcessing set manager create async
GET
/relativity-processing/v1/workspaces/{workspaceID}/processing-sets/documents
Relativity processing V1 services IProcessing set manager get document…
GET
/relativity-processing/v1/workspaces/{workspaceID}/processing-sets/{processingSetID}/summary
Relativity processing V1 services IProcessing set manager get summary data async
Schemas 74
The contract defines 74 schemas that model the data the API accepts and returns. The most detailed are ProcessingFilterResult (40 properties), ProcessingDataSource (16 properties), ExternalMapping (16 properties), ProcessingSetSummaryData (8 properties). Each schema is shown below with its type and property counts.
ProcessingProfileRef
object
3 properties
GetInvariantFieldsAsync_RequestBody
object
1 property
GetInvariantFieldsPaginatedAsync_RequestBody
object
3 properties
RetryDeleteDocumentAsync_RequestBody
object
1 property
CatalogField
object
7 properties
FieldMappingResponse
object
2 properties
PrepareDiscoveredDocumentListAsync_RequestBody
object
1 property
ProcessingDocumentErrorInfo
object
5 properties
ReadExternalMappingAsync_RequestBody
object
2 properties
GetAllMappedFieldsAsync_RequestBody
object
1 property
PublishJobErrorInfoResponse
object
5 properties
FieldFilter
object
5 properties
ValidateFieldObjectsAsync_RequestBody
object
2 properties
ConfirmProcessedFilesDeletionAsync_RequestBody
object
1 property
PivotOnDiscoveredDocumentsAsync_RequestBody
object
1 property
ProcessingFilterResult
object
40 properties
ValidateFieldTypeMappingAsync_RequestBody
object
2 properties
MappableFieldNonPaginated
object
3 properties
GetDiscoveredDocumentsAsync_RequestBody
object
1 property
GetDiscoveredDocumentsWithPivotOnRequest
object
2 properties
ApplyProcessingFilterRequest
object
1 property
CreateAsync_RequestBody
object
1 property
ProcessingDocumentsRequest
object
2 properties
ExternalMapping
object
16 properties
GetDiscoveredDocumentListRequest
object
5 properties
ProcessingFilter
object
3 properties
UpdateAsync_RequestBody
object
1 property
GetDocumentErrorHistoryAsync_RequestBody
object
2 properties
ProcessingSetRef
object
2 properties
ProcessingSetDocumentInfoSummary
object
4 properties
FieldMappingRequest
object
2 properties
ExportColumn
object
2 properties
GetDiscoveredDocumentsWithPivotOnResponse
object
3 properties
ProcessingMetadataResponse
object
4 properties
GetMappableSourceFieldAsync_RequestBody
object
1 property
ProcessingSetDocumentInfo
object
5 properties
ProcessingSetSummaryData
object
8 properties
ProcessingDataSource
object
16 properties
GetNewMappableFieldsNonPaginatedAsync_RequestBody
object
1 property
ProcessingSet
object
4 properties
ProcessingFileIdResults
object
3 properties
UpdateProcessingExpressionFilterRequest
object
4 properties
ProcessingSetState
object
6 properties
UpdateExternalMappingAsync_RequestBody
object
3 properties
DataSourceValidateDeleteResponse
object
2 properties
RetrievePublishableDocumentCountAsync_RequestBody
object
1 property
RetryDocumentErrorsAsync_RequestBody
object
1 property
SortOption
object
2 properties
ProcessingCustodian
object
8 properties
ProcessingDocumentErrorHistoryResponse
object
2 properties
GetOtherFieldsAsync_RequestBody
object
3 properties
PrepareDiscoveredDocumentListResponse
object
1 property
ProcessFilesToDeleteAsync_RequestBody
object
1 property
GetPublishJobErrorsAsync_RequestBody
object
1 property
ProcessingFilterData
object
3 properties
GetDocumentAggregates_RequestBody
object
4 properties
FieldSortingOption
object
2 properties
PublishDocumentsAsync_RequestBody
object
1 property
ApplyFilterAsync_RequestBody
object
1 property
MappableSourceField
object
7 properties
CreateProcessingExpressionFilterRequest
object
4 properties
GetDiscoveredDocumentsRequest
object
7 properties
FileData
object
2 properties
GetMetadataFieldsAsync_RequestBody
object
3 properties
ValidateFieldLengthAsync_RequestBody
object
3 properties
GetFilterResultAsync_RequestBody
object
2 properties
CreateExpressionFilterAsync_RequestBody
object
1 property
PivotOnOption
object
6 properties
GetDiscoveredDocumentIdsAsync_RequestBody
object
1 property
UpdateExpressionFilterAsync_RequestBody
object
1 property
IKeplerStream
object
5 properties
MappableFieldsResponse
object
1 property
DefaultProcessingDataSourceOptionsResponse
object
6 properties
GetProcessedFilesToDeleteResponse
object
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Relativity 12
Other APIs Relativity publishes across the network.
Relativity AnnotationService API
Relativity ArchiveJobs API
Relativity ARM Module v1 API
Relativity ARM Module v3 API
Relativity BillableSummaryReports API
Relativity BillingConfiguration API
Relativity BillingInsights API
Relativity Client Side Libraries Module API
Relativity ColdStorage API
Relativity CollectAPI API
Relativity Conceptual Analytics v1 API
Relativity Directory API
#Processing Module v1
Where this information came from
This is an independent, third-party profile of Relativity Processing Module v1 API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.