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

Relativity Processing Module v2 API

The Processing Module v2 API from Relativity — 19 operation(s) for processing module v2.

Relativity Processing Module v2 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 v2. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, rate-limit docs, and a getting-started guide.

This API exposes 21 operations across 19 paths, and defines 39 schemas. It is described by OpenAPI 3.0.1, at version V1.

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

21 operations 19 paths 39 schemas 1 DELETE6 GET13 POST1 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 21

Across 19 paths, the API surfaces 21 operations — 1 DELETE, 6 GET, 13 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Processing Module v2 21
GET
/relativity-processing/v2/workspaces/{workspaceID}/metadata
[Public] IProcessingDocumentManager -
Relativity.Processing.V2.Services.IProcessingDocumentManager.GetDocumentMetadataAsync 3 params → 200
POST
/relativity-processing/v2/workspaces/{workspaceID}/documents/metadata
[Public] IProcessingDocumentManager -
Relativity.Processing.V2.Services.IProcessingDocumentManager.GetDocumentsMetadataAsync 2 params body → 200
POST
/relativity-processing/v2/workspaces/{workspaceID}/documents/get-file-paths
[Public] IProcessingDocumentManager -
Relativity.Processing.V2.Services.IProcessingDocumentManager.GetFilePathsAsync 2 params body → 200
GET
/relativity-processing/v2/workspaces/{workspaceID}/errors
[Public] IProcessingDocumentManager -
Relativity.Processing.V2.Services.IProcessingDocumentManager.GetDocumentErrorHistoryAsync 3 params body → 200
POST
/relativity-processing/v2/workspaces/{workspaceID}/documents/retry-delete
[Public] IProcessingDocumentManager -
Relativity.Processing.V2.Services.IProcessingDocumentManager.RetryDeleteDocumentAsync 2 params body → 200
POST
/relativity-processing/v2/workspaces/{workspaceID}/documents/retry-errors
[Public] IProcessingDocumentManager -
Relativity.Processing.V2.Services.IProcessingDocumentManager.RetryDocumentErrorsAsync 2 params body → 200
POST
/relativity-processing/v2/workspaces/{workspaceID}/documents/publish
[Public] IProcessingDocumentManager -
Relativity.Processing.V2.Services.IProcessingDocumentManager.PublishDocumentsAsync 2 params body → 200
POST
/relativity-processing/v2/workspaces/{workspaceID}/documents/get-publish-job-errors
[Public] IProcessingDocumentManager -
Relativity.Processing.V2.Services.IProcessingDocumentManager.GetPublishJobErrorsAsync 2 params body → 200
POST
/relativity-processing/v2/workspaces/{workspaceID}/documents/count
[Public] IProcessingDocumentManager -
Relativity.Processing.V2.Services.IProcessingDocumentManager.RetrievePublishableDocumentCountAsync 2 params body → 200
POST
/relativity-processing/v2/workspaces/{workspaceID}/filters
[Public] IProcessingFilterManager -
Relativity.Processing.V2.Services.IProcessingFilterManager.CreateExpressionFilterAsync 2 params body → 201
GET
/relativity-processing/v2/workspaces/{workspaceID}/filters
[Public] IProcessingFilterManager -
Relativity.Processing.V2.Services.IProcessingFilterManager.GetFiltersAsync 2 params → 200
GET
/relativity-processing/v2/workspaces/{workspaceID}/filters/results/{filterID}
[Public] IProcessingFilterManager -
Relativity.Processing.V2.Services.IProcessingFilterManager.GetFilterResultAsync 3 params body → 200
GET
/relativity-processing/v2/workspaces/{workspaceID}/filters/data-sources/{dataSourceID}/filters
[Public] IProcessingFilterManager -
Relativity.Processing.V2.Services.IProcessingFilterManager.GetFiltersByDataSourceAsync 3 params → 200
PUT
/relativity-processing/v2/workspaces/{workspaceID}/filters/{filterID}
[Public] IProcessingFilterManager -
Relativity.Processing.V2.Services.IProcessingFilterManager.UpdateExpressionFilterAsync 3 params body → 200
DELETE
/relativity-processing/v2/workspaces/{workspaceID}/filters/{filterID}
[Public] IProcessingFilterManager -
Relativity.Processing.V2.Services.IProcessingFilterManager.DeleteFilterAsync 3 params → 200
POST
/relativity-processing/v2/workspaces/{workspaceID}/filters/documents
[Public] IProcessingFilterManager -
Relativity.Processing.V2.Services.IProcessingFilterManager.GetDiscoveredDocumentsAsync 2 params body → 200
POST
/relativity-processing/v2/workspaces/{workspaceID}/filters/pivot-discovered-documents
[Public] IProcessingFilterManager -
Relativity.Processing.V2.Services.IProcessingFilterManager.PivotOnDiscoveredDocumentsAsync 2 params body → 200
POST
/relativity-processing/v2/workspaces/{workspaceID}/filters/csvs
[Public] IProcessingFilterManager -
Relativity.Processing.V2.Services.IProcessingFilterManager.DownloadDiscoveredDocumentListAsync 2 params body → 200
GET
/relativity-processing/v2/workspaces/{workspaceID}/filters/get-nisted-documents
[Public] IProcessingFilterManager -
Relativity.Processing.V2.Services.IProcessingFilterManager.DownloadNistedDocumentListAsync 2 params body → 200
POST
/relativity-processing/v2/workspaces/{workspaceID}/filters/document-ids
[Public] IProcessingFilterManager -
Relativity.Processing.V2.Services.IProcessingFilterManager.GetDiscoveredDocumentIdsAsync 2 params body → 200
POST
/relativity-processing/v2/workspaces/{workspaceID}/job-exception/get-total-count-by-set
[Public] IProcessingJobExceptionManager -
Relativity.Processing.V2.Services.IProcessingJobExceptionManager.GetTotalJobExceptionCountAsync 2 params body → 200

Schemas 39

The contract defines 39 schemas that model the data the API accepts and returns. The most detailed are ProcessingFilterResult (46 properties), GetDiscoveredDocumentsRequest (8 properties), GetDiscoveredDocumentListRequest (7 properties), GetDiscoveredDocumentsWithPivotOnResponse (5 properties). Each schema is shown below with its type and property counts.

ProcessingLogicalIdResults
object
3 properties
PivotOnOption
object
4 properties
ProcessingFilterData
object
4 properties
GetDocumentsMetadataAsync_RequestBody
object
1 property
PublishJobErrorInfoResponse
object
4 properties
ProcessingFilePathResponse
object
2 properties
ProcessingDocumentErrorInfo
object
5 properties
ProcessingDocumentErrorHistoryResponse
object
2 properties
ProcessingMetadataResponse
object
4 properties
GetTotalJobExceptionCountRequest
object
1 property
GetDiscoveredDocumentListRequest
object
7 properties
ExportColumn
object
2 properties
RetryDocumentErrorsAsync_RequestBody
object
1 property
GetDiscoveredDocumentsWithPivotOnRequest
object
3 properties
ProcessingFilterResult
object
46 properties
ProcessingMetadataRequest
object
1 property
GetFilterResultAsync_RequestBody
object
2 properties
PublishDocumentsAsync_RequestBody
object
1 property
DownloadDiscoveredDocumentListAsync_RequestBody
object
1 property
CreateExpressionFilterAsync_RequestBody
object
1 property
DownloadNistedDocumentListAsync_RequestBody
object
1 property
ProcessingDocumentsRequest
object
3 properties
RetrievePublishableDocumentCountAsync_RequestBody
object
1 property
CreateProcessingExpressionFilterRequest
object
4 properties
SortOption
object
2 properties
IKeplerStream
object
5 properties
GetFilePathsAsync_RequestBody
object
1 property
ProcessingFilter
object
3 properties
UpdateProcessingExpressionFilterRequest
object
4 properties
GetTotalJobExceptionCountAsync_RequestBody
object
1 property
RetryDeleteDocumentAsync_RequestBody
object
1 property
GetDocumentErrorHistoryAsync_RequestBody
object
2 properties
UpdateExpressionFilterAsync_RequestBody
object
1 property
GetDiscoveredDocumentIdsAsync_RequestBody
object
1 property
GetPublishJobErrorsAsync_RequestBody
object
1 property
GetDiscoveredDocumentsAsync_RequestBody
object
1 property
GetDiscoveredDocumentsRequest
object
8 properties
GetDiscoveredDocumentsWithPivotOnResponse
object
5 properties
PivotOnDiscoveredDocumentsAsync_RequestBody
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

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