New-FilesActionNotificationExport
Create Action Notification Export.
Syntax
Description
Create Action Notification Export.
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 Action Notification Export
Writes the action notification export returned.
Example 2: Preview the change
Describes the change without sending anything to Files.com.
Parameters
-UserId
User ID. Provide a value of 0 to operate the current session's user.
- Type:
System.Int64 - Parameter sets:
(All)
-WorkspaceId
Workspace whose logs are exported. Set to 0 for the default workspace. A null value means a site-wide export.
- Type:
System.Int64 - Parameter sets:
(All)
-StartAt
Start date/time of export range. Give a DateTime from Get-Date, a DateTimeOffset, or ISO 8601 text with an offset such as 2026-01-31T14:00:00Z.
- Type:
System.DateTimeOffset - Parameter sets:
(All)
-EndAt
End date/time of export range. Give a DateTime from Get-Date, a DateTimeOffset, or ISO 8601 text with an offset such as 2026-01-31T14:00:00Z.
- Type:
System.DateTimeOffset - Parameter sets:
(All)
-QueryMessage
Error message associated with the request, if any.
- Type:
System.String - Parameter sets:
(All)
-QueryRequestMethod
The HTTP request method used by the webhook.
- Type:
System.String - Parameter sets:
(All)
-QueryRequestUrl
The target webhook URL.
- Type:
System.String - Parameter sets:
(All)
-QueryStatus
The HTTP status returned from the server in response to the webhook request.
- Type:
System.String - Parameter sets:
(All)
-QuerySuccess
true if the webhook request succeeded (i.e. returned a 200 or 204 response status). false otherwise.
- Type:
System.Boolean - Parameter sets:
(All)
-QueryPath
Return notifications that were triggered by actions on this specific path.
- Type:
System.String - Parameter sets:
(All)
-QueryFolder
Return notifications that were triggered by actions in this folder.
- Type:
System.String - 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
$ConfirmPreferenceofHigh, the command runs without asking;-Confirmmakes 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.ActionNotificationExport: the action notification export 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.