How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
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 52 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.2.0, at version 1.

Requests are made against the base URL https://{host}/Relativity.REST/api/relativity-object-model/v1.

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.2.0
API Version
1
Base URL
https://{host}/Relativity.REST/api/relativity-object-model/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Relativity CollectAPI API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (Bearer). By default, every request must be authenticated.

  • Bearer — Relativity Identity Service (RIS) bearer token to authenticate: https://platform.relativity.com/RelativityOne/Content/RESTAPI/RESTAPIauthentication.htmBearerto…

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
Replace collect services collect api by workspace id collection
putCollectServicesV1CollectAPIByWorkspaceIdCollection 2 params body → 200401500
POST
/collect-services/v1/CollectAPI/{workspaceId}/collection/{collectionArtifactId}/start-target-generation
Create collect services collect api by workspace id collection by collection…
postCollectServicesV1CollectAPIByWorkspaceIdCollectionByCollectionArtifactIdStartTargetGeneration 2 params → 200400401500
GET
/collect-services/v1/CollectAPI/{workspaceArtifactId}/collection/{collectionArtifactId}/target-generation
Get collect services collect api by workspace artifact id collection by…
getCollectServicesV1CollectAPIByWorkspaceArtifactIdCollectionByCollectionArtifactIdTargetGeneration 2 params → 200401500
PATCH
/collect-services/v1/CollectAPI/{workspaceArtifactId}/collection/{collectionArtifactId}/start-collection
Update collect services collect api by workspace artifact id collection by…
patchCollectServicesV1CollectAPIByWorkspaceArtifactIdCollectionByCollectionArtifactIdStartCollection 3 params → 200400404401500
GET
/collect-services/v1/CollectAPI/{workspaceArtifactId}/collection/{collectionArtifactId}
Get collect services collect api by workspace artifact id collection by…
getCollectServicesV1CollectAPIByWorkspaceArtifactIdCollectionByCollectionArtifactId 2 params → 200400404401500
PATCH
/collect-services/v1/CollectAPI/{workspaceId}/collection/{collectionArtifactId}/stop
Update collect services collect api by workspace id collection by collection…
patchCollectServicesV1CollectAPIByWorkspaceIdCollectionByCollectionArtifactIdStop 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.

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

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
Where this information came from

This is an independent, third-party profile of Relativity CollectAPI API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.