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

The RestoreJobs API from Relativity — 2 operation(s) for restorejobs.

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

Tagged areas include RestoreJobs. 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 11 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 11 schemas 1 DELETE1 GET1 POST1 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, 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

RestoreJobs 4
POST
/v3/restore-jobs
Asynchronously creates an instance of a Restore Job.
body → 200400500
GET
/v3/restore-jobs/{jobID}
Asynchronously read an instance of a Restore Job.
1 param → 200404500
PUT
/v3/restore-jobs/{jobID}
Asynchronously updates an instance of a Restore Job.
1 param body → 200400404500
DELETE
/v3/restore-jobs/{jobID}
Asynchronously deletes an instance of a Restore Job.
1 param → 200404500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are RestoreJobResponse (12 properties), RestoreJobRequest (8 properties), ProblemDetails (5 properties), JobActions (3 properties). Each schema is shown below with its type and property counts.

JobActions
object
Represents an action performed on a job
3 properties
RestoreDestinationOptions
object
V3 Restore Job destination options
1 property
JobPriority
integer
Job priority levels
UpdateRestoreJobResponse
object
Response for Restore Job update
ProblemDetails
object
5 properties
JobDetails
object
ARM Job details
2 properties
CreateRestoreJobResponse
object
Response for Restore Job creation
1 property
RestoreJobRequest
object
Request to create new Restore job V3
8 properties
RestoreJobRequestWrapper
object
Request to create new Restore job V3
1 property
RestoreJobResponse
object
Response with Restore Job V3
12 properties
NotificationOptions
object
ARM Job notification options
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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