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 Import Job Module API

The Import Job Module API from Relativity — 11 operation(s) for import job module.

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

Tagged areas include Import Job Module. 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 11 paths, and defines 7 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 11 paths 7 schemas 5 GET6 POST

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 11 paths, the API surfaces 11 operations — 5 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Import Job Module 11
POST
/import-service/v1/workspaces/{workspaceID}/import-jobs/{importJobID}/
Create import job.
Import.Services.V1.ImportJobController.CreateAsync 3 params body → 200400
POST
/import-service/v1/workspaces/{workspaceID}/import-jobs/{importJobID}/cancel/
Cancel import job.
Import.Services.V1.ImportJobController.CancelAsync 3 params → 200400
POST
/import-service/v1/workspaces/{workspaceID}/import-jobs/{importJobID}/begin/
Begin import job.
Import.Services.V1.ImportJobController.BeginAsync 3 params → 200400
POST
/import-service/v1/workspaces/{workspaceID}/import-jobs/{importJobID}/end/
End import job.
Import.Services.V1.ImportJobController.EndAsync 3 params → 200400
POST
/import-service/v1/workspaces/{workspaceID}/import-jobs/{importJobID}/pause/
Pause import job.
Import.Services.V1.ImportJobController.PauseAsync 3 params → 200400
POST
/import-service/v1/workspaces/{workspaceID}/import-jobs/{importJobID}/resume/
Resume previously paused import job.
Import.Services.V1.ImportJobController.ResumeAsync 3 params → 200400
GET
/import-service/v1/workspaces/{workspaceID}/import-jobs/{importJobID}/progress/
Get import job progress.
Import.Services.V1.ImportJobController.GetProgressAsync 3 params → 200400
GET
/import-service/v1/workspaces/{workspaceID}/import-jobs/{importJobID}/details/
Get import job details.
Import.Services.V1.ImportJobController.GetDetailsAsync 3 params → 200400
GET
/import-service/v1/workspaces/{workspaceID}/import-jobs/jobs/
Get import jobs which exist in workspace.
Import.Services.V1.ImportJobController.GetJobsAsync 4 params → 200400
GET
/import-service/v1/workspaces/{workspaceID}/import-jobs/location
Gets the default location for the import files upload.
Import.Services.V1.ImportJobController.GetDefaultLocationForWorkspaceAsync 2 params → 200400
GET
/import-service/v1/workspaces/{workspaceID}/import-jobs/{importJobID}/location
Gets the default location for the import files upload.
Import.Services.V1.ImportJobController.GetDefaultLocationForJobAsync 3 params → 200400

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Response (4 properties), createJobBodyRequest (2 properties). Each schema is shown below with its type and property counts.

Response
object
4 properties
ImportState
string
ValueResponse.ImportDetails
ValueResponse of ImportDetails type
ValueResponse.String
ValueResponse of string type
ValueResponse.ImportProgress
ValueResponse of ImportProgress type
ValueResponse.ImportJobs
ValueResponse of ImportJobs type
createJobBodyRequest
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

relativity-import-job-module-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