Get-CustomObject
  • 1 Minute to read
  • Dark
    Light
  • PDF

Get-CustomObject

  • Dark
    Light
  • PDF

Article summary

Summary

Retrieves an existing custom object entry.

Get-CustomObject
    -Id
    -CustomObjectId

Returns a custom object entry.

Parameters

Parameter

Type

Required?

Notes

Id

Int32

Yes

The custom object entry id.

CustomObjectId

Int32

Yes

The object id.

Examples

Get an existing custom object instance

This example retrieves a specific custom object entry and outputs it as JSON.

$relativityWorkspace = Get-CustomObject -Id 1 -CustomObjectId 12

Write-Output $relativityWorkspace | ConvertTo-Json -Depth 10
{
  "CreatedByFullName": "Service Account",
  "LastUpdatedById": "410e109b-6ff5-4442-9670-cd5e3cd82a7f",
  "CF_42": "Archived",
  "CreatedOn": "2021-03-08T21:20:24.3277082Z",
  "LastUpdatedByFullName": "Service Account",
  "Id": 1,
  "CF_40": "Salt v Pepper",
  "LastUpdatedOn": "2021-03-08T21:21:16.9218359Z",
  "CreatedById": "410e109b-6ff5-4442-9670-cd5e3cd82a7f",
  "CF_41": "12345"
}