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 Workspace API

The Workspace API from Relativity — 2 operation(s) for workspace.

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

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

This API exposes 4 operations across 2 paths, and defines 14 schemas. It is described by OpenAPI 3.0.1, at version V1.

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

4 operations 2 paths 14 schemas 1 DELETE2 GET1 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 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Workspace 4
GET
/v1/workspace/{workspaceId}
Read workspace
1 param → 200401403404567500
DELETE
/v1/workspace/{workspaceId}
Delete workspace
1 param → 204400401404500
PUT
/v1/workspace/{workspaceId}
Update workspace
1 param body → 200400401403404409500
GET
/v1/workspace/{workspaceId}/{includeMetadata}/{includeActions}
Read workspace with optional metadata and actions
3 params → 200401403404567500

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are WorkspaceReadResponseV1 (30 properties), WorkspaceUpdateRequest (20 properties), Action (5 properties), ProblemDetails (5 properties). Each schema is shown below with its type and property counts.

KeplerValidationError
object
2 properties
WorkspaceUpdateRequest
object
20 properties
DisplayableObjectIdentifierSecurable
object
2 properties
WorkspaceReadResponseV1
object
30 properties
StringSecurable
object
2 properties
ObjectIdentifier
object
2 properties
ProblemDetails
object
5 properties
DisplayableObjectIdentifier
object
3 properties
NameIDPair
object
2 properties
Meta
object
2 properties
ObjectIdentifierSecurable
object
2 properties
Action
object
5 properties
WorkspaceRequestEnvelope
object
2 properties 1 required
KeplerProblemDetails
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

relativity-workspace-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