Get-RelativityMetricField

Summary

Retrieves an existing Relativity metric field.

Get-RelativityMetricField
    -Id

Returns a Relativity metric field object.

Parameters

Examples

Get an existing Relativity metric field

This example retrieves a specific Relativity metric field and outputs it as JSON.

# Retrieve a specific Relativity metric field by id
$entity = Get-RelativityMetricField -Id 2

Write-Output "Retrieved Relativity metric field '$($entity.Name)' (Id: #$($entity.RelativityMetricFieldId), ValueType: $($entity.ValueType), Enabled: $($entity.Enabled))"

# For debug purposes, convert the entity 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 Relativity metric field 'Workspace Name' (Id: #2, ValueType: Text, Enabled: True)

JSON Results:
{
  "RelativityMetricFieldId": 2,
  "MetricKeyId": "4b7a9d1f-8c3e-4e0c-8d2b-9a6a5c0f3e1a",
  "IntegrationId": 1,
  "Integration": null,
  "IntegrationName": "Relativity",
  "IntegrationIdentifier": "https://agilityblue.relativity.one",
  "IntegrationEnabled": true,
  "Name": "Workspace Name",
  "Description": "The name of the workspace.",
  "Enabled": true,
  "ReportType": "Workspace",
  "ValueType": "Text",
  "IsDefault": true,
  "Origin": "Workspace Utilization",
  "OriginId": "35dff1e2-c391-4fa4-9897-0999358f8c13",
  "LayoutStyle": "Stat Row",
  "LayoutPosition": 2,
  "CreatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "CreatedBy": null,
  "CreatedByFullName": "Max Miller",
  "CreatedOn": "2025-03-02T14:22:54.0810036+00:00",
  "LastUpdatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "LastUpdatedBy": null,
  "LastUpdatedByFullName": "Max Miler",
  "LastUpdatedOn": "2025-12-19T18:44:49.8307069+00:00",
  "Metrics": []
}