Set-RelativityMetricField

Summary

Updates an existing Relativity metric field.

Set-RelativityMetricField
    -Entry

Returns a Relativity metric field object.

Parameters

Examples

Update an existing Relativity metric field

This example disables collecting a specific field.

# Retrieve an existing Relativity metric field
$metricField = Get-RelativityMetricField -Id 17

# Set enabled to false to prevent the system from collecting this field in the subsequent collections.
$metricField.Enabled = $false

# Update
$metricField = Set-RelativityMetricField -Entry $metricField

# Output some information to help indicate that the entity was updated
Write-Output "Updated Relativity metric field '$($metricField.Name)' (Id: #$($metricField.RelativityMetricFieldId), ValueType: $($metricField.ValueType), Enabled: $($metricField.Enabled))"

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

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

# Output the JSON results
Write-Output $jsonOutput

Execution results:

Updated Relativity metric field 'Current Document Count Text Only' (Id: #17, ValueType: Int64, Enabled: False)

JSON Results:
{
  "RelativityMetricFieldId": 17,
  "MetricKeyId": "529c2277-973f-4ad9-9f0f-93c4e14de470",
  "IntegrationId": 1,
  "Integration": null,
  "IntegrationName": "Relativity",
  "IntegrationIdentifier": "https://agilityblue.relativity.one",
  "IntegrationEnabled": true,
  "Name": "Current Document Count Text Only",
  "Description": "The number of documents without native, images or produced images at the workspace utilization capture date-time.",
  "Enabled": false,
  "ReportType": "Workspace",
  "ValueType": "Int64",
  "IsDefault": false,
  "Origin": "Workspace Utilization",
  "OriginId": "35dff1e2-c391-4fa4-9897-0999358f8c13",
  "LayoutStyle": "Stat Row",
  "LayoutPosition": 0,
  "CreatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "CreatedBy": null,
  "CreatedByFullName": "Max Miller",
  "CreatedOn": "2025-03-02T14:22:54.695573+00:00",
  "LastUpdatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "LastUpdatedBy": null,
  "LastUpdatedByFullName": "Max Miller",
  "LastUpdatedOn": "2026-01-20T13:34:14.4441971+00:00",
  "Metrics": []
}