Get-RelativityWorkspaces

Relativity Integration Required

This cmdlet requires a valid Relativity integration in order to work. See the Relativity integration documentation to learn how to set up the integration.

Summary

Gets an array of Relativity workspaces from a connected Relativity integration.

Get-RelativityWorkspaces
    -IntegrationId
    -Raw

Returns an array of Relativity workspace objects.

Model

This cmdlet returns the following fields from Relativity for this object:

• ArtifactID (int)

• Name (string)

The cmdlet cannot be customized to return any other fields.

Modern APIs Only

This cmdlet will only work with integrations that have the “Use Modern Relativity Apis” switch applied for their configuration.

Parameters

Examples

Get a list of Relativity workspaces from Relativity

# Get a specific integration based on the Relativity identifier (url)
# $relativityUrl = "https://my-company.relativity.one"

$integrations = Get-Integrations `
    -Filter "Name eq 'Relativity' and startswith(Identifier,'$relativityUrl')"

$relativityIntegration = $integrations.Collection | Select-Object -First 1

if ($null -eq $relativityIntegration) {
    Write-Error "Unable to find a Relativity integration with the identifier `"$relativityIdentifier`""
    exit
}

$result = Get-RelativityWorkspaces `
    -IntegrationId $relativityIntegration.IntegrationId

$result | ConvertTo-Json -Depth 10

Output of this script:

[
  {
    "ArtifactID": 9021563,
    "Name": "Salt v Pepper ECA"
  },
  {
    "ArtifactID": 9021564,
    "Name": "Salt v Pepper Review"
  }
]