Get-FileReference

Summary

Retrieves an existing file reference.

Get-FileReference
    -Id

Returns a file reference object.

Parameters

Examples

Get an existing file reference

This example retrieves a specific file reference and outputs it as JSON.

# Retrieve a specific file reference by id
$entry = Get-FileReference -Id "6357baac3f8a41989c7aea6f94fd0114"

Write-Output "Retrieved file reference '$($entry.Name)' (Id: #$($entry.Id))"

# For debug purposes, convert the entity to output as JSON so we can see the available fields
Write-Output ""
Write-Output "JSON Results:"

$jsonOutput = $entry | ConvertTo-Json -Depth 10

# Output the entity
Write-Output $jsonOutput

Execution results:

Retrieved file reference 'Agility Blue REST API OAPIV3.0v001.json' (Id: #6357baac3f8a41989c7aea6f94fd0114)

JSON Results:
{
  "Id": "6357baac3f8a41989c7aea6f94fd0114",
  "Name": "Agility Blue REST API OAPIV3.0v001.json",
  "MediaType": "application/json",
  "Size": 532715,
  "SHA256": "a379e7d04538af5dfce60db23e84f6c6b72f4dd0b8090fd2a36077d54dea6427",
  "HasMatchingIgnoredFileEntry": false,
  "AssociatedObjectTypeId": 5,
  "AssociatedObjectTypeName": "Task",
  "AssociatedObjectId": 1259,
  "AssociatedObjectDisplayName": null,
  "AssociatedObjectDisplayReference": null,
  "AssociatedObjectParentClientId": null,
  "AssociatedObjectParentMatterId": null,
  "AssociatedObjectParentProjectId": null,
  "AssociatedObjectParentTaskId": null,
  "Notes": null,
  "CreatedByFullName": "Max Miller",
  "CreatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "CreatedOn": "2025-12-03T13:53:23.12158+00:00",
  "CreatedBy": null,
  "LastUpdatedByFullName": "Max Miller",
  "LastUpdatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "LastUpdatedOn": "2025-12-03T13:53:23.12158+00:00",
  "LastUpdatedBy": null
}