Adds a attachment to a Smartsheet.
Add either a file attachment or a URL attachment. URLs can point to links or cloud service files/folders.
Add-SmartsheetAttachment -Id <UInt64> -Path <String> [-description <String>] [-name <String>] [<CommonParameters>] Add-SmartsheetAttachment -Id <UInt64> [-Url <String>] [-Type <String>] [-subType <String>] [-description <String>] [-name <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| sheetId | UInt64 | Smartsheet Id. | true | true (ByPropertyName) | 0 | |
| String | Path to the file to attach. | true | false | |||
| String | URL to the cloud based resource. | false | false | |||
| String | The type of URL. | false | false | LINK | ||
| String | Subtype of URL. Only valid for EGNYTE and GOOGLE_DRIVE types. | false | false | DOCUMENT | ||
| String | A description of the attachment. | false | false | |||
| String | The name of the attachment. | false | false |
The output type is the type of the objects that the cmdlet emits.
Adds an image to a cell
Added an image to the specified cell reference.
Add-SmartSheetCellImage [-Id] <UInt64> [-rowId] <UInt64> [-columnId] <UInt64> [-Path] <String> [[-altText] <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| UInt64 | Smartsheet Id | true | true (ByPropertyName) | 0 | ||
| UInt64 | Smartsheet row Id. | true | false | 0 | ||
| UInt64 | Smartsheet column Id. | true | false | 0 | ||
| String | Path tot he local image file. | true | false | |||
| String | Alternative text associated with the image. | false | false |
The output type is the type of the objects that the cmdlet emits.
Add a column to a Smartsheet
Adds a new column to a smartsheet. Column can be specified as a column object or properties parameters.
If is column index already exists the column will be inserted at that position. Columns after that index will have their index
incremented by 1.
Add-SmartsheetColumn -Id <UInt64> -column <PSObject> [-PassThru] [<CommonParameters>] Add-SmartsheetColumn -Id <UInt64> -Index <Int32> [-title <String>] [-description <String>] [-type <String>] [-formula <PSObject>] [-hidden <Boolean>] [-autoNumberFormat <PSObject>] [-contactOptions <PSObject>] [-format <String>] [-locked <Boolean>] [-options <String[]>] [-symbol <String>] [-systemColumnType <String>] [-validation <Boolean>] [-width <Int32>] [-PassThru] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| sheetId | UInt64 | Id of the Smartsheet containing the column. | true | true (ByPropertyName) | 0 | |
| PSObject | A Smartsheet column object. Cannot be used with column property parameters. | true | false | |||
| Int32 | Index if the column to update. | true | false | 0 | ||
| String | Column Title | false | false | |||
| String | Column description | false | false | |||
| String | Column type | false | false | |||
| PSObject | The formula for a column, if set, for instance =data@row. | false | false | |||
| Boolean | Indicates visibility of the column. | false | false | False | ||
| PSObject | Object that describes how the the System Column type of "AUTO_NUMBER" is auto-generated. | false | false | |||
| PSObject | Array of ContactOption objects to specify a pre-defined list of values for the column. Column type must be CONTACT_LIST. The contact option object is in the form: email = {email address} name = {contact name} |
false | false | |||
| String | Format string. | false | false | |||
| Boolean | Indicates whether the column is locked. A value of true indicates that the column has been locked by the sheet owner or the admin. | false | false | False | ||
| String[] | Array of the options available for the column. | false | false | |||
| String | When applicable for CHECKBOX or PICKLIST column types. | false | false | |||
| String | If this is a system column what type is it. | false | false | |||
| Boolean | Indicates whether validation has been enabled for the column (value = true). | false | false | False | ||
| Int32 | Display width of the column in pixels. | false | false | 0 | ||
| SwitchParameter | Return the updated sheet. | false | false | False |
The output type is the type of the objects that the cmdlet emits.
To add a new colum to a Smartsheet. PS> $newColumn = $Sheet | Add-SmartsheetColumn -title "Title" -type:TEXT_NUMBER -description 'My new column'EXAMPLE 2
To insert a new column at position 4 (columns after position 4 are shifted to the right and their index incremented). PS> $newColumn = $Sheet | Add-SmartsheetColumn -title "Asset" -type:TEXT_NUMBER -Description "Fixed asset" -index 4EXAMPLE 3
Add a new column with contact objects.
PS> $contacts = @(
@{
email = "johndoe@example.com"
name = "John Doe"
},
@{
email = "janedoe@example.com"
name = 'Jane Doe
}
)
PS> $newColumn = $Sheet | Add-SmartsheetColumn -title "EmployeeName" -type:TEXT_NUMBER -contactOption $contacts
Add columns to a Smartsheet.
Adds an array of Smartsheet columns to a Smartsheet.
Add-SmartsheetColumns [-Id] <UInt64> [-columns] <PSObject[]> [-PassThru] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| sheetId | UInt64 | The Id of the smartsheet to add columns to. | true | true (ByPropertyName) | 0 | |
| PSObject[] | An array of smartsheet columns. | true | false | |||
| SwitchParameter | Return the updated Sheet. | false | false | False |
The output type is the type of the objects that the cmdlet emits.
Adds a new comment to a smartsheet discussion.
Add-SmartsheetComment [-Id] <UInt64> [-discussionId] <UInt64> [-text] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| sheetId | UInt64 | The Smartsheet Id. | true | true (ByPropertyName) | 0 | |
| UInt64 | The discussion Id. | true | false | 0 | ||
| String | The test of the new comment. | true | false |
The output type is the type of the objects that the cmdlet emits.
Create a new Smartsheet discussion.
Creates a new discussion at the sheet level.
To attach a file or URL to the comment use the New-SmartsheetCommentAttachment function.
Add-SmartsheetDiscussion [-Id] <UInt64> [-text] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| sheetId | UInt64 | The smartsheet Id. | true | true (ByPropertyName) | 0 | |
| String | The text of the comment. | true | false |
The output type is the type of the objects that the cmdlet emits.
Add a Smartsheet row,
Add a row to a smartsheet. The default location is the bottom of the sheet,
Add-SmartsheetRow -Id <UInt64> -Row <PSObject> [-location <String>] [-siblingRowId <String>] [-PassThru] [<CommonParameters>] Add-SmartsheetRow -Id <UInt64> [-expanded <Boolean>] [-format <String>] [-cells <PSObject[]>] [-locked <Boolean>] [-location <String>] [-siblingRowId <String>] [-PassThru] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| sheetId | UInt64 | Id of the sheet to add row to. | true | true (ByPropertyName) | 0 | |
| PSObject | A row object to add to the sheet. Cannot be used with individual row properties. | true | false | |||
| Boolean | Indicates whether the row is expanded or collapsed. | false | false | False | ||
| String | Format descriptor. Use New-SmartsheetFormatString to create format descriptors. | false | false | |||
| PSObject[] | Cells belonging to the row. | false | false | |||
| Boolean | Indicates whether the row is locked. | false | false | False | ||
| String | The location to insert the row. Default is 'bottom'. | false | false | bottom | ||
| String | If location is above of below the row ID to insert the ro above or below. Required when specifying 'above' or 'below' for location. | false | false | |||
| SwitchParameter | REturn the updated sheet. | false | false | False |
The output type is the type of the objects that the cmdlet emits.
Creates a new Smartsheet row discussion.
Creates a discussion on the specified row.
To attach a file or URL to a comment use the New-SmartsheetCommentAttachment function.
Add-SmartsheetRowDiscussion [-id] <UInt64> [-rowId] <UInt64> [-text] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| sheetId | UInt64 | The smartsheet Id. | true | true (ByPropertyName) | 0 | |
| UInt64 | The Row Id. | true | false | 0 | ||
| String | The text of the comment. | true | false |
The output type is the type of the objects that the cmdlet emits.
Add rows to a smartsheet
Add an array of row objects to a smartsheet.
Add-SmartsheetRows [-Id] <UInt64> [-Rows] <PSObject[]> [-PassThru] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| sheetId | UInt64 | The Id of the smartsheet to add the rows to. | true | false | 0 | |
| PSObject[] | An array of smartsheet row objects. | true | false | |||
| SwitchParameter | Return then update sheet. | false | false | False |
The output type is the type of the objects that the cmdlet emits.
Add a new Smartsheet Workspace.
Add a new Smartsheet Workspace to the given account using the settings provided.
Add-SmartsheetWorkspace -Name <String> [-Folders <PSObject[]>] [-Reports <PSObject[]>] [-Sheets <PSObject[]>] [-Sights <PSObject[]>] [-Templates <PSObject[]>] [-ExcludeCellLinksRemap] [-ExcludeReportsRemap] [-ExcludeSheetHyperlinkRemap] [-ExcludeSightsRemap] [<CommonParameters>] Add-SmartsheetWorkspace -Name <String> [-Folders <PSObject[]>] [-Reports <PSObject[]>] [-Sheets <PSObject[]>] [-Sights <PSObject[]>] [-Templates <PSObject[]>] [-IncludeAll] [-ExcludeCellLinksRemap] [-ExcludeReportsRemap] [-ExcludeSheetHyperlinkRemap] [-ExcludeSightsRemap] [<CommonParameters>] Add-SmartsheetWorkspace -Name <String> [-Folders <PSObject[]>] [-Reports <PSObject[]>] [-Sheets <PSObject[]>] [-Sights <PSObject[]>] [-Templates <PSObject[]>] [-IncludeAttachments] [-IncludeBrands] [-IncludeCellLinks] [-IncludeData] [-IncludeDiscussions] [-IncludeFilters] [-IncludeForms] [-IncludeRuleRecipients] [-IncludeRules] [-IncludeShares] [-ExcludeCellLinksRemap] [-ExcludeReportsRemap] [-ExcludeSheetHyperlinkRemap] [-ExcludeSightsRemap] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The name of the Workspace. | true | false | |||
| PSObject[] | An array of folder objects to add to the Workspace. | false | false | |||
| PSObject[] | An array of report objects to add to the Workspace. | false | false | |||
| PSObject[] | An array of sheet objects to add to the Workspace. | false | false | |||
| PSObject[] | An array dashboards to add to the Workspace. | false | false | |||
| PSObject[] | An array templates to add to the Workspace. | false | false | |||
| SwitchParameter | Include all of the below elements in the Workspace. | false | false | False | ||
| SwitchParameter | Include attachments. | false | false | False | ||
| SwitchParameter | Include brands. | false | false | False | ||
| SwitchParameter | Include cell links. | false | false | False | ||
| SwitchParameter | Include data. | false | false | False | ||
| SwitchParameter | Include discussions. | false | false | False | ||
| SwitchParameter | Include filters. | false | false | False | ||
| SwitchParameter | Include forms. | false | false | False | ||
| SwitchParameter | Include recipients. | false | false | False | ||
| SwitchParameter | Include rules. | false | false | False | ||
| SwitchParameter | Include shares. | false | false | False | ||
| SwitchParameter | Exclude cell link remaps. | false | false | False | ||
| SwitchParameter | Exclude reports remaps. | false | false | False | ||
| SwitchParameter | Exclude Sheet Hyperlink remaps. | false | false | False | ||
| SwitchParameter | Exclude dashboard remaps. | false | false | False |
The output type is the type of the objects that the cmdlet emits.
Create a folder in a Smartsheet workspace.
Create a top level folder in a workspace.
Add-SmartsheetWorkspaceFolder [-Id] <UInt64> [-Name] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| WorkspaceId | UInt64 | The Id of the workspace to create the folder in. | true | true (ByPropertyName) | 0 | |
| String | The name of the folder. | true | false |
The output type is the type of the objects that the cmdlet emits.
Copy a smartsheet to a new name and/or into a folder.
Copies a smartsheet giving it a new name, or copying it to a folder or copying to a folder with a new name.
Copy-Smartsheet -Id <UInt64> [-newSheetName <String>] [-includeAll] [-includeAttachments] [-includeCellLinks] [-includeFormatting] [-includeFilters] [-includeForms] [-includeRuleRecipients] [-includeRules] [-IncludeShares] [-excludeSheetHyperlinks] [-passThru] [<CommonParameters>] Copy-Smartsheet -Id <UInt64> [-newSheetName <String>] [-containerId <String>] [-containerType <String>] [-includeAll] [-includeAttachments] [-includeCellLinks] [-includeFormatting] [-includeFilters] [-includeForms] [-includeRuleRecipients] [-includeRules] [-IncludeShares] [-excludeSheetHyperlinks] [-passThru] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| SheetId | UInt64 | The sheet Id of the sheet to be copied. | true | true (ByPropertyName) | 0 | |
| String | The name of the new sheet. | false | false | |||
| String | The folder or workspace Id to copy the sheet to. | false | false | |||
| String | One of 'folder', workspace' or 'home' if containerType - 'home' containerId must be omitted. 'home' is the default value is omitted. |
false | false | home | ||
| SwitchParameter | Include all elements of the sheet | false | false | False | ||
| SwitchParameter | Include attachments | false | false | False | ||
| SwitchParameter | Include cell links. | false | false | False | ||
| SwitchParameter | Include formatting | false | false | False | ||
| SwitchParameter | Include filters | false | false | False | ||
| SwitchParameter | Include forms | false | false | False | ||
| SwitchParameter | Include rule recipients | false | false | False | ||
| SwitchParameter | Include rules. | false | false | False | ||
| SwitchParameter | Include Shares | false | false | False | ||
| SwitchParameter | Exclude sheet hyperlinks. | false | false | False | ||
| SwitchParameter | Returns the copied Smartsheet object. | false | false | False |
Copies Smartsheet attachments.
Copies all Smartsheet attachments from one sheet to another.
Copy-SmartsheetAttachments [-Id] <String> [-targetSheetId] <String> [-tempDir] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| sourceSheetId | String | true | true (ByPropertyName) | |||
| String | The Target Smartsheet Id. | true | false | |||
| String | The temporary directory to save the files to. (Linux/Mac = /tmp, Windows = TEMP environment variable.) | true | false |
Copy discussions from one Smartsheet to another.
Copy all discussions from a source Smartsheet to another smartsheet.
Copy-SmartsheetDiscussions [-Id] <UInt64> [-targetSheetId] <UInt64> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| sourceSheetId | UInt64 | The source Smartsheet Id. | true | true (ByPropertyName) | 0 | |
| UInt64 | The Target Smartsheet Id. | true | false | 0 |
Copy rows from on Smartsheet to another.
Copies selected rows tro the bottom of the target sheet.
Copy-SmartSheetRows -Id <UInt64> -targetSheetId <UInt64> -rowIds <UInt64[]> [-ignoreRowsNotFound] [<CommonParameters>] Copy-SmartSheetRows -Id <UInt64> -targetSheetId <UInt64> -rowIds <UInt64[]> [-includeAll] [-ignoreRowsNotFound] [<CommonParameters>] Copy-SmartSheetRows -Id <UInt64> -targetSheetId <UInt64> -rowIds <UInt64[]> [-includeAttachments] [-includeChildren] [-includeDiscussions] [-ignoreRowsNotFound] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| sourceSheetId | UInt64 | The source Sheet Id | true | true (ByPropertyName) | 0 | |
| UInt64 | The Target sheet Id. | true | false | 0 | ||
| UInt64[] | An array of row Ids to copy to the target sheet. | true | false | |||
| SwitchParameter | include all of 'attachments', 'children' and 'discussions' | false | false | False | ||
| SwitchParameter | Include row attachments. | false | false | False | ||
| SwitchParameter | Include Child rows. If specified, any child rows of the rows specified in the request are also copied to the destination sheet, and parent-child relationships amongst rows are preserved within the destination sheet; if not specified, only the rows specified in the request are copied. |
false | false | False | ||
| SwitchParameter | Include row discussions. | false | false | False | ||
| SwitchParameter | If specified, row Ids that do not exist within the source sheet does not cause an error response. If omitted, specifying row Ids that do not exist within the source sheet causes an error response (and no rows are copied). |
false | false | False |
The output type is the type of the objects that the cmdlet emits.
Copies a workspace.
Copies a workspace to the specified destination.
Copy-SmartsheetWorkspace -Id <UInt64> -NewName <String> [-DestinationId <UInt64>] [-DestinationType <String>] [-ExcludeCellLinksRemap] [-ExcludeReportsRemap] [-ExcludeSheetHyperlinkRemap] [-ExcludeSightsRemap] [<CommonParameters>] Copy-SmartsheetWorkspace -Id <UInt64> -NewName <String> [-DestinationId <UInt64>] [-DestinationType <String>] [-IncludeAll] [-ExcludeCellLinksRemap] [-ExcludeReportsRemap] [-ExcludeSheetHyperlinkRemap] [-ExcludeSightsRemap] [<CommonParameters>] Copy-SmartsheetWorkspace -Id <UInt64> -NewName <String> [-DestinationId <UInt64>] [-DestinationType <String>] [-IncludeAttachments] [-IncludeBrands] [-IncludeCellLinks] [-IncludeData] [-IncludeDiscussions] [-IncludeFilters] [-IncludeForms] [-IncludeRuleRecipients] [-IncludeRules] [-IncludeShares] [-ExcludeCellLinksRemap] [-ExcludeReportsRemap] [-ExcludeSheetHyperlinkRemap] [-ExcludeSightsRemap] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| WorkspaceId | UInt64 | The Id of the workspace to copy. | true | true (ByPropertyName) | 0 | |
| String | The new name of the workspace. | true | false | |||
| UInt64 | The Id of the destination container (when copying or moving a sheet or a folder). Required if destinationType is "folder" or "workspace". If destinationType is "home", this value must be null. |
false | false | 0 | ||
| String | Type of the destination container. | false | false | |||
| SwitchParameter | Include all of the below elements in the Workspace. | false | false | False | ||
| SwitchParameter | Include attachments. | false | false | False | ||
| SwitchParameter | Include brands. | false | false | False | ||
| SwitchParameter | Include cell links. | false | false | False | ||
| SwitchParameter | Include data. | false | false | False | ||
| SwitchParameter | Include discussions. | false | false | False | ||
| SwitchParameter | Include filters. | false | false | False | ||
| SwitchParameter | Include forms. | false | false | False | ||
| SwitchParameter | Include recipients. | false | false | False | ||
| SwitchParameter | Include rules. | false | false | False | ||
| SwitchParameter | Include shares. | false | false | False | ||
| SwitchParameter | Exclude cell link remaps. | false | false | False | ||
| SwitchParameter | Exclude reports remaps. | false | false | False | ||
| SwitchParameter | Exclude Sheet Hyperlink remaps. | false | false | False | ||
| SwitchParameter | Exclude dashboard remaps. | false | false | False |
The output type is the type of the objects that the cmdlet emits.
Exports a powershell array into a new Smartsheet.
Exports an array of PSObjects into a new smartsheet. This function will always create a new sheet even if
there is a sheet of the same name. The API will attempt to determine column types.
Export-SmartSheet -InputObject <PSObject> -SheetName <String> [-headerRow <Int32>] [-primaryColumn <Int32>] [<CommonParameters>] Export-SmartSheet -InputObject <PSObject> -SheetName <String> [-FolderId <UInt64>] [-headerRow <Int32>] [-primaryColumn <Int32>] [<CommonParameters>] Export-SmartSheet -InputObject <PSObject> -SheetName <String> [-WorkspaceId <UInt64>] [-headerRow <Int32>] [-primaryColumn <Int32>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| PSObject | Array of object to create the Smartsheet from. | true | true (ByValue) | |||
| String | The name of the new Smartsheet. | true | false | |||
| UInt64 | The folder ID of the folder to create the Smartsheet in. This can either be a folder from the home location or a folder in a Workspace. Use the Get-SmartsheetFolder or Get-SmartsheetWorkspaceFolders to get the Folder Id. |
false | false | 0 | ||
| UInt64 | The workspace to create the Smartsheet in. Use the Get-SmartsheetWorkspaces function to get the Workspace Id. This will create the sheet in the root of the workspace. To create a sheet in a folder in a workspace, specify the folder ID of the folder inside the workspace. At this time you cannot get a recursive list of all folders in a workspace, You can get a recursive list of all subfolders of a workspace folder. Use the Get-SmartsheetFolders function, specifying the top level folder ID and the Recursive property. |
false | false | 0 | ||
| Int32 | Row to use for column headers. All rows above this row are ignored. If omitted the first row will be used. A value of -1 will create default headers in the form Column1, Column1, etc. |
false | false | 0 | ||
| Int32 | The column to use as the primary column. default is the 1st column. | false | false | 0 |
Create a new sheet in the home folder. $ObjectArray | Export-Smartsheet -SheetName "MyNewSheet"EXAMPLE 2
Create a new sheet in the folder.
$Folder = Get-SmartsheetHomeFolders -Recurse | Where-object {$_.FullName like "Inventory/Westcoast"}
$objectArray | Export-Smartsheet -SheetName "MyNewSheet" -folder 'myfolder1/myfolder2'
EXAMPLE 3
Create a new sheet in a workspace folder.
$Workspace = Get-SmartsheetWorkspaces | Where-Object {$_.Name -eq 'Accounting'}
$APFolder = Get-SMartsheetWorkspaceFolders -WorkspaceId $Workspace.Id | Where-Object ($_.Name -eq 'Accounts Payable')
$PaymentsFolder = Get-SmartsheetFolders -FolderId $APFolder.Id -Recurse | Where-Object {$_.FullName -eq "Microsoft/Payments"}
$ObjectArray | Export-Smartsheet -Sheetname 'July Payments' -folder $PaymentsFolder.Id
Export an array and appends to a smartsheet.
Exports a Powershell array and appends new rows to a smartsheet.
If no columns exist in the smartsheet they are created as generic Columns, i.e. Column1, Column2.
To generate a smartsheet with named columns from the objects of the array use Export-Smartsheet.
Export-SmartsheetRows [[-InputObject] <PSObject>] [-sheetId] <UInt64> [-blankRowAbove] [[-title] <String>] [[-titleFormat] <String>] [-includeHeaders] [[-headerFormat] <String>] [-PassThru] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| PSObject | An array of Powershell objects. | false | true (ByValue) | |||
| UInt64 | The Smartsheet ID to put the data in. | true | false | 0 | ||
| SwitchParameter | Insert a blank row above the data being exported. | false | false | False | ||
| String | Insert a title row above the data. | false | false | |||
| String | A Smartsheet format string for the title. To create a format string use New-SmartsheetFormatString. | false | false | |||
| SwitchParameter | Create a header row from the property names of the objects in the array. | false | false | False | ||
| String | A Smartsheet format string for the headers. To create a format string use New-SmartsheetFormatString. | false | false | |||
| SwitchParameter | Return the sheet object with the inserted rows, | false | false | False |
The output type is the type of the objects that the cmdlet emits.
The following example imports the array into a Smartsheet, creates a blank row above the data and adds a title and a header row. (To create the format variables use New-SmartsheetFormatString) $Array | Export-SmartsheetRows -id $Sheet.Id -blankRowAbove -title "My Title" -TitleFormat $titleFormat -includeHeaders -headerFormat $headerFormatEXAMPLE 2
The following example imports the array into a smartsheet appending the rows to the existing sheet without any title or headers. This can be used to append rows to the Smartsheet. No attempt is made to prevent duplicate data. If the number of properties in the objects is more than the existing columns, then generic columns are created. (To update rows based in their primary column values use the Update-Smartsheet function.) $Array | Export-SmartsheetRows -id $Sheet.id
Retrieve an individual sheet.
Retrieves an individual sheet by either the sheet ID or the Name.
Note: There can be multiple sheets with the same name. Using the Sheet ID is more accurate!
The object returned has an additional method ToArray(), this method returns an array of PowerShell objects based on the sheet rows and columns.
The ToArray method can accept a boolean parameter that instructs the method to include or exclude the RowId in the objects returned.
True will return the row Id as a property of each object in the array. False will exclude the Row Id. False is the default.
By using the Row id, you can update the values in a Smartsheet without the need for the primary column to be unique.
The previous method of updating rows is included for backward compatibility and may eventually be removed.
Get-Smartsheet -id <UInt64> [-level <Int32>] [-includeAll] [-includeAttachments] [-includeColumnTypes] [-includeCrossSheetReferences] [-includeDiscussions] [-includeFilters] [-includeFilterDefinitions] [-includeFormat] [-includeGantConfig] [-includeObjectValue] [-includeOwnerInfo] [-includeRowPermalink] [-includeSource] [-includeWriterInfo] [-excludeFilteredOutRows] [-excludeLinkInFromCellDetails] [-excludeLinkOutToCellDetails] [-excludeNonexistentCells] [-columnIds <PSObject[]>] [-rowIds <PSObject[]>] [<CommonParameters>] Get-Smartsheet -Name <String> [-level <Int32>] [-includeAll] [-includeAttachments] [-includeColumnTypes] [-includeCrossSheetReferences] [-includeDiscussions] [-includeFilters] [-includeFilterDefinitions] [-includeFormat] [-includeGantConfig] [-includeObjectValue] [-includeOwnerInfo] [-includeRowPermalink] [-includeSource] [-includeWriterInfo] [-excludeFilteredOutRows] [-excludeLinkInFromCellDetails] [-excludeLinkOutToCellDetails] [-excludeNonexistentCells] [-columnIds <PSObject[]>] [-rowIds <PSObject[]>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| SheetId | UInt64 | Folder ID, cannot be used with the Name parameter. | true | true (ByValue, ByPropertyName) | 0 | |
| String | Sheet Name, cannot be used with the id parameter. | true | false | |||
| Int32 | Specifies whether new functionality, such as multi-contact data is returned in a backwards-compatible, text format (level=0, default), multi-contact data (level=1), or multi-picklist data (level=2). |
false | false | 0 | ||
| SwitchParameter | Include All Sheet objects | false | false | False | ||
| SwitchParameter | Includes the metadata for sheet-level and row-level attachments. To include discussion attachments, both includeAttachments and includeDiscussions must be present. |
false | false | False | ||
| SwitchParameter | Includes columnType attribute in the row's cells indicating the type of the column the cell resides in. | false | false | False | ||
| SwitchParameter | Includes the cross-sheet references | false | false | False | ||
| SwitchParameter | Includes sheet-level and row-level discussions. To include discussion attachments, both includeAttachments and includeDiscussions must be present. |
false | false | False | ||
| SwitchParameter | Includes filteredOut attribute indicating if the row should be displayed or hidden according to the sheet's filters. | false | false | False | ||
| SwitchParameter | Includes type of filter, operators used, and criteria | false | false | False | ||
| SwitchParameter | Includes column, row, cell, and summary fields formatting. | false | false | False | ||
| SwitchParameter | Includes Gantt chart details. | false | false | False | ||
| SwitchParameter | When used in combination with a level parameter, includes the email addresses for multi-contact data. | false | false | False | ||
| SwitchParameter | Includes the workspace and the owner's email address and user Id. | false | false | False | ||
| SwitchParameter | Includes permalink attribute that represents a direct link to the row in the Smartsheet application. | false | false | False | ||
| SwitchParameter | Adds the Source object indicating which report, sheet Sight (aka dashboard), or template the sheet was created from, if any. | false | false | False | ||
| SwitchParameter | Includes createdBy and modifiedBy attributes on the row or summary fields, indicating the row or summary field's creator, and last modifier. | false | false | False | ||
| SwitchParameter | Excludes filtered out rows from response payload if a sheet filter is applied; includes total number of filtered rows | false | false | False | ||
| SwitchParameter | Excludes the following attributes from the cell.linkInFromCell object: columnId, rowId, status | false | false | False | ||
| SwitchParameter | Excludes the following attributes from the cell.linksOutToCells array elements: columnId, rowId, status | false | false | False | ||
| SwitchParameter | Excludes cells that have never contained any data | false | false | False | ||
| PSObject[] | An array of column ids. The response contains only the specified columns in the "columns" array, and individual rows' "cells" array only contains cells in the specified columns. |
false | false | |||
| PSObject[] | A array of row Ids on which to filter the rows included in the result. | false | false |
The output type is the type of the objects that the cmdlet emits.
Get a Smartsheet Attachment.
Gets s specific attachment to a Smartsheet.
Get-SmartsheetAttachment -id <UInt64> -attachmentId <String> [<CommonParameters>] Get-SmartsheetAttachment -id <UInt64> -attachmentId <String> [-saveAs <String>] [<CommonParameters>] Get-SmartsheetAttachment -id <UInt64> -attachmentId <String> [-asByteArray <Byte[]>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| sheetId | UInt64 | The Smartsheet Id | true | true (ByPropertyName) | 0 | |
| String | The attachment Id. | true | false | |||
| String | Path and filename to save the attachment to. | false | false | |||
| Byte[] | Returns the attachment as a byte array. | false | false |
The output type is the type of the objects that the cmdlet emits.
Get a Smartsheet Attachment.
Get-SmartsheetAttachments [-id] <UInt64> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| sheetId | UInt64 | Smartsheet Id. | true | true (ByPropertyName) | 0 |
The output type is the type of the objects that the cmdlet emits.
Retrieve a Smartsheet column.
Retrieve a Smartsheet column from a specified smartsheet.
Get-SmartsheetColumn [-Id] <UInt64> [-ColumnId] <UInt64> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| UInt64 | The Id of the sheet to retrieve the column. | true | true (ByPropertyName) | 0 | ||
| UInt64 | The column Id to retrieve. | true | false | 0 |
The output type is the type of the objects that the cmdlet emits.
Retrieve Smartsheet columns.
Returns an array of the columns in a smartsheet.
Get-SmartsheetColumns [-Id] <UInt64> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| sheetId | UInt64 | The Id of the SMartsheet to return columns from. | true | true (ByPropertyName) | 0 |
The output type is the type of the objects that the cmdlet emits.
Gets a smartsheet discussion comment
Get-SmartSheetComment [-Id] <UInt64> [-commentId] <UInt64> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| sheetId | UInt64 | The smartsheet Id. | true | true (ByPropertyName) | 0 | |
| UInt64 | The comment Id. | true | false | 0 |
The output type is the type of the objects that the cmdlet emits.
Get Smartsheet Discussions
Gets all Discussions attached to the Smartsheet.
Returns both Sheet level and Row level discussions.
Get-SmartsheetDiscussions [-Id] <UInt64> [-includeAllComments] [-includeAttachments] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| sheetId | UInt64 | The Smartsheet Id | true | true (ByPropertyName) | 0 | |
| SwitchParameter | Include all comments. By default only the Discussion objects are returned. | false | false | False | ||
| SwitchParameter | Include all attachment. By default only the Discussion objects are returned. | false | false | False |
The output type is the type of the objects that the cmdlet emits.
Returns a folder object.
Returns the folder object specified by the folder Id.
Get-SmartsheetFolder [-folderId] <UInt64> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| UInt64 | ID of the folder to retrieve. | true | false | 0 |
The output type is the type of the objects that the cmdlet emits.
Retrieve a list of folders.
Returns an array of subfolder object from an existing folder.
This will not return subfolders from the Home folder. Use Get-SmartsheetHomeFolders to get this list.
Get-SmartsheetFolders [-Id] <UInt64> [[-Name] <String>] [-recurse] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| folderId | UInt64 | true | true (ByPropertyName) | 0 | ||
| String | false | true (ByPropertyName) | ||||
| SwitchParameter | This will return a list including all subfolders. This adds a new 'FullName'property which will be the full path of the folder from the folderID provided or the home folder. The returned array will look like this. id name permalink FullName -- ---- --------- -------- 7306313035212676 folder2 https://app.smartsheet.com/folders/V5g7j44M52jf9GgHgJcM2XPC8VP7mrq33VXCg741 folder2 5582828558673796 folder3 https://app.smartsheet.com/folders/fPpQw2qh24hFcVg9jRjCQqxH73Q85QVR243x77w1 folder2/folder3 6462437860894596 folder4 https://app.smartsheet.com/folders/C73GCm6M4hxcQ3f38cr3x57hwGGjpqp4mWr8mGx1 folder3/folder4 2079509634672516 folder3.1 https://app.smartsheet.com/folders/5P4JJfwF9Jj6rFvXJ94Gw9gG7rFm9cxM3QrxCxp1 folder2/folder3.1 You can filter the results by comparing the full or partial path to the FullName property. |
false | false | False |
The output type is the type of the objects that the cmdlet emits.
Return all home objects.
Gets a nested list of all Home objects, including dashboards, folders, reports, sheets, templates, and workspaces,
as shown on the "Home" tab.
Get-SmartsheetHome [<CommonParameters>]
The output type is the type of the objects that the cmdlet emits.
Return folder in the home tab.
Gets a list of folders in your Home tab. The list contains an abbreviated Folder object for each folder.
You cannot get a recursive list from the home folder. To get a recursive list of subfolders you must use the Get-SMartsheetFolders
function and specify a folder Id of one of the folder in this list.
Get-SmartsheetHomeFolders [<CommonParameters>]
The output type is the type of the objects that the cmdlet emits.
Returns Url to download the image.
Get-SmartsheetImageUrl [-Id] <UInt64> [[-saveAs] <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| imageId | UInt64 | Id of the image to get the Url for. | true | true (ByPropertyName) | 0 | |
| String | Path and filename to save the image to. | false | false |
The output type is the type of the objects that the cmdlet emits.
retrieve a Smartsheet row.
Retrieve a row from a smartsheet.
Get-SmartsheetRow [-Id] <UInt64> [-rowId] <UInt64> [-includeColumns] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| SheetId | UInt64 | Id of the Smartsheet to get the row from. | true | true (ByPropertyName) | 0 | |
| UInt64 | Id of the row to get. | true | false | 0 | ||
| SwitchParameter | Include column objects in the returned object. | false | false | False |
The output type is the type of the objects that the cmdlet emits.
Get Smartsheet row discussions
Gets discussions attached to a row.
Get-SmartsheetRowDiscussions [-id] <UInt64> [-rowId] <UInt64> [-includeComments] [-includeAttachments] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| sheetId | UInt64 | The Smartsheet Id. | true | true (ByPropertyName) | 0 | |
| UInt64 | The Row id. | true | false | 0 | ||
| SwitchParameter | Include comments. By default only the discussion objects are returned. | false | false | False | ||
| SwitchParameter | include attachments. By default only the discussion objects are returned. | false | false | False |
The output type is the type of the objects that the cmdlet emits.
Gets all smartsheet.
Gets an array of Smartsheet object associated the user has access to.
Get-Smartsheets [<CommonParameters>]
The output type is the type of the objects that the cmdlet emits.
Retrieve a workspace.
Retrieve a workspace object.
Get-SmartsheetWorkspace [-Id] <UInt64> [-IncludeSource] [-IncludeDistributionLink] [-IncludeOwnerInfo] [-IncludeSheetVersion] [-IncludePermaLinks] [-LoadNestedFolder] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| WorkspaceId | UInt64 | true | true (ByPropertyName) | 0 | ||
| SwitchParameter | Include the Source object indicating which object the folder was created from, if any. | false | false | False | ||
| SwitchParameter | INclude distribution links, | false | false | False | ||
| SwitchParameter | Include owner information. | false | false | False | ||
| SwitchParameter | Include sheet version | false | false | False | ||
| SwitchParameter | Include permalinks. | false | false | False | ||
| SwitchParameter | false | false | False |
The output type is the type of the objects that the cmdlet emits.
Retrieve workspace folders.
Retrieve a collection of the top level folders in a workspace.
Get-SmartsheetWorkspaceFolders [-Id] <UInt64> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| WorkspaceId | UInt64 | The Id of the workspace to retrieve folders from. | true | true (ByPropertyName) | 0 |
The output type is the type of the objects that the cmdlet emits.
Retrieve a list of Smartsheet Workspaces.
Get-SmartsheetWorkspaces [<CommonParameters>]
Sort rows in a Smartsheet.
Sort the rows in a smartsheet.
Get-SortedSmartsheet -id <UInt64> -sortCriteria <PSObject[]> [<CommonParameters>] Get-SortedSmartsheet -id <UInt64> -columnId <UInt64> [-direction <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| SheetId | UInt64 | Id of the sheet to sort rows in. | true | true (ByPropertyName) | 0 | |
| PSObject[] | An array of sort criteria objects. The objects should have 2 properties, columnId and direction (ASCENDING or DESCENDING) | true | false | |||
| UInt64 | Id of the column to sort on for a single column sort. | true | false | 0 | ||
| String | The direction of the sort. | false | false | ASCENDING |
The output type is the type of the objects that the cmdlet emits.
How to create a multi-sort sortCriteria object.
In this example we are going to sort a Smartsheet of employee salary information by Department and Salary in descending order.
To create the criteria create an array of hash table object.
PS> $sortCriteria - @(
@{
sortCriteria = @{
columnId = $Sheet.columns.Where({$_.title -eq "Department"}).ColumnId
direction = "ASCENDING"
},
@{
{
columnId = $Sheet.Columns.Where({$_.title -eq "Salary"}).ColumnId
direction = "DESCENDING"
}
}
)
Now sort the sheet.
PS >$SortedSheet = $sheet | Get-SortedSmartSheet -SortCriteria $sortCriteria
Move a Smartsheet
Move a Smartsheet into a different container.
Move-Smartsheet -Id <UInt64> [<CommonParameters>] Move-Smartsheet -Id <UInt64> [-containerId <String>] [-containerType <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| SheetId | UInt64 | ID of the the Smartsheet to move. | true | true (ByValue, ByPropertyName) | 0 | |
| String | Id of the container (folder/workspace) to move the Smartsheet to. if omitted the container is 'home' |
false | false | |||
| String | Can be one of 'folder', 'workspace or 'home'. If 'home' then containerId must be omitted. The default for this property is 'home' if omitted. |
false | false | home |
Move rows from one Smartsheet to another.
Moves selected rows to the bottom of the target sheet.
Move-SmartSheetRows -id <UInt64> -targetSheetId <UInt64> -rowIds <UInt64[]> [-ignoreRowsNotFound] [<CommonParameters>] Move-SmartSheetRows -id <UInt64> -targetSheetId <UInt64> -rowIds <UInt64[]> [-includeAll] [-ignoreRowsNotFound] [<CommonParameters>] Move-SmartSheetRows -id <UInt64> -targetSheetId <UInt64> -rowIds <UInt64[]> [-includeAttachments] [-includeDiscussions] [-ignoreRowsNotFound] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| sourceSheetId | UInt64 | The source Sheet Id | true | true (ByPropertyName) | 0 | |
| UInt64 | The Target sheet Id. | true | false | 0 | ||
| UInt64[] | An array of row Ids to move to the target sheet. | true | false | |||
| SwitchParameter | include both attachments and discussions. | false | false | False | ||
| SwitchParameter | Include row attachments. | false | false | False | ||
| SwitchParameter | Include row discussions. | false | false | False | ||
| SwitchParameter | If specified, row Ids that do not exist within the source sheet do not cause an error response. If omitted, specifying row Ids that do not exist within the source sheet causes an error response (and no rows are copied). |
false | false | False |
The output type is the type of the objects that the cmdlet emits.
Creates a new cell link object. This method only creates the CellLink object that can be later inserted into a Cell. Set the LinkInFromCell property to this object.
New-CellLink [-sheetId] <UInt64> [-sheetName] <String> [-columnId] <UInt64> [-rowId] <UInt64> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| UInt64 | Target Sheet Id. | true | false | 0 | ||
| String | Target Sheet name. | true | false | |||
| UInt64 | Target column Id. | true | false | 0 | ||
| UInt64 | Target row Id. | true | false | 0 |
The output type is the type of the objects that the cmdlet emits.
Creates a new Smartsheet Hyperlink object.
New-Hyperlink [-reportId <UInt64>] [<CommonParameters>] New-Hyperlink [-sheetId <UInt64>] [<CommonParameters>] New-Hyperlink [-sightId <UInt64>] [<CommonParameters>] New-Hyperlink [-url <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| UInt64 | Target report Id. | false | false | 0 | ||
| UInt64 | Target sheet Id. | false | false | 0 | ||
| UInt64 | Target sight od. | false | false | 0 | ||
| String | Target URL. | false | false |
The output type is the type of the objects that the cmdlet emits.
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| None | psobject[] | false | false | |||
| None | string | false | false | |||
| folderId, workspaceId | ulong | false | true (ByPropertyName) | |||
| None | switch | false | false | |||
| None | switch | false | false | |||
| None | switch | false | false | |||
| None | switch | false | false | |||
| None | switch | false | false | |||
| None | switch | false | false | |||
| None | switch | false | false | |||
| None | switch | false | false | |||
| None | switch | false | false | |||
| None | string | true | false | |||
| None | ulong | false | false |
Creates a new Smartsheet Cell object
New-SmartSheetCell [-columnId] <UInt64> [[-conditionalFormat] <String>] [[-format] <String>] [[-formula] <String>] [[-hyperlink] <PSObject>] [[-image] <PSObject>] [[-linkInFromCell] <PSObject>] [[-linksOutFromCell] <PSObject[]>] [-value] <PSObject> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| UInt64 | Column ID of the cell | true | false | 0 | ||
| String | A conditional format object. | false | false | |||
| String | A format descriptor string. | false | false | |||
| String | A formula string | false | false | |||
| PSObject | A hyperlink object | false | false | |||
| PSObject | An image object. | false | false | |||
| PSObject | A cell link object | false | false | |||
| PSObject[] | A cell link object | false | false | |||
| PSObject | The value of the cell | true | false |
The output type is the type of the objects that the cmdlet emits.
Create a Smartsheet Column object.
This function does not insert the column into a sheet. Use the Add-SmartsheetColumn function to add the column to a sheet.
New-SmartsheetColumn [-title] <String> [-primary] [[-description] <String>] [[-type] <String>] [[-formula] <PSObject>] [-hidden] [[-autoNumberFormat] <PSObject>] [[-contactOptions] <PSObject>] [[-format] <String>] [-locked] [[-options] <String[]>] [[-symbol] <String>] [[-systemColumnType] <String>] [-validation] [[-width] <Int32>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | Column title | true | false | |||
| SwitchParameter | Set this column to the primary column. NOTE: if a primary column already exists this wil cause an error when added to a smartsheet. |
false | false | False | ||
| String | Colunm description. | false | false | |||
| String | Column type. | false | false | TEXT_NUMBER | ||
| PSObject | Formula forthe column. | false | false | |||
| SwitchParameter | Column is hidden | false | false | False | ||
| PSObject | Object that describes how the the System Column type of "AUTO_NUMBER" is auto-generated. | false | false | |||
| PSObject | Array of ContactOption objects to specify a pre-defined list of values for the column. Column type must be CONTACT_LIST. | false | false | |||
| String | The format descriptor. | false | false | |||
| SwitchParameter | Column is locked. | false | false | False | ||
| String[] | Array of option for the column. Only valid for PICKLIST and MULTI_PICKLIST column types. | false | false | |||
| String | Only applicable for CHECKBOX and PICKLIST column types. | false | false | |||
| String | If this is a SystemColumn type the type of system column. | false | false | |||
| SwitchParameter | Is validation enabled. | false | false | False | ||
| Int32 | Width of the column in pixels. | false | false | 0 |
The output type is the type of the objects that the cmdlet emits.
Add a Smartsheet folder.
Add a folder to an existing Smartsheet folder.
This function will not add folder to the home folder. Use Add-SmartsheetHomeFolder to add a folder to home.
This function creates an empty folder. The functionality to create pre-populated folders my be included in the future.
New-SmartsheetFolder [-Id] <UInt64> [-folderName] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| folderId | UInt64 | Id of the folder to create the new folder in. | true | true (ByPropertyName) | 0 | |
| String | Name of the new folder. | true | false |
The output type is the type of the objects that the cmdlet emits.
Creates a SMartsheet format string. Supports: autocomplete.
Creates a smartsheet format string to be used with column, row, and cell formatting.
New-SmartSheetFormatString [[-fontFamily] <String>] [[-fontSize] <Int32>] [-bold] [-italic] [-underline] [-stikethrough] [[-horizontalAlign] <String>] [[-verticalAlign] <String>] [[-textColor] <String>] [[-backgroundColor] <String>] [[-taskbarColor] <String>] [[-currency] <String>] [[-decimalCount] <Int32>] [-thousandsSeparator] [[-numberFormat] <String>] [-textWrap] [[-dateFormat] <String>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | Sets the Font Family to use. | false | false | |||
| Int32 | Sets the font size. | false | false | 0 | ||
| SwitchParameter | Sets to font to bold. | false | false | False | ||
| SwitchParameter | Sets the font to italic | false | false | False | ||
| SwitchParameter | Sets the font to underline | false | false | False | ||
| SwitchParameter | Sets the font to strikethrough. | false | false | False | ||
| String | Set the horizontal alignment | false | false | |||
| String | Set the vertical alignment | false | false | |||
| String | Select the Text Color. Supports : autocomplete. | false | false | |||
| String | Select the Background color. Supports : autocomplete. | false | false | |||
| String | Select the Taskbar color. Supports : autocomplete. | false | false | |||
| String | Select the Currency Symbol. Supports : autocomplete. | false | false | |||
| Int32 | Set the decimal count | false | false | 0 | ||
| SwitchParameter | Sets the thousands separator. | false | false | False | ||
| String | Sets the Number format. Supports: autocomplete. | false | false | |||
| SwitchParameter | Sets textwrap. | false | false | False | ||
| String | sets the date format. Supports : autocomplete. | false | false |
The output type is the type of the objects that the cmdlet emits.
Create a folder int he home tab.
Create a new empty folder in the home tab.
New-SmartSheetHomeFolder [-folderName] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The name of the new folder. | true | false |
The output type is the type of the objects that the cmdlet emits.
Removes a smartsheet.
Removes a sheet by its SheetID.
Remove-Smartsheet [-Id] <UInt64> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| SheetId | UInt64 | Sheet Id, the sheet Id to remove. | true | true (ByPropertyName) | 0 |
Removed a Smartsheet attachment
Remove-SmartSheetAttachment [-Id] <String> [-attachmentId] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| sheetId | String | The Smartsheet Id. | true | true (ByPropertyName) | ||
| String | The attachment Id. | true | false |
The output type is the type of the objects that the cmdlet emits.
Remove a smartsheet column.
Remove a column from a smartsheet.
Remove-SmartsheetColumn [-Id] <UInt64> [-columnId] <UInt64> [-PassThru] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| sheetId | UInt64 | The Id of the Smartsheet to remove the column. | true | true (ByPropertyName) | 0 | |
| UInt64 | The Id of the column to remove. | true | false | 0 | ||
| SwitchParameter | Return the updated sheet. | false | false | False |
The output type is the type of the objects that the cmdlet emits.
Remove a smartsheet comment.
Remove-SmartsheetComment [-Id] <UInt64> [-commentId] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| sheetId | UInt64 | The smartsheet Id. | true | true (ByPropertyName) | 0 | |
| String | The comment Id. | true | false |
The output type is the type of the objects that the cmdlet emits.
Remove a Smartsheet discussion.
Removes a discussion from a smartsheet. This will remove all comments and attachments.
Remove-SmartsheetDiscussion [-id] <UInt64> [-discussionId] <UInt64> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| sheetid | UInt64 | The Smartsheet Id. | true | true (ByPropertyName) | 0 | |
| UInt64 | The discussion Id. | true | false | 0 |
The output type is the type of the objects that the cmdlet emits.
Remove a smartsheet folder
Removes a Smartsheet folder. WARNING: This function does not determine if the folder is empty before removing it.
Any contents of the folder will be lost.
Remove-SmartsheetFolder [-folderId] <UInt64> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| UInt64 | The Id of the folder to be removed. | true | false | 0 |
Remove a Smartsheet Row
Remove a row from a smartsheet.
Remove-SmartsheetRow [-Id] <UInt64> [-rowId] <UInt64> [-PassThru] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| SheetId | UInt64 | ID of Smartsheet to remove the row, | true | true (ByPropertyName) | 0 | |
| UInt64 | The rowID of the row to remove. | true | false | 0 | ||
| SwitchParameter | Return the updated sheet. | false | false | False |
The output type is the type of the objects that the cmdlet emits.
Remove Smartsheet Rows
Remove rows from a smartsheet.
Remove-SmartsheetRows [-Id] <UInt64> [-rowIds] <UInt64[]> [[-ignoreRowsNotFound] <Boolean>] [-PassThru] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| SheetId | UInt64 | ID of Smartsheet to remove the rows, | true | true (ByPropertyName) | 0 | |
| UInt64[] | An array of rowIDs to be remove. | true | false | |||
| Boolean | Suppress errors if row not found. | false | false | False | ||
| SwitchParameter | Returns the updated sheet. | false | false | False |
The output type is the type of the objects that the cmdlet emits.
Delete a Smartsheet workspace.
Deletes the specified workspace.
Remove-SmartSheetWorkspace [-Id] <UInt64> [-WhatIf] [-Confirm] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| WorkspaceId | UInt64 | The Id of thw workspace to delete. | true | true (ByPropertyName) | 0 | |
| wi | SwitchParameter | false | false | |||
| cf | SwitchParameter | false | false |
Rename a Smartsheet
Renames a smartsheet in the existing container.
Rename-SmartSheet [-Id] <UInt64> [-NewSheetName] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| SheetId | UInt64 | Id of the sheet to rename. | true | true (ByPropertyName) | 0 | |
| String | New name for the sheet | true | false |
Search a Smartsheet
Gets a list of the user's search results in a sheet based on query.
The list contains an abbreviated row object for each search result in a sheet.
Note Newly created or recently updated data may not be immediately discoverable via search.
Search-Smartsheet [-Id] <UInt64> [-searchText] <String> [-exact] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| sheetId | UInt64 | Sheet ID of the sheet to search. | true | true (ByPropertyName) | 0 | |
| String | Text to search for | true | false | |||
| SwitchParameter | Match text exactly. | false | false | False |
The output type is the type of the objects that the cmdlet emits.
Searches Smartsheets for the specified text.
This function searches all sheets that the user has access to for the tes provided.
Search-SmartsheetAccount [-searchText] <String> [-exact] [-personalWorkspaces] [[-modifiedSince] <DateTime>] [-favoriteFlag] [[-scopes] <String[]>] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The search text to search for. | true | false | |||
| SwitchParameter | Use an exact search for the given text. Without this switch, all words provided will be searched for. | false | false | False | ||
| SwitchParameter | Restrict the search to the users personal workspaces. | false | false | False | ||
| DateTime | Restrict the search to sheets modified after this date. | false | false | |||
| SwitchParameter | Indicates which returned items are favorites. favorite -- dashboards, folders, reports, sheets, templates, and workspaces will have the property favorite: true parentObjectFavorite -- attachments, discussions, summary fields, and rows will have the property parentObjectFavorite: true |
false | false | False | ||
| String[] | If search fails, try using an array for each type of this list of search filters. "attachments" "cellData" "comments" "folderNames" "reportNames" "sheetNames" "sightNames" "summaryFields" "templateNames" "workspaceNames" |
false | false |
Send a select set of rows via email,
Send-SmartsheetRowsViaEmail [-Id] <UInt64> [-rowIds] <UInt64[]> [[-columnIds] <UInt64[]>] [-To] <String[]> [[-subject] <String>] [[-message] <String>] [-includeAttachments] [-includeDiscussions] [[-layout] <String>] [-ccMe] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| sheetId | UInt64 | The Smartsheet Id. | true | true (ByPropertyName) | 0 | |
| UInt64[] | An array row Ids to be included. | true | false | |||
| UInt64[] | An array of column Ids to be included. If the columnIds attribute of the MultiRowEmail object is specified as an array of column Ids, those specific columns are included. If the columnIds attribute of the MultiRowEmail object is omitted, all columns except hidden columns shall be included. If the columnIds attribute of the MultiRowEmail object is specified as empty, no columns shall be included. (NOTE: In this case, either includeAttachments=true or includeDiscussions=true must be specified.) |
false | false | |||
| String[] | An array of recipients. | true | false | |||
| String | The subject of the email. | false | false | |||
| String | The message of the email. | false | false | |||
| SwitchParameter | Include attachment in email. | false | false | False | ||
| SwitchParameter | Include Discussions in email. | false | false | False | ||
| String | Layout of the rows. Either horizontal or Vertical. Default is horizontal for multiple rows, vertical for a single row. | false | false | HORIZONTAL | ||
| SwitchParameter | Copy email to sender. | false | false | False |
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| SheetId | ulong | true | true (ByPropertyName) | |||
| None | string | false | false | |||
| None | string | true | false | |||
| None | string[] | true | false | |||
| None | switch | false | false | |||
| None | string | false | false | |||
| None | string | false | false |
Set the API key.
Creates a file in the user profile folder in the .smartsheet folder named config.json.
This file contains the users Smartsheet API Token.
Set-SmartsheetAPIKey [-APIKey] <String> [-Secure] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| String | The Smartsheet API Access Token. | true | false | |||
| SwitchParameter | This switch instructs the function to save the APIKey into a secure vault. This vaule is created and managed by the modules: Microsoft.PowerShell.SecretManagement Microsoft.PowerShell.SecretStore See the note below on how to setup a secret store. |
false | false | False |
Update a Smartsheet column
Update the properties of a Smartsheet column.
Set-SmartsheetColumn -Id <UInt64> -ColumnId <UInt64> [-PassThru] [<CommonParameters>] Set-SmartsheetColumn -Id <UInt64> -ColumnId <UInt64> -column <PSObject> [-PassThru] [<CommonParameters>] Set-SmartsheetColumn -Id <UInt64> -ColumnId <UInt64> -Index <Int32> [-title <String>] [-description <String>] [-type <String>] [-formula <PSObject>] [-hidden <Boolean>] [-autoNumberFormat <PSObject>] [-contactOptions <PSObject>] [-format <String>] [-locked <Boolean>] [-options <String[]>] [-symbol <String>] [-systemColumnType <String>] [-validation <Boolean>] [-width <Int32>] [-PassThru] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| UInt64 | Id of the Smartsheet containing the column. | true | true (ByPropertyName) | 0 | ||
| UInt64 | Id of the column to update. | true | false | 0 | ||
| PSObject | A Smartsheet column object. Cannot be used with column property parameters. | true | false | |||
| Int32 | Index if the column to update. | true | false | 0 | ||
| String | Column Title | false | false | |||
| String | Column description | false | false | |||
| String | Column type | false | false | |||
| PSObject | The formula for a column, if set, for instance =data@row. | false | false | |||
| Boolean | Indicates visibility of the column. | false | false | False | ||
| PSObject | Object that describes how the the System Column type of "AUTO_NUMBER" is auto-generated. | false | false | |||
| PSObject | Array of ContactOption objects to specify a pre-defined list of values for the column. Column type must be CONTACT_LIST. | false | false | |||
| String | Format string. | false | false | |||
| Boolean | Indicates whether the column is locked. A value of true indicates that the column has been locked by the sheet owner or the admin. | false | false | False | ||
| String[] | Array of the options available for the column. | false | false | |||
| String | When applicable for CHECKBOX or PICKLIST column types. | false | false | |||
| String | If this is a system column what type is it. | false | false | |||
| Boolean | Indicates whether validation has been enabled for the column (value = true). | false | false | False | ||
| Int32 | Display width of the column in pixels. | false | false | 0 | ||
| SwitchParameter | Return the updated sheet. | false | false | False |
The output type is the type of the objects that the cmdlet emits.
Updates a smartsheet comment.
Updates the text of a Smartsheet comment. Only the owner of the comment can update the text.
Set-SmartSheetComment [-Id] <UInt64> [-commentId] <UInt64> [-text] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| sheetId | UInt64 | The Smartsheet Id. | true | true (ByPropertyName) | 0 | |
| UInt64 | The Command d. | true | false | 0 | ||
| String | The updated text for the comment. | true | false |
The output type is the type of the objects that the cmdlet emits.
Updates a Smartsheet row.
Updates the properties of a smartsheet row.
Set-SmartsheetRow -Id <UInt64> -Row <PSObject> [-PassThru] [<CommonParameters>] Set-SmartsheetRow -Id <UInt64> -rowId <UInt64> [-expanded <Boolean>] [-format <String>] [-Cells <PSObject[]>] [-locked <Boolean>] [-PassThru] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| sheetId | UInt64 | Id os the Smartsheet to update. | true | true (ByPropertyName) | 0 | |
| PSObject | A Smartsheet row object containing the updates (cannot be used with individual properties). | true | false | |||
| UInt64 | Row ID of the row to be updated. | true | false | 0 | ||
| Boolean | True if the row is expanded, false if not. | false | false | False | ||
| String | Format descriptor. Only returned if the include query string parameter contains format and this row has a non-default format applied. | false | false | |||
| PSObject[] | An array of Smartsheet cell objects. | false | false | |||
| Boolean | Indicates if the row is locked or not. | false | false | False | ||
| SwitchParameter | Return the updated sheet | false | false | False |
The output type is the type of the objects that the cmdlet emits.
Update multiple Smartsheet rows.
UPdate multiple rows in a Smartsheet.
Set-SmartsheetRows [-Id] <String> [[-Rows] <Object[]>] [-PassThru] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| SheetId | String | ID of the Smartsheet to update. | true | true (ByPropertyName) | ||
| Object[] | An array of smartsheet row objects. | false | false | |||
| SwitchParameter | Return the updated sheet. | false | false | False |
The output type is the type of the objects that the cmdlet emits.
Rename a workspace
Rename a workspace with teh specified name.
Set-SmartSheetWorkspace [-Id] <UInt64> [-Name] <String> [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| WorkspaceId | UInt64 | The Id of thw workspace to rename. | true | true (ByPropertyName) | 0 | |
| String | The new name of the workspace. | true | false |
The output type is the type of the objects that the cmdlet emits.
Update a smartsheet.
Update a Smartsheet from an array of powershell objects.
1. The number and names of the columns is the same as the properties in the object in the array.
2. If the array objects do not contain a property RowId then primary column is used to identify rows to be updated and must be unique.
3. If the Array objects contain the property RowId then this is used to identify the row to be updated. The primary column does not have to be unique.
Update-Smartsheet [-InputObject] <PSObject[]> [-sheetId] <UInt64> [-UseRowId] [-PassThru] [<CommonParameters>]
| Name | Alias | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|---|
| PSObject[] | An array of powershell objects. | true | true (ByValue) | |||
| UInt64 | The Id of the sheet to update. | true | false | 0 | ||
| SwitchParameter | This assumes that the objects in the array have a property called RowId which contains the Smartsheet row Id for the data, This will update the row associated with that Row Id. |
false | false | False | ||
| SwitchParameter | Return the updated sheet object. | false | false | False |
Update the rows in the smartsheet based on Primary Columns.
Update the rows in the smartsheet based on the RowId property.
Update the rows in the smartsheet based on the RowId property and return the updated sheet. $Array | Update-Smartsheet -SheetId $Sheet.Id -UseRowId -PassThru