Set-RelativityUsageReportRequest

Summary

Updates an existing Relativity usage report request.

Warning!

Usage report requests are automatically handled by the system and typically don’t need intervention. Updating a usage report request programmatically could cause that request to become unstable so be careful with which properties you modify.

Set-RelativityUsageReportRequest
    -Entry

Returns a Relativity usage report request object.

Parameters

Examples

Update an existing linked Relativity workspace

This example moves an existing link to a different matter.

# Retrieve an existing Relativity usage report request
$request = Get-RelativityUsageReportRequest -Id 326

# Change the Name to include the status in the name 
# Note: most of the fields here are handled automatically by the system, and modifying them could 
# cause the request to become unstable. It's generally best to leave these alone unless you need to fix something
# or you are trying to intentionally place the request in a state that causes the collection to fail.
$request.Name = "[$($request.Status)] $($request.Name)"

# Update the request
$request = Set-RelativityUsageReportRequest -Entry $request

# Output some information to help indicate that the request was updated
Write-Output "Updated Relativity usage report request '$($request.Name)' (Id: #$($request.RelativityUsageReportRequestId), Status: $($request.Status))"

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

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

# Output the JSON results
Write-Output $jsonOutput

Execution results:

Updated Relativity usage report request '[Completed] Generated by Agility Blue on 2026-01-19 10:00:01Z' (Id: #326, Status: Completed)

JSON Results:
{
  "RelativityUsageReportRequestId": 326,
  "UsageReportKeyId": "5a3c1d61-8385-493a-8199-8574d0d6a982",
  "IntegrationId": 1,
  "Integration": null,
  "IntegrationName": "Relativity",
  "IntegrationIdentifier": "https://agilityblue.relativity.one",
  "IntegrationEnabled": true,
  "TenantId": "c158517c-5c42-4e26-a2aa-6a4470eef6c1",
  "Name": "[Completed] Generated by Agility Blue on 2026-01-19 10:00:01Z",
  "FromDate": "2026-01-01T00:00:00+00:00",
  "ToDate": "2026-01-31T00:00:00+00:00",
  "Type": "Workspace",
  "Status": "Completed",
  "CreatedAt": "2026-01-19T10:00:01.9486405+00:00",
  "Version": 1,
  "CollectedOn": "2026-01-19T10:00:15.1119703+00:00",
  "CountOfCollectedMetrics": 180,
  "CountOfCollectedWorkspaces": 9,
  "CountOfErrorsDuringCollection": 0,
  "ArchivedOn": null,
  "CreatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "CreatedBy": null,
  "CreatedByFullName": "Max Miller",
  "CreatedOn": "2026-01-19T10:00:01.9821869+00:00",
  "LastUpdatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "LastUpdatedBy": null,
  "LastUpdatedByFullName": "Max Miller",
  "LastUpdatedOn": "2026-01-19T18:04:40.3172005+00:00",
  "Metrics": []
}