Get-LinkedRelativityWorkspace

Summary

Retrieves an existing linked Relativity workspace.

Get-LinkedRelativityWorkspace
    -Id

Returns a linked Relativity workspace object.

Parameters

Examples

Get an existing linked Relativity workspace

This example retrieves a specific linked Relativity workspace and outputs it as JSON.

# Retrieve a specific linked Relativity workspace by id
$entity = Get-LinkedRelativityWorkspace -Id 45

Write-Output "Retrieved linked Relativity workspace '$($entity.WorkspaceName)' (Id: #$($entity.LinkedRelativityWorkspaceId), Artifact ID: $($entity.WorkspaceArtifactId))"

# For debug purposes, convert the linked Relativity workspace to output as JSON so we can see the available fields
Write-Output ""
Write-Output "JSON Results:"

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

# Output the entity
Write-Output $jsonOutput

Execution results:

Retrieved linked Relativity workspace 'Agility Blue Review Workspace' (Id: #45, Artifact ID: 1023125)

JSON Results:
{
  "LinkedRelativityWorkspaceId": 45,
  "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": "2025-03-05T22:55:57.2857496+00:00",
  "CreatedBy": null,
  "LastUpdatedByFullName": "Max Miller",
  "LastUpdatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "LastUpdatedOn": "2025-03-05T22:55:57.2857496+00:00",
  "LastUpdatedBy": null,
  "MostRecentStatistics": null
}