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

The ARM Module v1 API from Relativity — 20 operation(s) for arm module v1.

Relativity ARM Module 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 ARM Module 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 28 operations across 20 paths, and defines 50 schemas. It is described by OpenAPI 3.0.1, at version V1.

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

28 operations 20 paths 50 schemas 5 DELETE10 GET9 POST4 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 28

Across 20 paths, the API surfaces 28 operations — 5 DELETE, 10 GET, 9 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

ARM Module v1 28
POST
/relativity-arm/v1/tasks/{taskId}/retrydeprecated
DEPRECATED
Relativity.ARM.Services.Interfaces.V1.TaskAction.IArmTaskActionManager.RetryFailedTaskAsync 2 params → 200
POST
/relativity-arm/v1/restore-jobsdeprecated
DEPRECATED - Use V3 API instead
Relativity.ARM.Services.Interfaces.V1.Restore.IArmRestoreJobManager.CreateAsync 1 param body → 200
GET
/relativity-arm/v1/restore-jobs/{jobID}deprecated
DEPRECATED - Use V3 API instead
Relativity.ARM.Services.Interfaces.V1.Restore.IArmRestoreJobManager.ReadAsync 2 params → 200
PUT
/relativity-arm/v1/restore-jobs/{jobID}deprecated
DEPRECATED - Use V3 API instead
Relativity.ARM.Services.Interfaces.V1.Restore.IArmRestoreJobManager.UpdateAsync 2 params body → 200
DELETE
/relativity-arm/v1/restore-jobs/{jobID}deprecated
DEPRECATED - Use V3 API instead
Relativity.ARM.Services.Interfaces.V1.Restore.IArmRestoreJobManager.DeleteAsync 2 params → 200
POST
/relativity-arm/v1/move-jobsdeprecated
DEPRECATED
Relativity.ARM.Services.Interfaces.V1.Move.IArmMoveJobManager.CreateAsync 1 param body → 200
GET
/relativity-arm/v1/move-jobs/{jobID}deprecated
DEPRECATED
Relativity.ARM.Services.Interfaces.V1.Move.IArmMoveJobManager.ReadAsync 2 params → 200
PUT
/relativity-arm/v1/move-jobs/{jobID}deprecated
DEPRECATED
Relativity.ARM.Services.Interfaces.V1.Move.IArmMoveJobManager.UpdateAsync 2 params body → 200
DELETE
/relativity-arm/v1/move-jobs/{jobID}deprecated
DEPRECATED
Relativity.ARM.Services.Interfaces.V1.Move.IArmMoveJobManager.DeleteAsync 2 params → 200
GET
/relativity-arm/v1/jobs/{jobID}/statusdeprecated
DEPRECATED - Use V3 API instead
Relativity.ARM.Services.Interfaces.V1.JobStatus.IArmJobStatusManager.ReadAsync 2 params → 200
GET
/relativity-arm/v1/jobs/{jobID}/logsdeprecated
DEPRECATED
Relativity.ARM.Services.Interfaces.V1.JobInformation.IArmJobInformationManager.DownloadLogAsync 2 params → 200
GET
/relativity-arm/v1/jobs/{jobExecutionId}/statisticsdeprecated
DEPRECATED
Relativity.ARM.Services.Interfaces.V1.JobInformation.IArmJobInformationManager.GetJobStatisticsAsync 2 params → 200
GET
/relativity-arm/v1/jobs/{jobExecutionID}/qualityCheckResultdeprecated
DEPRECATED
Relativity.ARM.Services.Interfaces.V1.JobInformation.IArmJobInformationManager.GetQualityCheckResultAsync 2 params → 200
POST
/relativity-arm/v1/jobs/{jobID}/canceldeprecated
DEPRECATED - Use V3 API instead
Relativity.ARM.Services.Interfaces.V1.JobAction.IArmJobActionManager.CancelAsync 2 params → 200
POST
/relativity-arm/v1/jobs/{jobID}/pausedeprecated
DEPRECATED
Relativity.ARM.Services.Interfaces.V1.JobAction.IArmJobActionManager.PauseAsync 2 params → 200
POST
/relativity-arm/v1/jobs/{jobID}/rundeprecated
DEPRECATED - Use V3 API instead
Relativity.ARM.Services.Interfaces.V1.JobAction.IArmJobActionManager.RunAsync 2 params → 200
DELETE
/relativity-arm/v1/jobs/{jobID}/terminatedeprecated
DEPRECATED
Relativity.ARM.Services.Interfaces.V1.JobAction.IArmJobActionManager.TerminateJobAsync 2 params → 200
GET
/relativity-arm/v1/health-checkdeprecated
DEPRECATED
Relativity.ARM.Services.Interfaces.V1.HealthCheck.IArmHealthCheckManager.HealthCheckAsync 1 param → 200
POST
/relativity-arm/v1/database-restore-jobsdeprecated
DEPRECATED
Relativity.ARM.Services.Interfaces.V1.DatabaseRestore.IArmDatabaseRestoreJobManager.CreateAsync 1 param body → 200
GET
/relativity-arm/v1/database-restore-jobs/{jobID}deprecated
DEPRECATED
Relativity.ARM.Services.Interfaces.V1.DatabaseRestore.IArmDatabaseRestoreJobManager.ReadAsync 2 params → 200
PUT
/relativity-arm/v1/database-restore-jobs/{jobID}deprecated
DEPRECATED
Relativity.ARM.Services.Interfaces.V1.DatabaseRestore.IArmDatabaseRestoreJobManager.UpdateAsync 2 params body → 200
DELETE
/relativity-arm/v1/database-restore-jobs/{jobID}deprecated
DEPRECATED
Relativity.ARM.Services.Interfaces.V1.DatabaseRestore.IArmDatabaseRestoreJobManager.DeleteAsync 2 params → 200
POST
/relativity-arm/v1/archive-informationdeprecated
DEPRECATED
Relativity.ARM.Services.Interfaces.V1.ArchiveInformation.IArmArchiveInformationManager.ReadAsync 1 param body → 200
GET
/relativity-arm/v1/archive-information/additional-files-directories/{workspaceId}deprecated
DEPRECATED
Relativity.ARM.Services.Interfaces.V1.ArchiveInformation.IArmArchiveInformationManager.GetAdditionalFilesDirectoriesAsync 2 params → 200
POST
/relativity-arm/v1/archive-jobsdeprecated
DEPRECATED - Use V3 API instead
Relativity.ARM.Services.Interfaces.V1.Archive.IArmArchiveJobManager.CreateAsync 1 param body → 200
GET
/relativity-arm/v1/archive-jobs/{jobID}deprecated
DEPRECATED - Use V3 API instead
Relativity.ARM.Services.Interfaces.V1.Archive.IArmArchiveJobManager.ReadAsync 2 params → 200
PUT
/relativity-arm/v1/archive-jobs/{jobID}deprecated
DEPRECATED - Use V3 API instead
Relativity.ARM.Services.Interfaces.V1.Archive.IArmArchiveJobManager.UpdateAsync 2 params body → 200
DELETE
/relativity-arm/v1/archive-jobs/{jobID}deprecated
DEPRECATED - Use V3 API instead
Relativity.ARM.Services.Interfaces.V1.Archive.IArmArchiveJobManager.DeleteAsync 2 params → 200

Schemas 50

The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are RestoreJobResponse_V1 (19 properties), ArchiveJobResponse_V1 (15 properties), RestoreJobRequest_V1 (15 properties), DatabaseRestoreJobResponse_V1 (12 properties). Each schema is shown below with its type and property counts.

SourceOptions_V1
object
5 properties
GroupMapping_V1
object
MoveJobRequest_V1
object
8 properties
DatabaseRestoreJobRequest_V1
object
8 properties
GroupMap_V1
object
ArchiveJobRequest_V1
object
11 properties
ApplicationSettingsResponse_V1
object
ArchiveItemStatistics_V1
object
5 properties
ApplicationSettings_V1
object
2 properties
MoveJobResponse_V1
object
12 properties
TimeSpan_V1
object
JobStageError_V1
object
2 properties
DatabaseRestoreJobResponse_V1
object
12 properties
RestoreDestinationOptions_V1
object
IArmDatabaseRestoreJobManager_V1_CreateAsync_RequestBody
object
1 property
IArmRestoreJobManager_V1_UpdateAsync_RequestBody
object
1 property
ClientInfo_V1
object
2 properties
IKeplerStream_V1
object
5 properties
IArmArchiveJobManager_V1_UpdateAsync_RequestBody
object
1 property
MigratorsDestinationOptions_V1
object
IArmRestoreJobManager_V1_CreateAsync_RequestBody
object
1 property
UserMapping_V1
object
RestoreJobRequest_V1
object
15 properties
JobStatistics_V1
object
4 properties
JobStage_V1
object
10 properties
ExtendedWorkspaceDataOptions_V1
object
2 properties
FileOptions_V1
object
ArmJobStatusResponse_V1
object
7 properties
DependencyUserAction_V1
object
DestinationOptions_V1
object
5 properties
ArchiveInformationResponse_V1
object
2 properties
IArmMoveJobManager_V1_UpdateAsync_RequestBody
object
1 property
MigratorOptions_V1
object
6 properties
NotificationOptions_V1
object
AdditionalFilesDirectoriesResponse_V1
object
2 properties
AdvancedFileOptions_V1
object
4 properties
UserMap_V1
object
MoveFileOptions_V1
object
3 properties
MatterInfo_V1
object
2 properties
DatabaseOptions_V1
object
2 properties
IArmArchiveInformationManager_V1_ReadAsync_RequestBody
object
1 property
FileShareOptions_V1
object
2 properties
RestoreJobResponse_V1
object
19 properties
QualityCheckResult_V1
object
2 properties
IArmMoveJobManager_V1_CreateAsync_RequestBody
object
1 property
IArmDatabaseRestoreJobManager_V1_UpdateAsync_RequestBody
object
1 property
ProcessingOptions_V1
object
3 properties
JobDetails_V1
object
IArmArchiveJobManager_V1_CreateAsync_RequestBody
object
1 property
ArchiveJobResponse_V1
object
15 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Relativity publishes across the network.

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