Skip to content

Latest commit

 

History

History
162 lines (111 loc) · 3.62 KB

Get-PSWorkItemArchive.md

File metadata and controls

162 lines (111 loc) · 3.62 KB
external help file Module Name online version schema
PSWorkItem-help.xml
PSWorkItem
2.0.0

Get-PSWorkItemArchive

SYNOPSIS

Get archived PSWorkItems.

SYNTAX

name (Default)

Get-PSWorkItemArchive [[-Name] <String>] [-Path <String>] [<CommonParameters>]

id

Get-PSWorkItemArchive [-ID <String>] [-Path <String>] [<CommonParameters>]

category

Get-PSWorkItemArchive [-Category <String>] [-Path <String>] [<CommonParameters>]

DESCRIPTION

Completed PSWorkItems are moved to the Archive table. Use this command to view completed items.

EXAMPLES

Example 1

PS C:\> Get-PSWorkItemArchive

    Database: C:\Users\Jeff\PSWorkItem.db

ID Name               Description                          Category Completed
-- ----               -----------                          -------- ---------
1  upgrade prep                                            Temp     7/29/2023 10:35:42 AM
2  Order dog food                                          Personal 7/30/2023 10:09:09 AM
3  Update-PSScripting update scripting and toolmaking book Project  7/30/2023 10:13:45 AM
4  car inspection                                          Personal 7/30/2023 10:35:03 AM
6  Clean database                                          Other    7/30/2023 10:40:48 AM
5  weekly report                                           work     8/1/2023 8:30:00 AM

Get all archived PSWorkItems.

Example 2

PS C:\> Get-PSWorkItemArchive -Category Personal

    Database: C:\Users\Jeff\PSWorkItem.db

ID Name           Description Category Completed
-- ----           ----------- -------- ---------
2  Order dog food             Personal 7/30/2023 10:09:09 AM
4  car inspection             Personal 7/30/2023 10:35:03 AM

Get archived PSWorkItems by category.

PARAMETERS

-Category

Get all open PSWorkItems by category. There should be tab completion for this parameter. If you will be specifying an alternate database path, specify the path before using this parameter so that correct categories will be detected.

Type: String
Parameter Sets: category
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ID

The task ID. This value will most likely be different than the original ID.

Type: String
Parameter Sets: id
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Name

The name of the work item. Wildcards are supported.

Type: String
Parameter Sets: name
Aliases: task

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-Path

The path to the PSWorkItem SQLite database file. It should end in .db

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: $PSWorkItemPath
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.String

OUTPUTS

PSWorkItemArchive

NOTES

Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/

RELATED LINKS

Complete-PSWorkItem

Get-PSWorkItem