Remove-PTodo

NAME Remove-PTodo



SYNOPSIS

Deletes a todo.





SYNTAX

Remove-PTodo [-PopuliUri] <String> [-PopuliAuthkey] <String> -TodoId <Int32> [-WhatIf] [-Confirm]

[<CommonParameters>]





DESCRIPTION

*Remove was used instead of delete since it is the approved verb for powershell commands.

This function can only be used on todos 1) assigned to the currently logged-in user,

2) assigned by the currently logged-in user or

3) public todos attached to somone's profile if the currently logged-in user has the Staff role.





PARAMETERS

-PopuliUri <String>

Set to the correct URL for your college (i.e. https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/).

This parameter is required.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-PopuliAuthkey <String>

The authentication key with necessary permissions for the data you are requesting.

This parameter is required.



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-TodoId <Int32>

The numeric ID of the todo you're interested in.

Use the Get-PTodos or the Add-PTodo cmdlet to get the TodoId.

This parameter is required.



Required? true

Position? named

Default value 0

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

Returns PowerShell objects:

SUCCESS or FAILURE





NOTES





Author: Matthew Rehm

Creation Date: 09/06/2019



-------------------------- EXAMPLE 1 --------------------------



Remove-PTodo -PopuliUri 'https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/ -PopuliAuthkey '1234567890' -TodoId

'15940549'













-------------------------- EXAMPLE 2 --------------------------



PS C:\\>#Store your Populi Credentials in a hash table:



$PopuliCredentials = @{

PopuliURI = https://<YOUR_SUBDOMAIN_HERE>.populiweb.com/api/

PopuliAuthkey = '1ReallyLongAlphaNumericSequence'

}

Remove-PTodo @PopuliCredentials -TodoId '15940549'











RELATED LINKS