How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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 52 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.2.0, at version V1,V3.

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.2.0
API Version
V1,V3
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
Relativity ARM services interfaces V3 restore IArm restore job manager create…
Relativity.ARM.Services.Interfaces.V3.Restore.IArmRestoreJobManager.CreateAsync 1 param body → 200
GET
/relativity-arm/v3/restore-jobs/{jobID}
Relativity ARM services interfaces V3 restore IArm restore job manager read…
Relativity.ARM.Services.Interfaces.V3.Restore.IArmRestoreJobManager.ReadAsync 2 params → 200
PUT
/relativity-arm/v3/restore-jobs/{jobID}
Relativity ARM services interfaces V3 restore IArm restore job manager update…
Relativity.ARM.Services.Interfaces.V3.Restore.IArmRestoreJobManager.UpdateAsync 2 params body → 200
DELETE
/relativity-arm/v3/restore-jobs/{jobID}
Relativity ARM services interfaces V3 restore IArm restore job manager delete…
Relativity.ARM.Services.Interfaces.V3.Restore.IArmRestoreJobManager.DeleteAsync 2 params → 200
GET
/relativity-arm/v3/jobs/{jobID}/status
Relativity ARM services interfaces V3 job information IArm job information…
Relativity.ARM.Services.Interfaces.V3.JobInformation.IArmJobInformationManager.GetJobStatusAsync 2 params → 200
POST
/relativity-arm/v3/jobs/{jobID}/cancel
Relativity ARM services interfaces V3 job action IArm job action manager cancel…
Relativity.ARM.Services.Interfaces.V3.JobAction.IArmJobActionManager.CancelAsync 2 params body → 200
POST
/relativity-arm/v3/jobs/{jobID}/run
Relativity ARM services interfaces V3 job action IArm job action manager run…
Relativity.ARM.Services.Interfaces.V3.JobAction.IArmJobActionManager.RunAsync 2 params body → 200
POST
/relativity-arm/v3/archive-jobs
Relativity ARM services interfaces V3 archive IArm archive job manager create…
Relativity.ARM.Services.Interfaces.V3.Archive.IArmArchiveJobManager.CreateAsync 1 param body → 200
GET
/relativity-arm/v3/archive-jobs/{jobID}
Relativity ARM services interfaces V3 archive IArm archive job manager read…
Relativity.ARM.Services.Interfaces.V3.Archive.IArmArchiveJobManager.ReadAsync 2 params → 200
PUT
/relativity-arm/v3/archive-jobs/{jobID}
Relativity ARM services interfaces V3 archive IArm archive job manager update…
Relativity.ARM.Services.Interfaces.V3.Archive.IArmArchiveJobManager.UpdateAsync 2 params body → 200
DELETE
/relativity-arm/v3/archive-jobs/{jobID}
Relativity ARM services interfaces V3 archive IArm archive job manager delete…
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.

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

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
Where this information came from

This is an independent, third-party profile of Relativity ARM Module v3 API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.