New-FilesRequest

Create Request.

Syntax

New-FilesRequest -Path <System.String> -Destination <System.String> [-UserIds <System.Int64[]>] [-GroupIds <System.Int64[]>] [-Connection <FilesCom.PowerShell.FilesConnection>] [-WorkspaceScope <System.Int64>] [-NoWorkspaceScope] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Create Request.

The command supports -WhatIf, which describes the change without sending it to Files.com, and -Confirm, which asks before sending it.

Examples

Example 1: Create Request

New-FilesRequest -Path 'path' -Destination 'destination'

Writes the request returned.

Example 2: Preview the change

New-FilesRequest -Path 'path' -Destination 'destination' -WhatIf

Describes the change without sending anything to Files.com.

Parameters

-Path

Folder path on which to request the file.

  • Type: System.String
  • Parameter sets: (All) (required)

-Destination

Destination filename (without extension) to request.

  • Type: System.String
  • Parameter sets: (All) (required)

-UserIds

A list of user IDs to request the file from. If sent as a string, it should be comma-delimited. Give the values as an array; the module joins them as the API expects.

  • Type: System.Int64[]
  • Parameter sets: (All)

-GroupIds

A list of group IDs to request the file from. If sent as a string, it should be comma-delimited. Give the values as an array; the module joins them as the API expects.

  • Type: System.Int64[]
  • Parameter sets: (All)

-Connection

The connection to use, from Connect-FilesAccount. Defaults to the connection of the -InputObject or -Continuation given, and otherwise to the current runspace's default connection.

  • Type: FilesCom.PowerShell.FilesConnection
  • Parameter sets: (All)

-WorkspaceScope

Runs this command's requests in this workspace, including workspace 0, instead of the connection's or, for an -InputObject, instead of the workspace the object was read in. The connection and the object are unchanged.

  • Type: System.Int64
  • Parameter sets: (All)

-NoWorkspaceScope

Runs this command's requests in no workspace, even if the connection has one. The connection itself is unchanged.

  • Type: System.Management.Automation.SwitchParameter
  • Parameter sets: (All)

-Confirm

Prompts you for confirmation before running the cmdlet.

  • Type: System.Management.Automation.SwitchParameter
  • Confirm impact: Medium. At the default $ConfirmPreference of High, the command runs without asking; -Confirm makes it ask before each change.

-WhatIf

Shows what the cmdlet would change without sending anything to Files.com.

  • Type: System.Management.Automation.SwitchParameter

Common Parameters

This cmdlet supports the PowerShell common parameters, such as -Verbose and -ErrorAction.

Inputs

None. The command takes no pipeline input.

Outputs

  • FilesCom.PowerShell.Models.Request: the request as Files.com returned it.

Notes

Failures are written as error records with IDs such as Files.NotFound or Files.Authentication. Run Get-Help about_FilesCom for connections, paging, errors and previewing changes.