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

RelativityOne Entities API

Operations for managing HR entities and employees

RelativityOne Entities API is one of 11 APIs that RelativityOne publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Entities. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 3 JSON Schemas.

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

Requests are made against a single base URL, https://relativity.rest/api.

2 operations 2 paths 3 schemas 1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://relativity.rest/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

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

  • BearerAuth — Bearer token obtained via Microsoft Graph API OAuth flow.

Paths & Operations 2

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

Entities 2

Operations for managing HR entities and employees

POST
/relativity-environment/v1/workspaces/{workspaceId}/legal-hold/entities
Create Entity
createEntity 1 param body → 200
PUT
/relativity-environment/v1/workspaces/{workspaceId}/legal-hold/entities/{entityId}
Update Entity Status
updateEntityStatus 2 params body → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Entity (5 properties), CreateEntityRequest (4 properties), UpdateEntityStatusRequest (1 property). Each schema is shown below with its type and property counts.

Entity
object
5 properties
CreateEntityRequest
object
4 properties 3 required
UpdateEntityStatusRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

relativityone-entities-api-openapi.yml Raw ↑

Other APIs RelativityOne publishes across the network.

Object Manager API
Workspace Manager API
Search and Analytics API
User and Permission Manager API
Import and Export API
RelativityOne Communications API
RelativityOne Custodians API
RelativityOne Legal Hold Projects API
RelativityOne Preservation API
RelativityOne Tasks API