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 ARM Module v3 API

The ARM Module v3 API from Relativity — 7 operation(s) for arm module v3.

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

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

This API exposes 11 operations across 7 paths, and defines 24 schemas. It is described by OpenAPI 3.0.1, at version V1.

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

11 operations 7 paths 24 schemas 2 DELETE3 GET4 POST2 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 11

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

ARM Module v3 11
POST
/relativity-arm/v3/restore-jobs
[Public] ARM Restore Manager V3
Relativity.ARM.Services.Interfaces.V3.Restore.IArmRestoreJobManager.CreateAsync 1 param body → 200
GET
/relativity-arm/v3/restore-jobs/{jobID}
[Public] ARM Restore Manager V3
Relativity.ARM.Services.Interfaces.V3.Restore.IArmRestoreJobManager.ReadAsync 2 params → 200
PUT
/relativity-arm/v3/restore-jobs/{jobID}
[Public] ARM Restore Manager V3
Relativity.ARM.Services.Interfaces.V3.Restore.IArmRestoreJobManager.UpdateAsync 2 params body → 200
DELETE
/relativity-arm/v3/restore-jobs/{jobID}
[Public] ARM Restore Manager V3
Relativity.ARM.Services.Interfaces.V3.Restore.IArmRestoreJobManager.DeleteAsync 2 params → 200
GET
/relativity-arm/v3/jobs/{jobID}/status
[Public] ARM Job Information Manager V3
Relativity.ARM.Services.Interfaces.V3.JobInformation.IArmJobInformationManager.GetJobStatusAsync 2 params → 200
POST
/relativity-arm/v3/jobs/{jobID}/cancel
[Public] ARM Job Actions Manager
Relativity.ARM.Services.Interfaces.V3.JobAction.IArmJobActionManager.CancelAsync 2 params body → 200
POST
/relativity-arm/v3/jobs/{jobID}/run
[Public] ARM Job Actions Manager
Relativity.ARM.Services.Interfaces.V3.JobAction.IArmJobActionManager.RunAsync 2 params body → 200
POST
/relativity-arm/v3/archive-jobs
[Public] ARM Archive Manager V3
Relativity.ARM.Services.Interfaces.V3.Archive.IArmArchiveJobManager.CreateAsync 1 param body → 200
GET
/relativity-arm/v3/archive-jobs/{jobID}
[Public] ARM Archive Manager V3
Relativity.ARM.Services.Interfaces.V3.Archive.IArmArchiveJobManager.ReadAsync 2 params → 200
PUT
/relativity-arm/v3/archive-jobs/{jobID}
[Public] ARM Archive Manager V3
Relativity.ARM.Services.Interfaces.V3.Archive.IArmArchiveJobManager.UpdateAsync 2 params body → 200
DELETE
/relativity-arm/v3/archive-jobs/{jobID}
[Public] ARM Archive Manager V3
Relativity.ARM.Services.Interfaces.V3.Archive.IArmArchiveJobManager.DeleteAsync 2 params → 200

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are RestoreJobResponse_V3 (12 properties), ArchiveJobResponse_V3 (10 properties), RestoreJobRequest_V3 (8 properties), ArchiveJobRequest_V3 (8 properties). Each schema is shown below with its type and property counts.

JobActions_V3
object
3 properties
IArmArchiveJobManager_V3_UpdateAsync_RequestBody
object
1 property
IArmRestoreJobManager_V3_UpdateAsync_RequestBody
object
1 property
RestoreJobResponse_V3
object
12 properties
CreateArchiveJobResponse_V3
object
1 property
UpdateArchiveJobResponse_V3
object
CreateRestoreJobResponse_V3
object
1 property
ArchiveJobResponse_V3
object
10 properties
IArmJobActionManager_V3_CancelAsync_RequestBody
object
1 property
CancelJobResponse_V3
object
JobProgressResponse_V3
object
2 properties
JobDetails_V3
object
2 properties
RestoreJobRequest_V3
object
8 properties
RunJobRequest_V3
object
RestoreDestinationOptions_V3
object
1 property
UpdateRestoreJobResponse_V3
object
NotificationOptions_V3
object
2 properties
ArchiveJobRequest_V3
object
8 properties
IArmRestoreJobManager_V3_CreateAsync_RequestBody
object
1 property
IArmArchiveJobManager_V3_CreateAsync_RequestBody
object
1 property
MigratorOptions_V3
object
IArmJobActionManager_V3_RunAsync_RequestBody
object
1 property
CancelJobRequest_V3
object
RunJobResponse_V3
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

relativity-arm-module-v3-api-openapi.yml Raw ↑

Other APIs Relativity publishes across the network.

Relativity AnnotationService API
Relativity ArchiveJobs API
Relativity ARM Module v1 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
Relativity Document Configuration Module API