Add-LinkedRelativityWorkspace

Summary

Creates a new linked Relativity workspace.

Add-LinkedRelativityWorkspace
    -Entry

Returns a linked Relativity workspace object.

Parameters

Examples

Create a new linked Relativity workspace

# Create a link object with required fields
$link = @{
    IntegrationId = 1
    MatterId = 39
    WorkspaceArtifactId = 1023125
    WorkspaceName = "Agility Blue Review Workspace"
}

$createdLink = Add-LinkedRelativityWorkspace -Entry $link

# Output some information to help indicate that the link was established
Write-Output "Created linked Relativity workspace '$($createdLink.WorkspaceName)' (Id: #$($createdLink.LinkedRelativityWorkspaceId), Artifact ID: $($createdLink.WorkspaceArtifactId), Matter: $($createdLink.MatterName))"

# For debug purposes, convert the data to output as JSON so we can see all the fields
Write-Output ""
Write-Output "JSON Results:"

$jsonOutput = $createdLink | ConvertTo-Json -Depth 10

# Output the data
Write-Output $jsonOutput

Execution results:

Created linked Relativity workspace 'Agility Blue Review Workspace' (Id: #63, Artifact ID: 1023125, Matter: AGM Widget Corp. vs. MGM Manufacturing Inc.)

JSON Results:
{
  "LinkedRelativityWorkspaceId": 63,
  "IntegrationId": 1,
  "Integration": null,
  "MatterId": 39,
  "Matter": null,
  "MatterName": "AGM Widget Corp. vs. MGM Manufacturing Inc.",
  "MatterReference": "1024-0002",
  "WorkspaceArtifactId": 1023125,
  "WorkspaceName": "Agility Blue Review Workspace",
  "HasUsageReportMetrics": true,
  "CreatedByFullName": "Max Miller",
  "CreatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "CreatedOn": "2026-01-19T17:06:24.8941941+00:00",
  "CreatedBy": null,
  "LastUpdatedByFullName": "Max Miller",
  "LastUpdatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "LastUpdatedOn": "2026-01-19T17:06:24.8941941+00:00",
  "LastUpdatedBy": null,
  "MostRecentStatistics": null
}