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

The AnnotationService API from Relativity — 2 operation(s) for annotationservice.

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

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

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

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

3 operations 2 paths 5 schemas 1 DELETE1 GET1 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 3

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

AnnotationService 3
POST
/v{version}/workspaces/{workspaceID}/Annotations/save
Creates or updates redactions and highlights for a document in a workspace.
2 params body → 200
GET
/v{version}/workspaces/{workspaceID}/Annotations/{documentID}/{markUpSetID}
Retrieves annotations for a document and markup set in a workspace.
4 params → 200
DELETE
/v{version}/workspaces/{workspaceID}/Annotations/{documentID}/{markUpSetID}
Deletes annotations for a document and markup set in a workspace.
4 params body → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Relativity.DocumentViewer.Services.Interfaces.V2.DTOs.Annotation (39 properties), Relativity.DocumentViewer.Services.Interfaces.V2.DTOs.SaveAnnotationsReturnObject (4 properties), Relativity.DocumentViewer.Services.Interfaces.V2.DTOs.AnnotationList (1 property), Reviewservice.Api.V2.Models.SaveAnnotationsRequest (1 property). Each schema is shown below with its type and property counts.

Relativity.DocumentViewer.Services.Interfaces.V2.DTOs.SaveAnnotationsReturnObject
object
4 properties
Reviewservice.Api.V2.Models.DeleteAnnotationsRequest
object
1 property
Reviewservice.Api.V2.Models.SaveAnnotationsRequest
object
1 property
Relativity.DocumentViewer.Services.Interfaces.V2.DTOs.Annotation
object
39 properties
Relativity.DocumentViewer.Services.Interfaces.V2.DTOs.AnnotationList
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

relativity-annotationservice-api-openapi.yml Raw ↑

Other APIs Relativity publishes across the network.

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
Relativity Document Configuration Module API