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 Object Manager v1 API

The Object Manager v1 API from Relativity — 12 operation(s) for object manager v1.

Relativity Object Manager 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 Object Manager 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 12 operations across 12 paths, and defines 53 schemas. It is described by OpenAPI 3.0.1, at version V1.

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

12 operations 12 paths 53 schemas 12 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 12

Across 12 paths, the API surfaces 12 operations — 12 POST. Each is listed below with its method, path, parameters, and response codes.

Object Manager v1 12
POST
/Relativity.ObjectManager/v1/workspace/{workspaceID}/object/query
[Public] IObjectManager -
Relativity.ObjectManager.Server.ObjectManager.V1.Manager.IObjectManager.QueryAsync 4 params body → 200
POST
/Relativity.ObjectManager/v1/workspace/{workspaceID}/object/update
[Public] IObjectManager -
Relativity.ObjectManager.Server.ObjectManager.V1.Manager.IObjectManager.UpdateAsync 2 params body → 200
POST
/Relativity.ObjectManager/v1/workspace/{workspaceID}/object/read
[Public] IObjectManager -
Relativity.ObjectManager.Server.ObjectManager.V1.Manager.IObjectManager.ReadAsync 2 params body → 200
POST
/Relativity.ObjectManager/v1/workspace/{workspaceID}/object/delete
[Public] IObjectManager -
Relativity.ObjectManager.Server.ObjectManager.V1.Manager.IObjectManager.DeleteAsync 2 params body → 200
POST
/Relativity.ObjectManager/v1/workspace/{workspaceID}/object/create
[Public] IObjectManager -
Relativity.ObjectManager.Server.ObjectManager.V1.Manager.IObjectManager.CreateAsync 2 params body → 200
POST
/Relativity.ObjectManager/v1/workspace/{workspaceID}/object/queryslim
[Public] IObjectManager -
Relativity.ObjectManager.Server.ObjectManager.V1.Manager.IObjectManager.QuerySlimAsync 4 params body → 200
POST
/Relativity.ObjectManager/v1/workspace/{workspaceID}/object/streamlongtext
[Public] IObjectManager -
Relativity.ObjectManager.Server.ObjectManager.V1.Manager.IObjectManager.StreamLongTextAsync 2 params body → 200
POST
/Relativity.ObjectManager/v1/workspace/{workspaceID}/object/initializeexport
[Public] IObjectManager -
Relativity.ObjectManager.Server.ObjectManager.V1.Manager.IObjectManager.InitializeExportAsync 3 params body → 200
POST
/Relativity.ObjectManager/v1/workspace/{workspaceID}/object/retrievenextresultsblockfromexport
[Public] IObjectManager -
Relativity.ObjectManager.Server.ObjectManager.V1.Manager.IObjectManager.RetrieveNextResultsBlockFromExportAsync 4 params → 200
POST
/Relativity.ObjectManager/v1/workspace/{workspaceID}/object/retrieveresultsblockfromexport
[Public] IObjectManager -
Relativity.ObjectManager.Server.ObjectManager.V1.Manager.IObjectManager.RetrieveResultsBlockFromExportAsync 5 params → 200
POST
/Relativity.ObjectManager/v1/workspace/{workspaceID}/object/updatelongtextfromstream
[Public] IObjectManager -
Relativity.ObjectManager.Server.ObjectManager.V1.Manager.IObjectManager.UpdateLongTextFromStreamAsync 2 params body → 200
POST
/Relativity.ObjectManager/v1/workspace/{workspaceID}/object/dependencylist
[Public] IObjectManager -
Relativity.ObjectManager.Server.ObjectManager.V1.Manager.IObjectManager.GetDependencyListAsync 2 params body → 200

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are QueryRequest (19 properties), QueryResultSlim (10 properties), QueryResult (9 properties), RelativityObject (6 properties). Each schema is shown below with its type and property counts.

Object
object
ReadRequest
object
2 properties
RelativityObjectRef
object
2 properties
UpdateLongTextFromStreamAsync_RequestBody
object
2 properties
DeleteRequest
object
1 property
ObjectTypeRef
object
4 properties
DependencyListByObjectIdentifiersRequest
object
1 property
FieldRefValuePair
object
2 properties
FieldRef
object
4 properties
EventHandlerStatus
object
3 properties
FieldMetadata
object
5 properties
SearchProviderCondition
object
2 properties
GetDependencyListAsync_RequestBody
object
1 property
SampleParameters
object
5 properties
RelativityObject
object
6 properties
QueryResult
object
9 properties
ExportInitializationResults
object
3 properties
QueryAsync_RequestBody
object
1 property
EventHandlerRef
object
3 properties
Sort
object
3 properties
ObjectType
object
4 properties
DeleteResult
object
1 property
UpdateRequest
object
3 properties
Securable1
object
2 properties
DeleteReport
object
1 property
Field
object
6 properties
UpdateLongTextFromStreamRequest
object
2 properties
LayoutRef
object
2 properties
IKeplerStream
object
5 properties
RelativityObjectSlim
object
2 properties
UpdateAsync_RequestBody
object
2 properties
QuerySlimAsync_RequestBody
object
1 property
CreateAsync_RequestBody
object
2 properties
InitializeExportAsync_RequestBody
object
1 property
UpdateResult
object
1 property
QueryRequest
object
19 properties
UpdateOptions
object
2 properties
DeleteItem
object
4 properties
CreateResult
object
2 properties
CreateRequest
object
3 properties
StreamLongTextAsync_RequestBody
object
2 properties
SampleDetails
object
3 properties
OperationOptions
object
1 property
DisplayableObjectIdentifier
object
3 properties
ReadOptions
object
4 properties
ReadAsync_RequestBody
object
2 properties
Dependency
object
5 properties
ReadResult
object
5 properties
SearchIndexRef
object
2 properties
CallingContext
object
3 properties
FieldValuePair
object
2 properties
QueryResultSlim
object
10 properties
DeleteAsync_RequestBody
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

relativity-object-manager-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