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

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Relativity

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 Relativity Environment Module v1 API is one of 51 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.0.1, 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.0.1
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
[Public] IWorkspaceManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.CreateAsync body → 200
GET
/relativity-environment/v1/workspace/{workspaceID}
[Public] IWorkspaceManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.ReadAsync 1 param → 200
PUT
/relativity-environment/v1/workspace/{workspaceID}
[Public] IWorkspaceManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.UpdateAsync 1 param body → 200
DELETE
/relativity-environment/v1/workspace/{workspaceID}
[Public] IWorkspaceManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.DeleteAsync 1 param → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/{includeMetadata}/{includeActions}
[Public] IWorkspaceManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.ReadAsync 3 params → 200
GET
/relativity-environment/v1/workspace/meta
[Public] IWorkspaceManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.GetMetaAsync → 200
GET
/relativity-environment/v1/workspace/default-download-handler-url
[Public] IWorkspaceManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.GetDefaultDownloadHandlerURLAsync → 200
POST
/relativity-environment/v1/workspace/query-by-group/{groupID}
[Public] IWorkspaceManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.QueryWorkspaceByGroupAsync 3 params body → 200
GET
/relativity-environment/v1/workspace/eligible-resource-pools
[Public] IWorkspaceManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.GetEligibleResourcePoolsAsync → 200
GET
/relativity-environment/v1/workspace/eligible-resource-pools/{resourcePoolID}/eligible-file-repositories
[Public] IWorkspaceManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.GetEligibleFileRepositoriesAsync 1 param → 200
GET
/relativity-environment/v1/workspace/eligible-resource-pools/{resourcePoolID}/eligible-cache-locations
[Public] IWorkspaceManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.GetEligibleCacheLocationsAsync 1 param → 200
GET
/relativity-environment/v1/workspace/eligible-resource-pools/{resourcePoolID}/eligible-sql-servers
[Public] IWorkspaceManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.GetEligibleSqlServersAsync 1 param → 200
GET
/relativity-environment/v1/workspace/eligible-resource-pools/{resourcePoolID}/eligible-azure-credentials
[Public] IWorkspaceManager -
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
[Public] IWorkspaceManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.GetEligibleAzureFileSystemCredentialsAsync 1 param → 200
POST
/relativity-environment/v1/workspace/query-eligible-clients
[Public] IWorkspaceManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.QueryEligibleClientsAsync 2 params body → 200
POST
/relativity-environment/v1/workspace/query-eligible-groups
[Public] IWorkspaceManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.QueryEligibleGroupsAsync 2 params body → 200
POST
/relativity-environment/v1/workspace/query-eligible-matters
[Public] IWorkspaceManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.QueryEligibleMattersAsync 2 params body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/query-eligible-saved-searches
[Public] IWorkspaceManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.QueryEligibleSavedSearchesAsync 3 params body → 200
POST
/relativity-environment/v1/workspace/query-eligible-templates
[Public] IWorkspaceManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.QueryEligibleTemplatesAsync 2 params body → 200
GET
/relativity-environment/v1/workspace/eligible-sql-full-text-languages
[Public] IWorkspaceManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.GetEligibleSqlFullTextLanguagesAsync → 200
GET
/relativity-environment/v1/workspace/eligible-statuses
[Public] IWorkspaceManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.GetEligibleStatusesAsync → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/retry-failed-create-event-handlers
[Public] IWorkspaceManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.RetryFailedCreateEventHandlersAsync 1 param → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/summary
[Public] IWorkspaceManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.GetWorkspaceSummaryAsync 1 param → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/move-to-cold-storage
[Public] IWorkspaceManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Workspace.IWorkspaceManager.MoveToColdStorageAsync 1 param → 200
POST
/relativity-environment/v1/workspaces/-1/resource-files
[Public] IResourceFileManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ResourceFile.IResourceFileManager.CreateAsync body → 200
PATCH
/relativity-environment/v1/workspaces/-1/resource-files
[Public] IResourceFileManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ResourceFile.IResourceFileManager.UpsertAsync 1 param body → 200
GET
/relativity-environment/v1/workspaces/-1/resource-files/{resourceFileID}
[Public] IResourceFileManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ResourceFile.IResourceFileManager.ReadAsync 3 params → 200
PUT
/relativity-environment/v1/workspaces/-1/resource-files/{resourceFileID}
[Public] IResourceFileManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ResourceFile.IResourceFileManager.UpdateAsync 1 param body → 200
DELETE
/relativity-environment/v1/workspaces/-1/resource-files/{resourceFileID}
[Public] IResourceFileManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ResourceFile.IResourceFileManager.DeleteAsync 1 param → 200
PUT
/relativity-environment/v1/workspaces/-1/resource-files/{resourceFileID}/contents/{contentsKey}
[Public] IResourceFileManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ResourceFile.IResourceFileManager.UpdateAsync 2 params body → 200
GET
/relativity-environment/v1/workspaces/-1/resource-files/{resourceFileID}/contents
[Public] IResourceFileManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ResourceFile.IResourceFileManager.DownloadContentsAsync 1 param → 200
POST
/relativity-environment/v1/workspaces/-1/resource-files/contents
[Public] IResourceFileManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ResourceFile.IResourceFileManager.UploadContentsAsync 1 param body → 200
GET
/relativity-environment/v1/workspaces/-1/resource-files/resources/{workspaceId}
[Public] IResourceFileManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ResourceFile.IResourceFileManager.GetAsync 1 param → 200
GET
/relativity-environment/v1/workspaces/-1/resource-files/eligible-applications
[Public] IResourceFileManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ResourceFile.IResourceFileManager.GetEligibleApplicationsAsync → 200
POST
/relativity-environment/v1/workspaces/-1/matters
[Public] IMatterManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Matter.IMatterManager.CreateAsync body → 200
GET
/relativity-environment/v1/workspaces/-1/matters/{matterID}
[Public] IMatterManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Matter.IMatterManager.ReadAsync 1 param → 200
PUT
/relativity-environment/v1/workspaces/-1/matters/{matterID}
[Public] IMatterManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Matter.IMatterManager.UpdateAsync 1 param body → 200
DELETE
/relativity-environment/v1/workspaces/-1/matters/{matterID}
[Public] IMatterManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Matter.IMatterManager.DeleteAsync 1 param → 200
GET
/relativity-environment/v1/workspaces/-1/matters/{matterID}/{includeMetadata}/{includeActions}
[Public] IMatterManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Matter.IMatterManager.ReadAsync 3 params → 200
GET
/relativity-environment/v1/workspaces/-1/eligible-clients
[Public] IMatterManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Matter.IMatterManager.GetEligibleClientsAsync → 200
GET
/relativity-environment/v1/workspaces/-1/matters/eligible-statuses
[Public] IMatterManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Matter.IMatterManager.GetEligibleStatusesAsync → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.CreateAsync 1 param body → 200
PUT
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.UpdateAsync 1 param body → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.ReadAllAsync 1 param → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{includeActions}
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.CreateAsync 2 params body → 200
PUT
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{includeActions}
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.UpdateAsync 2 params body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{packageGuid}
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.CreateAsync 2 params → 200
PUT
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{packageGuid}
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.UpdateAsync 2 params body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{packageGuid}/{includeActions}
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.CreateAsync 3 params → 200
PUT
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{packageGuid}/{includeActions}
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.UpdateAsync 3 params body → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.ReadAsync 2 params → 200
DELETE
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.DeleteAsync 2 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/{includeMetadata}/{includeActions}
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.ReadAsync 4 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGUID}
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.ReadAsync 2 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGUID}/{includeMetadata}/{includeActions}
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.ReadAsync 4 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{includeMetadata}/{includeActions}
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.ReadAllAsync 3 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/contents
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.ReadApplicationContentsAsync 2 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGUID}/contents
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.ReadApplicationContentsAsync 2 params → 200
DELETE
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.DeleteAsync 2 params → 200
PUT
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/libraryinstall
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.RetryLibraryInstallAsync 2 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/libraryinstall
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.GetLibraryInstallStatusAsync 2 params → 200
DELETE
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/libraryinstall
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.CancelLibraryInstallAsync 2 params → 200
PUT
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGUID}/libraryinstall
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.RetryLibraryInstallAsync 2 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/libraryinstall
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.GetLibraryInstallStatusAsync 2 params → 200
DELETE
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/libraryinstall
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.CancelLibraryInstallAsync 2 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/libraryinstall/{includeActions}
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.GetLibraryInstallStatusAsync 3 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/libraryinstall/{includeActions}
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.GetLibraryInstallStatusAsync 3 params → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/package
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.UploadPackageAsync 1 param body → 200
DELETE
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/package/{packageGuid}
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.DeletePackageAsync 2 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/package/{packageGuid}/contents
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.DownloadPackageAsync 2 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGUID}/hostingStatus
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.GetApplicationHostingStatusAsync 2 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/hostingStatus
[Public] ILibraryApplicationManager -
Relativity.Environment.Services.Interfaces.Environment.V1.LibraryApplication.ILibraryApplicationManager.GetApplicationHostingStatusAsync 2 params → 200
POST
/relativity-environment/v1/workspaces/-1/instance-settings
[Public] IInstanceSettingManager -
Relativity.Environment.Services.Interfaces.Environment.V1.InstanceSetting.IInstanceSettingManager.CreateAsync body → 200
PUT
/relativity-environment/v1/workspaces/-1/instance-settings
[Public] IInstanceSettingManager -
Relativity.Environment.Services.Interfaces.Environment.V1.InstanceSetting.IInstanceSettingManager.UpdateAsync body → 200
GET
/relativity-environment/v1/workspaces/-1/instance-settings/{instanceSettingID}
[Public] IInstanceSettingManager -
Relativity.Environment.Services.Interfaces.Environment.V1.InstanceSetting.IInstanceSettingManager.ReadAsync 1 param → 200
DELETE
/relativity-environment/v1/workspaces/-1/instance-settings/{instanceSettingID}
[Public] IInstanceSettingManager -
Relativity.Environment.Services.Interfaces.Environment.V1.InstanceSetting.IInstanceSettingManager.DeleteAsync 1 param → 200
POST
/relativity-environment/v1/workspaces/-1/errors
[Public] IErrorManager -
Relativity.Environment.Services.Interfaces.Environment.V1.Error.IErrorManager.CreateAsync body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.InstallApplicationAsync 2 params body → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.GetStatusAsync 3 params → 200
DELETE
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.CancelAsync 3 params → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGUID}/install
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.InstallApplicationAsync 2 params body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/{includeActions}
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.InstallApplicationAsync 3 params body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGUID}/install/{includeActions}
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.InstallApplicationAsync 3 params body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/all
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.InstallApplicationAllAsync 2 params body → 200
DELETE
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/all
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.CancelAllAsync 2 params → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGUID}/install/all
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.InstallApplicationAllAsync 2 params body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/all/{includeActions}
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.InstallApplicationAllAsync 3 params body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGUID}/install/all/{includeActions}
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.InstallApplicationAllAsync 3 params body → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/{applicationInstallID}
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.GetStatusAsync 3 params → 200
DELETE
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/{applicationInstallID}
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.CancelAsync 3 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/install/{applicationInstallID}
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.GetStatusAsync 3 params → 200
DELETE
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/install/{applicationInstallID}
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.CancelAsync 3 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/{applicationInstallID}/{includeActions}
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.GetStatusAsync 4 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/install/{applicationInstallID}/{includeActions}
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.GetStatusAsync 4 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/install
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.GetStatusAsync 3 params → 200
DELETE
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/install
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.CancelAsync 3 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/{applicationInstallID}/details/{start}/{length}
[Public] IApplicationInstallManager -
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}
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.GetApplicationInstallDetailsAsync 5 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/{applicationInstallID}/details/{start}/{length}/{includeActions}
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.GetApplicationInstallDetailsAsync 6 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/install/{applicationInstallID}/details/{start}/{length}/{includeActions}
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.GetApplicationInstallDetailsAsync 6 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/{applicationInstallID}/details/report
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.GetApplicationInstallDetailsReportAsync 3 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/install/{applicationInstallID}/details/report
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.GetApplicationInstallDetailsReportAsync 3 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/outdated-workspaces-count
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.GetOutdatedWorkspacesCount 2 params → 200
GET
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/install/outdated-workspaces-count
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.GetOutdatedWorkspacesCount 2 params → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/available-workspaces
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.GetAvailableWorkspacesAsync 5 params body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/install/available-workspaces
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.GetAvailableWorkspacesAsync 5 params body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/install/search
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.SearchAsync 4 params body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/search
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.SearchApplicationAsync 5 params body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/install/search
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.SearchApplicationAsync 5 params body → 200
DELETE
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/install/all
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.CancelAllAsync 2 params → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/validate
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.ValidateApplicationInstallation 3 params → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/install/validate
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.ValidateApplicationInstallation 3 params → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationID}/install/validate/all
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.ValidateApplicationInstallation 3 params → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/{applicationGuid}/install/validate/all
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.ValidateApplicationInstallation 3 params → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/install/validate
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.ValidateApplicationInstallation 2 params body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/install/validate/all
[Public] IApplicationInstallManager -
Relativity.Environment.Services.Interfaces.Environment.V1.ApplicationInstall.IApplicationInstallManager.ValidateApplicationInstallation 2 params body → 200
POST
/relativity-environment/v1/workspace/{workspaceID}/libraryapplications/install/conflict/validate-names
[Public] IApplicationInstallManager -
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.

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

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