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 Relativity Structured Analytics v1 API

The Relativity Structured Analytics v1 API from Relativity — 10 operation(s) for relativity structured analytics v1.

Relativity Relativity Structured Analytics 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 Relativity Structured Analytics 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 13 operations across 10 paths, and defines 15 schemas. It is described by OpenAPI 3.0.1, at version V1.

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

13 operations 10 paths 15 schemas 3 DELETE5 GET5 POST

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 13

Across 10 paths, the API surfaces 13 operations — 3 DELETE, 5 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Relativity Structured Analytics v1 13
POST
/relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs
[Public] IJobManager -
Relativity.StructuredAnalytics.V1.Jobs.IJobManager.RunAsync 3 params body → 201
GET
/relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs
[Public] IJobManager -
Relativity.StructuredAnalytics.V1.Jobs.IJobManager.GetStatusAsync 3 params → 200
POST
/relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs/prep
[Public] IJobManager -
Relativity.StructuredAnalytics.V1.Jobs.IJobManager.RunAnalysisPreparationAsync 3 params → 201
POST
/relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs/copy-to-legacy
[Public] IJobManager -
Relativity.StructuredAnalytics.V1.Jobs.IJobManager.RunCopyToLegacyAsync 3 params → 201
DELETE
/relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs/copy-to-legacy
[Public] IJobManager -
Relativity.StructuredAnalytics.V1.Jobs.IJobManager.CancelCopyToLegacyAsync 3 params → 200
DELETE
/relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs/
[Public] IJobManager -
Relativity.StructuredAnalytics.V1.Jobs.IJobManager.CancelAsync 4 params → 200
POST
/relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs/retry
[Public] IJobManager -
Relativity.StructuredAnalytics.V1.Jobs.IJobManager.RetryErrorsAsync 3 params → 200
GET
/relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs/tmq
[Public] IJobManager -
Relativity.StructuredAnalytics.V1.Jobs.IJobManager.GetTMQEntryAsync 3 params → 200
GET
/relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs/errors
[Public] IJobManager -
Relativity.StructuredAnalytics.V1.Jobs.IJobManager.GetErrorsAsync 5 params → 200
GET
/relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs/doc-errors
[Public] IJobManager -
Relativity.StructuredAnalytics.V1.Jobs.IJobManager.GetDocumentErrorsAsync 5 params → 200
POST
/relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs/doc-errors
[Public] IJobManager -
Relativity.StructuredAnalytics.V1.Jobs.IJobManager.GetDocumentErrorsAsync 3 params body → 200
GET
/relativity-structured-analytics/v1/workspaces/{workspaceID}/sets/{sasArtifactID}/jobs/valid-tasks
[Public] IJobManager -
Relativity.StructuredAnalytics.V1.Jobs.IJobManager.GetValidTasksAsync 3 params → 200
DELETE
/relativity-structured-analytics/v1/workspaces/{workspaceID}/choices
[Public] IJobManager -
Relativity.StructuredAnalytics.V1.Jobs.IJobManager.RemoveAllChoicesAsync 2 params → 200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are MasterJob (13 properties), JobState (12 properties), DocumentError (6 properties), JobResults (4 properties). Each schema is shown below with its type and property counts.

DocumentError
object
6 properties
OperationState
object
3 properties
Status
object
4 properties
MasterJob
object
13 properties
ValidTaskResult
object
2 properties
TextualNearDuplicatesStatistics
object
3 properties
AnalysisSettings
object
2 properties
StructuredAnalyticsSetError
object
4 properties
SASDocumentErrorsResponseObject
object
2 properties
JobState
object
12 properties
SASDocumentErrorsRequestObject
object
4 properties
EmailThreadingStatistics
object
3 properties
OperationResult
object
2 properties
JobResults
object
4 properties
NameNormalizationStatistics
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

relativity-relativity-structured-analytics-v1-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