Set-LinkedRelativityWorkspace

Summary

Updates an existing linked Relativity workspace.

Set-LinkedRelativityWorkspace
    -Entry

Returns a linked Relativity workspace object.

Parameters

Examples

Update an existing linked Relativity workspace

This example moves an existing link to a different matter.

# Retrieve an existing linked Relativity workspace
$link = Get-LinkedRelativityWorkspace -Id 63

# Change the matter
$link.MatterId = 111

# Update the link
$link = Set-LinkedRelativityWorkspace -Entry $link

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

# For debug purposes, convert the project to output as JSON so we can see the available fields
$jsonOutput = $link | ConvertTo-Json -Depth 10

Write-Output ""
Write-Output "JSON Results:"

# Output the JSON results
Write-Output $jsonOutput

Execution results:

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

JSON Results:
{
  "LinkedRelativityWorkspaceId": 63,
  "IntegrationId": 1,
  "Integration": null,
  "MatterId": 111,
  "Matter": null,
  "MatterName": "AGM vs. MGM Review",
  "MatterReference": null,
  "WorkspaceArtifactId": 1023125,
  "WorkspaceName": "Agility Blue Review Workspace",
  "HasUsageReportMetrics": true,
  "CreatedByFullName": "Service Account",
  "CreatedById": "410e109b-6ff5-4442-9670-cd5e3cd82a7f",
  "CreatedOn": "2026-01-19T17:06:24.8941941+00:00",
  "CreatedBy": null,
  "LastUpdatedByFullName": "Service Account",
  "LastUpdatedById": "410e109b-6ff5-4442-9670-cd5e3cd82a7f",
  "LastUpdatedOn": "2026-01-19T17:17:42.7692974+00:00",
  "LastUpdatedBy": null,
  "MostRecentStatistics": null
}