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 Source Module API

The Import Source Module API from Relativity — 8 operation(s) for import source module.

Relativity Import Source 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 Source 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 8 operations across 8 paths, and defines 17 schemas. It is described by OpenAPI 3.0.1, at version V1.

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

8 operations 8 paths 17 schemas 6 GET2 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 8

Across 8 paths, the API surfaces 8 operations — 6 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Import Source Module 8
POST
/import-service/v1/workspaces/{workspaceID}/import-jobs/{importJobID}/sources/{sourceID}
Add source to import job.
Import.Services.V1.IImportSourceController.AddSourceAsync 4 params body → 200400
GET
/import-service/v1/workspaces/{workspaceID}/import-jobs/{importJobID}/sources/{sourceID}/columns
Returns list of column names read from configuration.
Import.Services.V1.IImportSourceController.GetColumnsAsync 4 params → 200400
GET
/import-service/v1/workspaces/{workspaceID}/import-jobs/{importJobID}/sources/{sourceID}/details
Returns details for single source.
Import.Services.V1.IImportSourceController.GetDetailsAsync 4 params → 200400
POST
/import-service/v1/workspaces/{workspaceID}/import-jobs/{importJobID}/sources/{sourceID}/delete
Deletes the parent folder of the data source's load file if it is located in \StructuredData\Import\.
Import.Services.V1.IImportSourceController.DeleteParentFolderAsync 4 params body → 200400
GET
/import-service/v1/workspaces/{workspaceID}/import-jobs/{importJobID}/sources/
Returns sources for single source.
Import.Services.V1.IImportSourceController.GetSourcesAsync 3 params → 200400
GET
/import-service/v1/workspaces/{workspaceID}/import-jobs/{importJobID}/sources/{sourceID}/itemerrors
Get errors for single source.
Import.Services.V1.IImportSourceController.GetItemErrorsAsync 6 params → 200400
GET
/import-service/v1/workspaces/{workspaceID}/import-jobs/{importJobID}/sources/{sourceID}/errorloadfile
Get path to Loadfile with error lines. Empty if data source had no errors.
Import.Services.V1.IImportSourceController.GetErrorLoadfileAsync 4 params → 200400
GET
/import-service/v1/workspaces/{workspaceID}/import-jobs/{importJobID}/sources/{sourceID}/progress
Get progress for single source.
Import.Services.V1.IImportSourceController.GetProgressAsync 4 params → 200400

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are DataSourceSettings (12 properties), ImportErrors (6 properties), ErrorDetail (5 properties), DataSourceDetails (4 properties). Each schema is shown below with its type and property counts.

ValueResponse.ImportErrors
ValueResponse of ImportErrors type
Response
object
4 properties
ValueResponse.ImportProgress
ValueResponse of ImportProgress type
ImportErrors
object
6 properties
DataSourceState
string
ErrorDetail
object
5 properties
ImportError
object
3 properties
DataSourceEndOfLine
string
Line ending standard of the load file
DataSources
object
2 properties
ValueResponse.DataSourceDetails
ValueResponse of DataSourceDetails type
createDataSourceSettingsRequest
object
Object of type DataSourceSettings.
1 property
DataSourceDetails
object
DataSourceDetails type
4 properties
ValueResponse.String
ValueResponse of string type
DataSourceType
string
Type of the input load file
DataSourceSettings
object
Settings for the data source.
12 properties
ValueResponse.StringArray
ValueResponse of string[] type
ValueResponse.DataSources
ValueResponse of DataSources type

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

relativity-import-source-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