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

The CollectAPI API from Relativity — 6 operation(s) for collectapi.

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

Tagged areas include CollectAPI. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, rate-limit docs, and a getting-started guide.

This API exposes 6 operations across 6 paths, and defines 12 schemas. It is described by OpenAPI 3.0.1, at version V1.

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

6 operations 6 paths 12 schemas 2 GET2 PATCH1 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 6

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

CollectAPI 6
PUT
/collect-services/v1/CollectAPI/{workspaceId}/collection
2 params body → 200401500
POST
/collect-services/v1/CollectAPI/{workspaceId}/collection/{collectionArtifactId}/start-target-generation
2 params → 200400401500
GET
/collect-services/v1/CollectAPI/{workspaceArtifactId}/collection/{collectionArtifactId}/target-generation
2 params → 200401500
PATCH
/collect-services/v1/CollectAPI/{workspaceArtifactId}/collection/{collectionArtifactId}/start-collection
3 params → 200400404401500
GET
/collect-services/v1/CollectAPI/{workspaceArtifactId}/collection/{collectionArtifactId}
2 params → 200400404401500
PATCH
/collect-services/v1/CollectAPI/{workspaceId}/collection/{collectionArtifactId}/stop
3 params → 202400401404409

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are CreateCollectionAPIModel (16 properties), CollectionJobTargetModel (8 properties), SelectedCollectionCriteriaModel (5 properties), ProblemDetails (5 properties). Each schema is shown below with its type and property counts.

CollectionJobTargetModel
object
8 properties
StartJobResult
object
2 properties
StringListActionResult
object
2 properties
CollectionJobModelActionResult
object
2 properties
SourceInstanceModel
object
2 properties
SelectedCollectionCriteriaModel
object
5 properties
ProblemDetails
object
5 properties
CreateCollectionAPIModel
object
16 properties
StartJobResultActionResult
object
2 properties
CollectionJobModel
object
4 properties
CriteriaDataType
integer
ActionResult
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

relativity-collectapi-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 Conceptual Analytics v1 API
Relativity Directory API
Relativity Document Configuration Module API