Get-RelativityProductions

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 productions from a Relativity workspace using a connected Relativity integration.

Get-RelativityWorkspaces
    -IntegrationId
    -WorkspaceArtifactId
    -Raw

Returns an array of Relativity production objects.

Model

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

• ArtifactId (int)

• Name (string)

• DateProduced (DateTime)

• FirstBatesValue (string)

• LastBatesValue (string)

• SystemCreatedBy (string)

• SystemCreatedOn (DateTime)

• Status (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 productions from a Relativity workspace

# 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
}

# This call will cause Agility Blue to reach out to Relativity and ask for the productions
# located in the workspace with artifact id 9012556. The result is an array of Relativity
# productions.
$relativityWorkspaceProductions = Get-RelativityProductions `
    -IntegrationId $linkedRelativityWorkspace.IntegrationId `
    -WorkspaceArtifactId 9012556
 
$relativityWorkspaceProductions | ConvertTo-Json

Output of this script:

[
  {
    "ArtifactID": 7737926,
    "Name": "ABC001",
    "DateProduced": "2024-06-22T00:00:00",
    "FirstBatesValue": "ABC0000001",
    "LastBatesValue": "ABC0000318",
    "SystemCreatedBy": "Blue, Johnny",
    "SystemCreatedOn": "2024-06-22T19:27:27.607",
    "Status": "Produced"
  },
  {
    "ArtifactID": 9096137,
    "Name": "ABC002",
    "DateProduced": "2024-08-01T00:00:00",
    "FirstBatesValue": "ABC0000319",
    "LastBatesValue": "ABC0000369",
    "SystemCreatedBy": "Blue, Katie",
    "SystemCreatedOn": "2024-06-22T16:53:30.03",
    "Status": "Produced"
  }
]