Relativity Legal Hold Module API

The Legal Hold Module API from Relativity — 14 operation(s) for legal hold module.

Documentation Provider Profile APIs.io OpenAPI GitHub

Relativity Legal Hold 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 Legal Hold 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 14 operations across 14 paths, and defines 21 schemas. It is described by OpenAPI 3.0.1, at version V1.

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

14 operations 14 paths 21 schemas 13 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.1

API Version

Base URL

https://{host}/Relativity.REST/api/relativity-object-model/v1

Resource Areas

Paths & Operations 14

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

Legal Hold Module 14

GET

/CustodianPortalAuthUrl/GetPortalRedirectUrl

[Private] ICustodianPortalAuthUrlManager -

kCura.LegalHold.Services.ICustodianPortalAuthUrlManager.GetPortalRedirectUrl 3 params → 200

GET

/custodian-request-manager/ActiveCustodianSummary

[Public] ICustodianRequestManager -

kCura.LegalHold.Services.ICustodianRequestManager.ActiveCustodianSummary 4 params → 200

GET

/workspace/{workspaceId}/GetRedirectUriAsync

[Private] IGoogleAuthorizationManager -

kCura.LegalHold.Services.IGoogleAuthorizationManager.GetRedirectUriAsync 3 params → 200

GET

/workspace/{workspaceId}/GoogleMail/HandleAuthenticationRedirect

[Private] IGoogleAuthorizationManager -

kCura.LegalHold.Services.IGoogleAuthorizationManager.ProcessGSuiteAuthRedirectAsync 5 params → 200

GET

/graph-auth-response

[Private] IGraphAuthorizationManager -

kCura.LegalHold.Services.IGraphAuthorizationManager.AuthorizeMicrosoftGraph 3 params → 200

GET

/authorized-user/{workspaceId}

[Private] IGraphAuthorizationManager -

kCura.LegalHold.Services.IGraphAuthorizationManager.GetAuthorizedUser 2 params → 200

GET

/preservation/{projectArtifactId}/getCustodians

[Private] IPreservationManager -

kCura.LegalHold.Services.IPreservationManager.GetCustodiansAsync 5 params → 200

GET

/preservation/IsInstalled/{workspaceId}

[Private] IPreservationManager -

kCura.LegalHold.Services.IPreservationManager.InstalledAsync 2 params → 200

GET

/health-check

[Internal] IPostDeployHealthCheckManager -

kCura.LegalHold.Services.IPostDeployHealthCheckManager.HealthCheckAsync 1 param → 200

GET

/toggles/{toggleName}/is-enabled

[Internal] IToggleManager -

kCura.LegalHold.Services.IToggleManager.IsEnabled 2 params → 200

GET

/SettingsManagement/workspace/{workspaceId}/ValidateEmailSettings

[Internal] ISettingsProcessor -

kCura.LegalHold.Services.ISettingsProcessor.ValidateEmailSettings 4 params → 200

GET

/workload-discovery/{guid}/workload

[Internal] IWorkloadDiscoveryManager -

kCura.LegalHold.Services.IWorkloadDiscoveryManager.GetAgentWorkloadAsync 2 params → 200

GET

/workspace/{workspaceArtifactId}/communication/{communicationArtifactId}/layout-state

[Private] ICommunicationManager -

kCura.LegalHold.Services.ICommunicationManager.GetCommunicationLayoutState 3 params → 200

POST

/workspace/{workspaceArtifactId}/communication/{communicationArtifactId}/acknowledge-on-behalf

[Private] ICommunicationManager -

kCura.LegalHold.Services.ICommunicationManager.AcknowledgeOnBehalf 3 params body → 200

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are Uri (22 properties), ApplicationInstallSearchItem (13 properties), LegalHoldApplicationInstallResponse (10 properties), ActiveCustodianSummary (9 properties). Each schema is shown below with its type and property counts.

LegalHoldApplicationInstallResponse

object

10 properties

Int16

object

UrlRedirectModel

object

1 property

Version

object

6 properties

HttpContent

object

1 property

InstallStatus

object

6 properties

HttpMethod

object

8 properties

ArtifactIDCollection

object

3 properties

HttpResponseMessage

object

7 properties

GenericMessageResponseModel

object

2 properties

ValidationSettings

object

2 properties

InstallStatusSummary

object

8 properties

Workload

object

1 property

AcknowledgeOnBehalfModel

object

2 properties

Action

object

5 properties

Uri

object

22 properties

CommunicationLayoutStateModel

object

ApplicationInstallSearchItem

object

13 properties

HttpRequestMessage

object

6 properties

ActiveCustodianSummary

object

9 properties

DisplayableObjectIdentifier

object

3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Relativity publishes across the network.

Relativity AnnotationService API

AE Profile APIs.io

Relativity ArchiveJobs API

AE Profile APIs.io

Relativity ARM Module v1 API

AE Profile APIs.io

Relativity ARM Module v3 API

AE Profile APIs.io

Relativity BillableSummaryReports API

AE Profile APIs.io

Relativity BillingConfiguration API

AE Profile APIs.io

Relativity BillingInsights API

AE Profile APIs.io

Relativity Client Side Libraries Module API

AE Profile APIs.io

Relativity ColdStorage API

AE Profile APIs.io

Relativity CollectAPI API

AE Profile APIs.io

Relativity Conceptual Analytics v1 API

AE Profile APIs.io

Relativity Directory API

AE Profile APIs.io

#Legal Hold Module

← Back to R APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Relativity Legal Hold Module API

Metadata

Paths & Operations 14

Schemas 21

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Relativity Legal Hold Module API

Metadata

Paths & Operations 14

Schemas 21

Specification

Source

More from Relativity 12

API Details

Provider

Explore more