Extract metadata

​

Prerequisites

​

Windows

​

macOS & Linux

pwsh

PowerShell 7.2.5
Copyright (c) Microsoft Corporation.

https://aka.ms/powershell
Type 'help' to get help.

PS /Users/user/repos/boxcli/examples>

​

Box CLI

​

Configure the script

1. Clone the boxcli GitHub repository and cd into this example’s folder or download the files from the examples directory.
   git clone https://github.com/box/boxcli.git
   cd boxcli/examples/Metadata\ Extraction/
   
2. Specify the folderID and userID parameters to tell the script which folder to scan, and who is the user running the script.
   [string]$FolderID = "",
   [string]$UserID = "",
   
   If you don’t want to specify the parameters directly in the script, you can either pass them as flags or allow the script to prompt you to enter them. A sample command with flags looks as follows:
   ./Metadata-extraction.ps1 -folderId 123456789 -userId 123456789
   

​

Run the script

1. Run the Powershell command.
   pwsh
   
2. Run the script.
   ./Metadata-extraction.ps1 -folderId 123456789 -userId 123456789
   
   When the script finishes, you will see the following output or a similar one.
   Pulling data from Folder ID: 173961139760
   metadata as user ID: 20718545815
   Reading Item ID: 1016853559790
   Metadata saved to: MetadataTemplate_properties.csv
   

​

Logs

• Metadata-extraction_all.txt that contains all log entries.
• Metadata-extraction_errors.txt that contains only errors.