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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Relativity

Relativity Environment Module v1 API

The Relativity Environment Module v1 API from Relativity — 93 operation(s) for relativity environment module v1.

Documentation Provider Profile APIs.io OpenAPI GitHub

Relativity Environment Module v1 API is one of 52 APIs that Relativity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 117 operations across 93 paths, and defines 64 schemas. It is described by OpenAPI 3.2.0, at version V1.

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

117 operations 93 paths 64 schemas 15 DELETE51 GET1 PATCH39 POST11 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
V1
Base URL
https://{host}/Relativity.REST/api/relativity-object-model/v1
Resource Areas
1

Paths & Operations 117

Across 93 paths, the API surfaces 117 operations — 15 DELETE, 51 GET, 1 PATCH, 39 POST, 11 PUT. Each is listed below with its method, path, parameters, and response codes.

Relativity Environment Module v1 117
POST
/relativity-environment/v1/workspace
Relativity environment services interfaces environment V1 workspace IWorkspace…
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.CreateAsync body → 200
GET
/relativity-environment/v1/workspace/{workspaceID}
Relativity environment services interfaces environment V1 workspace IWorkspace…
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.ReadAsync 1 param → 200
PUT
/relativity-environment/v1/workspace/{workspaceID}
Relativity environment services interfaces environment V1 workspace IWorkspace…
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.UpdateAsync 1 param body → 200
DELETE
/relativity-environment/v1/workspace/{workspaceID}
Relativity environment services interfaces environment V1 workspace IWorkspace…
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.DeleteAsync 1 param → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/{includeMetadata}/{includeActions}
Relativity environment services interfaces environment V1 workspace IWorkspace…
getRelativityEnvironmentV1WorkspaceByWorkspaceIDByIncludeMetadataByIncludeActions 3 params → 200
GET
/relativity-environment/v1/workspace/meta
Relativity environment services interfaces environment V1 workspace IWorkspace…
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.GetMetaAsync → 200
GET
/relativity-environment/v1/workspace/default-download-handler-url
Relativity environment services interfaces environment V1 workspace IWorkspace…
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.GetDefaultDownloadHandlerURLAsync → 200
POST
/relativity-environment/v1/workspace/query-by-group/{groupID}
Relativity environment services interfaces environment V1 workspace IWorkspace…
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.QueryWorkspaceByGroupAsync 3 params body → 200
GET
/relativity-environment/v1/workspace/eligible-resource-pools
Relativity environment services interfaces environment V1 workspace IWorkspace…
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.GetEligibleResourcePoolsAsync → 200
GET
/relativity-environment/v1/workspace/eligible-resource-pools/{resourcePoolID}/eligible-file-repositories
Relativity environment services interfaces environment V1 workspace IWorkspace…
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.GetEligibleFileRepositoriesAsync 1 param → 200
GET
/relativity-environment/v1/workspace/eligible-resource-pools/{resourcePoolID}/eligible-cache-locations
Relativity environment services interfaces environment V1 workspace IWorkspace…
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.GetEligibleCacheLocationsAsync 1 param → 200
GET
/relativity-environment/v1/workspace/eligible-resource-pools/{resourcePoolID}/eligible-sql-servers
Relativity environment services interfaces environment V1 workspace IWorkspace…
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.GetEligibleSqlServersAsync 1 param → 200
GET
/relativity-environment/v1/workspace/eligible-resource-pools/{resourcePoolID}/eligible-azure-credentials
Relativity environment services interfaces environment V1 workspace IWorkspace…
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.GetEligibleAzureCredentialsAsync 1 param → 200
GET
/relativity-environment/v1/workspace/eligible-resource-pools/{resourcePoolID}/eligible-azure-file-system-credentials
Relativity environment services interfaces environment V1 workspace IWorkspace…
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.GetEligibleAzureFileSystemCredentialsAsync 1 param → 200
POST
/relativity-environment/v1/workspace/query-eligible-clients
Relativity environment services interfaces environment V1 workspace IWorkspace…
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.QueryEligibleClientsAsync 2 params body → 200
POST
/relativity-environment/v1/workspace/query-eligible-groups
Relativity environment services interfaces environment V1 workspace IWorkspace…
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.QueryEligibleGroupsAsync 2 params body → 200
POST
/relativity-environment/v1/workspace/query-eligible-matters
Relativity environment services interfaces environment V1 workspace IWorkspace…
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.QueryEligibleMattersAsync 2 params body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/query-eligible-saved-searches
Relativity environment services interfaces environment V1 workspace IWorkspace…
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.QueryEligibleSavedSearchesAsync 3 params body → 200
POST
/relativity-environment/v1/workspace/query-eligible-templates
Relativity environment services interfaces environment V1 workspace IWorkspace…
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.QueryEligibleTemplatesAsync 2 params body → 200
GET
/relativity-environment/v1/workspace/eligible-sql-full-text-languages
Relativity environment services interfaces environment V1 workspace IWorkspace…
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.GetEligibleSqlFullTextLanguagesAsync → 200
GET
/relativity-environment/v1/workspace/eligible-statuses
Relativity environment services interfaces environment V1 workspace IWorkspace…
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.GetEligibleStatusesAsync → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/retry-failed-create-event-handlers
Relativity environment services interfaces environment V1 workspace IWorkspace…
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.RetryFailedCreateEventHandlersAsync 1 param → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/summary
Relativity environment services interfaces environment V1 workspace IWorkspace…
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.GetWorkspaceSummaryAsync 1 param → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/move-to-cold-storage
Relativity environment services interfaces environment V1 workspace IWorkspace…
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.MoveToColdStorageAsync 1 param → 200
POST
/relativity-environment/v1/workspaces/-1/resource-files
Relativity environment services interfaces environment V1 resource file…
Relativity.Environment.Services.Interfaces.Environment.V1.ResourceFile.IResourceFileManager.CreateAsync body → 200
PATCH
/relativity-environment/v1/workspaces/-1/resource-files
Relativity environment services interfaces environment V1 resource file…
Relativity.Environment.Services.Interfaces.Environment.V1.ResourceFile.IResourceFileManager.UpsertAsync 1 param body → 200
GET
/relativity-environment/v1/workspaces/-1/resource-files/{resourceFileID}
Relativity environment services interfaces environment V1 resource file…
Relativity.Environment.Services.Interfaces.Environment.V1.ResourceFile.IResourceFileManager.ReadAsync 3 params → 200
PUT
/relativity-environment/v1/workspaces/-1/resource-files/{resourceFileID}
Relativity environment services interfaces environment V1 resource file…
Relativity.Environment.Services.Interfaces.Environment.V1.ResourceFile.IResourceFileManager.UpdateAsync 1 param body → 200
DELETE
/relativity-environment/v1/workspaces/-1/resource-files/{resourceFileID}
Relativity environment services interfaces environment V1 resource file…
Relativity.Environment.Services.Interfaces.Environment.V1.ResourceFile.IResourceFileManager.DeleteAsync 1 param → 200
PUT
/relativity-environment/v1/workspaces/-1/resource-files/{resourceFileID}/contents/{contentsKey}
Relativity environment services interfaces environment V1 resource file…
putRelativityEnvironmentV1Workspaces1ResourceFilesByResourceFileIDContentsByContentsKey 2 params body → 200
GET
/relativity-environment/v1/workspaces/-1/resource-files/{resourceFileID}/contents
Relativity environment services interfaces environment V1 resource file…
Relativity.Environment.Services.Interfaces.Environment.V1.ResourceFile.IResourceFileManager.DownloadContentsAsync 1 param → 200
POST
/relativity-environment/v1/workspaces/-1/resource-files/contents
Relativity environment services interfaces environment V1 resource file…
Relativity.Environment.Services.Interfaces.Environment.V1.ResourceFile.IResourceFileManager.UploadContentsAsync 1 param body → 200
GET
/relativity-environment/v1/workspaces/-1/resource-files/resources/{workspaceId}
Relativity environment services interfaces environment V1 resource file…
Relativity.Environment.Services.Interfaces.Environment.V1.ResourceFile.IResourceFileManager.GetAsync 1 param → 200
GET
/relativity-environment/v1/workspaces/-1/resource-files/eligible-applications
Relativity environment services interfaces environment V1 resource file…
Relativity.Environment.Services.Interfaces.Environment.V1.ResourceFile.IResourceFileManager.GetEligibleApplicationsAsync → 200
POST
/relativity-environment/v1/workspaces/-1/matters
Relativity environment services interfaces environment V1 matter IMatter…
Relativity.Environment.Services.Interfaces.Environment.V1.Matter.IMatterManager.CreateAsync body → 200
GET
/relativity-environment/v1/workspaces/-1/matters/{matterID}
Relativity environment services interfaces environment V1 matter IMatter…
Relativity.Environment.Services.Interfaces.Environment.V1.Matter.IMatterManager.ReadAsync 1 param → 200
PUT
/relativity-environment/v1/workspaces/-1/matters/{matterID}
Relativity environment services interfaces environment V1 matter IMatter…
Relativity.Environment.Services.Interfaces.Environment.V1.Matter.IMatterManager.UpdateAsync 1 param body → 200
DELETE
/relativity-environment/v1/workspaces/-1/matters/{matterID}
Relativity environment services interfaces environment V1 matter IMatter…
Relativity.Environment.Services.Interfaces.Environment.V1.Matter.IMatterManager.DeleteAsync 1 param → 200
GET
/relativity-environment/v1/workspaces/-1/matters/{matterID}/{includeMetadata}/{includeActions}
Relativity environment services interfaces environment V1 matter IMatter…
getRelativityEnvironmentV1Workspaces1MattersByMatterIDByIncludeMetadataByIncludeActions 3 params → 200
GET
/relativity-environment/v1/workspaces/-1/eligible-clients
Relativity environment services interfaces environment V1 matter IMatter…
Relativity.Environment.Services.Interfaces.Environment.V1.Matter.IMatterManager.GetEligibleClientsAsync → 200
GET
/relativity-environment/v1/workspaces/-1/matters/eligible-statuses
Relativity environment services interfaces environment V1 matter IMatter…
Relativity.Environment.Services.Interfaces.Environment.V1.Matter.IMatterManager.GetEligibleStatusesAsync → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications
Relativity environment services interfaces environment V1 library application…
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.CreateAsync 1 param body → 200
PUT
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications
Relativity environment services interfaces environment V1 library application…
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.UpdateAsync 1 param body → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications
Relativity environment services interfaces environment V1 library application…
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.ReadAllAsync 1 param → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{includeActions}
Relativity environment services interfaces environment V1 library application…
postRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByIncludeActions 2 params body → 200
PUT
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{includeActions}
Relativity environment services interfaces environment V1 library application…
putRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByIncludeActions 2 params body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{packageGuid}
Relativity environment services interfaces environment V1 library application…
postRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByPackageGuid 2 params → 200
PUT
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{packageGuid}
Relativity environment services interfaces environment V1 library application…
putRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByPackageGuid 2 params body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{packageGuid}/{includeActions}
Relativity environment services interfaces environment V1 library application…
postRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByPackageGuidByIncludeActions 3 params → 200
PUT
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{packageGuid}/{includeActions}
Relativity environment services interfaces environment V1 library application…
putRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByPackageGuidByIncludeActions 3 params body → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}
Relativity environment services interfaces environment V1 library application…
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.ReadAsync 2 params → 200
DELETE
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}
Relativity environment services interfaces environment V1 library application…
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.DeleteAsync 2 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/{includeMetadata}/{includeActions}
Relativity environment services interfaces environment V1 library application…
getRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationIDByIncludeMetadataByIncludeActions 4 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGUID}
Relativity environment services interfaces environment V1 library application…
getRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationGUID 2 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGUID}/{includeMetadata}/{includeActions}
Relativity environment services interfaces environment V1 library application…
getRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationGUIDByIncludeMetadataByIncludeActions 4 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{includeMetadata}/{includeActions}
Relativity environment services interfaces environment V1 library application…
getRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByIncludeMetadataByIncludeActions 3 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/contents
Relativity environment services interfaces environment V1 library application…
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.ReadApplicationContentsAsync 2 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGUID}/contents
Relativity environment services interfaces environment V1 library application…
getRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationGUIDContents 2 params → 200
DELETE
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}
Relativity environment services interfaces environment V1 library application…
deleteRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationGuid 2 params → 200
PUT
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/libraryinstall
Relativity environment services interfaces environment V1 library application…
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.RetryLibraryInstallAsync 2 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/libraryinstall
Relativity environment services interfaces environment V1 library application…
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.GetLibraryInstallStatusAsync 2 params → 200
DELETE
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/libraryinstall
Relativity environment services interfaces environment V1 library application…
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.CancelLibraryInstallAsync 2 params → 200
PUT
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGUID}/libraryinstall
Relativity environment services interfaces environment V1 library application…
putRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationGUIDLibraryinstall 2 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/libraryinstall
Relativity environment services interfaces environment V1 library application…
getRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationGuidLibraryinstall 2 params → 200
DELETE
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/libraryinstall
Relativity environment services interfaces environment V1 library application…
deleteRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationGuidLibraryinstall 2 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/libraryinstall/{includeActions}
Relativity environment services interfaces environment V1 library application…
getRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationIDLibraryinstallByIncludeActions 3 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/libraryinstall/{includeActions}
Relativity environment services interfaces environment V1 library application…
getRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationGuidLibraryinstallByIncludeActions 3 params → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/package
Relativity environment services interfaces environment V1 library application…
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.UploadPackageAsync 1 param body → 200
DELETE
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/package/{packageGuid}
Relativity environment services interfaces environment V1 library application…
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.DeletePackageAsync 2 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/package/{packageGuid}/contents
Relativity environment services interfaces environment V1 library application…
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.DownloadPackageAsync 2 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGUID}/hostingStatus
Relativity environment services interfaces environment V1 library application…
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.GetApplicationHostingStatusAsync 2 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/hostingStatus
Relativity environment services interfaces environment V1 library application…
getRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationIDHostingStatus 2 params → 200
POST
/relativity-environment/v1/workspaces/-1/instance-settings
Relativity environment services interfaces environment V1 instance setting…
Relativity.Environment.Services.Interfaces.Environment.V1.InstanceSetting.IInstanceSettingManager.CreateAsync body → 200
PUT
/relativity-environment/v1/workspaces/-1/instance-settings
Relativity environment services interfaces environment V1 instance setting…
Relativity.Environment.Services.Interfaces.Environment.V1.InstanceSetting.IInstanceSettingManager.UpdateAsync body → 200
GET
/relativity-environment/v1/workspaces/-1/instance-settings/{instanceSettingID}
Relativity environment services interfaces environment V1 instance setting…
Relativity.Environment.Services.Interfaces.Environment.V1.InstanceSetting.IInstanceSettingManager.ReadAsync 1 param → 200
DELETE
/relativity-environment/v1/workspaces/-1/instance-settings/{instanceSettingID}
Relativity environment services interfaces environment V1 instance setting…
Relativity.Environment.Services.Interfaces.Environment.V1.InstanceSetting.IInstanceSettingManager.DeleteAsync 1 param → 200
POST
/relativity-environment/v1/workspaces/-1/errors
Relativity environment services interfaces environment V1 error IError manager…
Relativity.Environment.Services.Interfaces.Environment.V1.Error.IErrorManager.CreateAsync body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install
Relativity environment services interfaces environment V1 application install…
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.InstallApplicationAsync 2 params body → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install
Relativity environment services interfaces environment V1 application install…
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.GetStatusAsync 3 params → 200
DELETE
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install
Relativity environment services interfaces environment V1 application install…
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.CancelAsync 3 params → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGUID}/install
Relativity environment services interfaces environment V1 application install…
postRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationGUIDInstall 2 params body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/{includeActions}
Relativity environment services interfaces environment V1 application install…
postRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationIDInstallByIncludeActions 3 params body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGUID}/install/{includeActions}
Relativity environment services interfaces environment V1 application install…
postRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationGUIDInstallByIncludeActions 3 params body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/all
Relativity environment services interfaces environment V1 application install…
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.InstallApplicationAllAsync 2 params body → 200
DELETE
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/all
Relativity environment services interfaces environment V1 application install…
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.CancelAllAsync 2 params → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGUID}/install/all
Relativity environment services interfaces environment V1 application install…
postRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationGUIDInstallAll 2 params body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/all/{includeActions}
Relativity environment services interfaces environment V1 application install…
postRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationIDInstallAllByIncludeActions 3 params body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGUID}/install/all/{includeActions}
Relativity environment services interfaces environment V1 application install…
postRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationGUIDInstallAllByIncludeActions 3 params body → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/{applicationInstallID}
Relativity environment services interfaces environment V1 application install…
getRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationIDInstallByApplicationInstallID 3 params → 200
DELETE
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/{applicationInstallID}
Relativity environment services interfaces environment V1 application install…
deleteRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationIDInstallByApplicationInstallID 3 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/install/{applicationInstallID}
Relativity environment services interfaces environment V1 application install…
getRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationGuidInstallByApplicationInstallID 3 params → 200
DELETE
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/install/{applicationInstallID}
Relativity environment services interfaces environment V1 application install…
deleteRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationGuidInstallByApplicationInstallID 3 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/{applicationInstallID}/{includeActions}
Relativity environment services interfaces environment V1 application install…
getRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationIDInstallByApplicationInstallIDByIncludeActions 4 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/install/{applicationInstallID}/{includeActions}
Relativity environment services interfaces environment V1 application install…
getRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationGuidInstallByApplicationInstallIDByIncludeActions 4 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/install
Relativity environment services interfaces environment V1 application install…
getRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationGuidInstall 3 params → 200
DELETE
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/install
Relativity environment services interfaces environment V1 application install…
deleteRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationGuidInstall 3 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/{applicationInstallID}/details/{start}/{length}
Relativity environment services interfaces environment V1 application install…
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.GetApplicationInstallDetailsAsync 5 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/install/{applicationInstallID}/details/{start}/{length}
Relativity environment services interfaces environment V1 application install…
getRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationGuidInstallByApplicationInstallIDDetailsByStartByLength 5 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/{applicationInstallID}/details/{start}/{length}/{includeActions}
Relativity environment services interfaces environment V1 application install…
getRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationIDInstallByApplicationInstallIDDetailsByStartByLengthByIncludeActions 6 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/install/{applicationInstallID}/details/{start}/{length}/{includeActions}
Relativity environment services interfaces environment V1 application install…
getRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationGuidInstallByApplicationInstallIDDetailsByStartByLengthByIncludeActions 6 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/{applicationInstallID}/details/report
Relativity environment services interfaces environment V1 application install…
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.GetApplicationInstallDetailsReportAsync 3 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/install/{applicationInstallID}/details/report
Relativity environment services interfaces environment V1 application install…
getRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationGuidInstallByApplicationInstallIDDetailsReport 3 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/outdated-workspaces-count
Relativity environment services interfaces environment V1 application install…
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.GetOutdatedWorkspacesCount 2 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/install/outdated-workspaces-count
Relativity environment services interfaces environment V1 application install…
getRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationGuidInstallOutdatedWorkspacesCount 2 params → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/available-workspaces
Relativity environment services interfaces environment V1 application install…
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.GetAvailableWorkspacesAsync 5 params body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/install/available-workspaces
Relativity environment services interfaces environment V1 application install…
postRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationGuidInstallAvailableWorkspaces 5 params body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/install/search
Relativity environment services interfaces environment V1 application install…
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.SearchAsync 4 params body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/search
Relativity environment services interfaces environment V1 application install…
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.SearchApplicationAsync 5 params body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/install/search
Relativity environment services interfaces environment V1 application install…
postRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationGuidInstallSearch 5 params body → 200
DELETE
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/install/all
Relativity environment services interfaces environment V1 application install…
deleteRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationGuidInstallAll 2 params → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/validate
Relativity environment services interfaces environment V1 application install…
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.ValidateApplicationInstallation 3 params → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/install/validate
Relativity environment services interfaces environment V1 application install…
postRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationGuidInstallValidate 3 params → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/validate/all
Relativity environment services interfaces environment V1 application install…
postRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationIDInstallValidateAll 3 params → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/install/validate/all
Relativity environment services interfaces environment V1 application install…
postRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsByApplicationGuidInstallValidateAll 3 params → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/install/validate
Relativity environment services interfaces environment V1 application install…
postRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsInstallValidate 2 params body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/install/validate/all
Relativity environment services interfaces environment V1 application install…
postRelativityEnvironmentV1WorkspaceByWorkspaceIDLibraryapplicationsInstallValidateAll 2 params body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/install/conflict/validate-names
Relativity environment services interfaces environment V1 application install…
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.IsNameAvailable 1 param body → 200

Schemas 64

The contract defines 64 schemas that model the data the API accepts and returns. The most detailed are GetInstallStatusResponse (20 properties), QueryRequest (19 properties), WorkspaceRequest (18 properties), ResourceFileResponse (17 properties). Each schema is shown below with its type and property counts.

SqlFullTextLanguageOptions
object
2 properties
ApplicationHostingStatusResponse
object
5 properties
Sort
object
3 properties
CreateErrorRequest
object
8 properties
NameValidationRequest
object
4 properties
ApplicationInstallSearchItem
object
13 properties
InstallStatusSummary
object
8 properties
KeplerServiceStatusResponse
object
3 properties
PackageDetailsResponse
object
10 properties
ResourceFileAgentType
object
2 properties
GetOutdatedWorkspacesResponse
object
5 properties
UpdateLibraryApplicationResponse
object
5 properties
SecurableList_1
object
2 properties
InstanceSettingRequest
object
11 properties
SampleParameters
object
5 properties
ObjectType
object
4 properties
CustomPageHostingStatusResponse
object
5 properties
DisplayableObjectIdentifier
object
3 properties
QueryRequest
object
19 properties
Meta
object
2 properties
InstallApplicationRequest
object
3 properties
InstallApplicationResponse
object
3 properties
ResourceFileService
object
3 properties
SampleDetails
object
3 properties
InstallStatus
object
6 properties
InstallValidationResult
object
3 properties
ResourceFileRequest
object
4 properties
CreateLibraryApplicationResponse
object
4 properties
ResourceFileMassOperation
object
2 properties
WorkspaceSummary
object
2 properties
SearchProviderCondition
object
2 properties
ApplicationInstallSearchResponse
object
9 properties
Securable_1
object
2 properties
ApplicationInstallConflict
object
6 properties
InstallApplicationResult
object
4 properties
CancelApplicationInstallResponse
object
2 properties
ObjectIdentifier
object
2 properties
ApplicationInstallConflictResolution
object
7 properties
Field
object
6 properties
ContentsResponse
object
1 property
QueryOptions
object
2 properties
FieldRef
object
4 properties
GetApplicationInstallDetailsResponse
object
12 properties
RelativityObjectSlim
object
2 properties
EligibleApplication
object
7 properties
WorkspaceRequest
object
18 properties
NameIDPair
object
2 properties
ResourceFileEventHandler
object
3 properties
NameValidationResponse
object
5 properties
ObjectTypeRef
object
4 properties
GetInstallStatusResponse
object
20 properties
Action
object
5 properties
ValidationResult
object
5 properties
ResourceFileResponse
object
17 properties
CancelApplicationInstallResult
object
4 properties
SearchIndexRef
object
2 properties
CancelLibraryInstallResponse
object
4 properties
InstallApplicationAllRequest
object
2 properties
RetryLibraryInstallResponse
object
3 properties
IKeplerStream
object
5 properties
UpdateLibraryApplicationRequest
object
4 properties
QueryResultSlim
object
10 properties
MatterRequest
object
6 properties
Object
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

relativity-relativity-environment-module-v1-api-openapi.yml Raw ↑

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
#Relativity Environment Module v1
← Back to R APIs
API Details
ID
relativity:relativity-relativity-environment-module-v1-api
Base URL
https://{host}/Relativity.REST/api/relativity-object-model/v1
Docs
https://platform.relativity.com/RelativityOne/Content/REST_API/REST_API.htm
Provider
Relativity
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=relativity-relativity-environment-module-v1-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/relativity-relativity-environment-module-v1-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Relativity Environment Module v1 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.