Relativity ArchiveJobs API is one of 51 APIs that Relativity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include ArchiveJobs. 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 10 schemas.
It is described by OpenAPI 3.0.1, at version V1.
Requests are made against a single base URL, /Relativity.REST/api.
4 operations2 paths10 schemas1 DELETE1 GET1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
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.
ArchiveJobs 4
POST
/v3/archive-jobs
Asynchronously creates an instance of an Archive Job.
body→ 200400500
GET
/v3/archive-jobs/{jobID}
Asynchronously read an instance of an Archive Job.
1 param→ 200404500
PUT
/v3/archive-jobs/{jobID}
Asynchronously updates an instance of an Archive Job.
1 parambody→ 200400404500
DELETE
/v3/archive-jobs/{jobID}
Asynchronously deletes an instance of an Archive Job.
1 param→ 200404500
Schemas 10
The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are ArchiveJobResponse (10 properties), ArchiveJobRequest (8 properties), ProblemDetails (5 properties), JobActions (3 properties). Each schema is shown below with its type and property counts.
ArchiveJobResponse
object
Response with Archive Job
10 properties
JobActions
object
Represents an action performed on a job
3 properties
ArchiveJobRequest
object
Request to create new Archive job
8 properties
JobPriority
integer
Job priority levels
ArchiveJobRequestWrapper
object
Request to create new Archive job
1 property
ProblemDetails
object
5 properties
UpdateArchiveJobResponse
object
Response for Archive Job update
JobDetails
object
ARM Job details
2 properties
NotificationOptions
object
ARM Job notification options
2 properties
CreateArchiveJobResponse
object
Response for Archive Job creation
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
