Added properties on Workitem (#108)

* Added more properties to be updated on a workitem. Added 3 additional properties on a workitem; description, iterationpath & assignedto. * Updated parameters Removed the unecessary empty strings on the parameters.
MethodsAndPractices · Oct 15, 2018 · d5508fd · d5508fd
1 parent 8b6428e
commit d5508fd
Showing 1 changed file with 156 additions and 127 deletions.
diff --git a/src/workitems.psm1 b/src/workitems.psm1
@@ -7,147 +7,176 @@ $here = Split-Path -Parent $MyInvocation.MyCommand.Path
 # Apply types to the returned objects so format and type files can
 # identify the object and act on it.
 function _applyTypesToWorkItem {
-   param($item)
+    param($item)
 
-   # If there are ids in the list that don't map to a work item and empty
-   # entry is returned in its place if ErrorPolicy is Omit.
-   if ($item) {
-      $item.PSObject.TypeNames.Insert(0, 'Team.WorkItem')
-   }
+    # If there are ids in the list that don't map to a work item and empty
+    # entry is returned in its place if ErrorPolicy is Omit.
+    if ($item) {
+        $item.PSObject.TypeNames.Insert(0, 'Team.WorkItem')
+    }
 }
 
 function Add-VSTeamWorkItem {
-   [CmdletBinding()]
-   param(
-      [Parameter(Mandatory = $true)]
-      [string]$Title
-   )
-
-   DynamicParam {
-      $dp = _buildProjectNameDynamicParam -mandatory $true
-
-      # If they have not set the default project you can't find the
-      # validateset so skip that check. However, we still need to give
-      # the option to pass a WorkItemType to use.
-      if ($Global:PSDefaultParameterValues["*:projectName"]) {
-         $wittypes = _getWorkItemTypes -ProjectName $Global:PSDefaultParameterValues["*:projectName"]
-         $arrSet = $wittypes
-      }
-      else {
-         Write-Verbose 'Call Set-VSTeamDefaultProject for Tab Complete of WorkItemType'
-         $wittypes = $null
-         $arrSet = $null
-      }
-
-      $ParameterName = 'WorkItemType'
-      $rp = _buildDynamicParam -ParameterName $ParameterName -arrSet $arrSet
-      $dp.Add($ParameterName, $rp)
-
-      $dp
-   }
-
-   Process {
-      # Bind the parameter to a friendly variable
-      $ProjectName = $PSBoundParameters["ProjectName"]
-
-      # The type has to start with a $
-      $WorkItemType = "`$$($PSBoundParameters["WorkItemType"])"
-
-      $body = '[{"op": "add", "path": "/fields/System.Title", "from": null, "value": "' + $Title + '"}]'
-
-      # Call the REST API
-      $resp = _callAPI -ProjectName $ProjectName -Area 'wit' -Resource 'workitems'  `
-         -Version $([VSTeamVersions]::Core) -id $WorkItemType -Method Post `
-         -ContentType 'application/json-patch+json' -Body $body
-
-      _applyTypesToWorkItem -item $resp
-
-      return $resp
-   }
+    [CmdletBinding()]
+    param(
+        [Parameter(Mandatory = $true)]
+        [string]$Title,
+
+        [Parameter(Mandatory = $false)]
+        [string]$Description,
+
+        [Parameter(Mandatory = $false)]
+        [string]$IterationPath,
+
+        [Parameter(Mandatory = $false)]
+        [string]$AssignedTo
+    )
+
+    DynamicParam {
+        $dp = _buildProjectNameDynamicParam -mandatory $true
+
+        # If they have not set the default project you can't find the
+        # validateset so skip that check. However, we still need to give
+        # the option to pass a WorkItemType to use.
+        if ($Global:PSDefaultParameterValues["*:projectName"]) {
+            $wittypes = _getWorkItemTypes -ProjectName $Global:PSDefaultParameterValues["*:projectName"]
+            $arrSet = $wittypes
+        } else {
+            Write-Verbose 'Call Set-VSTeamDefaultProject for Tab Complete of WorkItemType'
+            $wittypes = $null
+            $arrSet = $null
+        }
+
+        $ParameterName = 'WorkItemType'
+        $rp = _buildDynamicParam -ParameterName $ParameterName -arrSet $arrSet
+        $dp.Add($ParameterName, $rp)
+
+        $dp
+    }
+
+    Process {
+        # Bind the parameter to a friendly variable
+        $ProjectName = $PSBoundParameters["ProjectName"]
+
+        # The type has to start with a $
+        $WorkItemType = "`$$($PSBoundParameters["WorkItemType"])"
+
+        # Constructing the contents to be send. 
+        # Empty parameters will be skipped when converting to json.
+        $body = @(
+            @{
+                op    = "add"
+                path  = "/fields/System.Title"
+                value = $Title
+            }
+            @{
+                op    = "add"
+                path  = "/fields/System.Description"
+                value = $Description
+            }
+            @{
+                op    = "add"
+                path  = "/fields/System.IterationPath"
+                value = $IterationPath
+            }
+            @{
+                op    = "add"
+                path  = "/fields/System.AssignedTo"
+                value = $AssignedTo
+            }) | Where { $_.value} | ConvertTo-Json
+
+        # Call the REST API
+        $resp = _callAPI -ProjectName $ProjectName -Area 'wit' -Resource 'workitems'  `
+            -Version $([VSTeamVersions]::Core) -id $WorkItemType -Method Post `
+            -ContentType 'application/json-patch+json' -Body $body
+
+        _applyTypesToWorkItem -item $resp
+
+        return $resp
+    }
 }
 
 function Show-VSTeamWorkItem {
-   [CmdletBinding()]
-   param(
-      [Parameter(Mandatory = $true, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Position = 0)]
-      [Alias('WorkItemID')]
-      [int] $Id
-   )
-
-   DynamicParam {
-      _buildProjectNameDynamicParam
-   }
-
-   process {
-      # Bind the parameter to a friendly variable
-      $ProjectName = $PSBoundParameters["ProjectName"]
-
-      Show-Browser "$([VSTeamVersions]::Account)/$ProjectName/_workitems/edit/$Id"
-   }
+    [CmdletBinding()]
+    param(
+        [Parameter(Mandatory = $true, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true, Position = 0)]
+        [Alias('WorkItemID')]
+        [int] $Id
+    )
+
+    DynamicParam {
+        _buildProjectNameDynamicParam
+    }
+
+    process {
+        # Bind the parameter to a friendly variable
+        $ProjectName = $PSBoundParameters["ProjectName"]
+
+        Show-Browser "$([VSTeamVersions]::Account)/$ProjectName/_workitems/edit/$Id"
+    }
 }
 
 function Get-VSTeamWorkItem {
-   [CmdletBinding(DefaultParameterSetName = 'ByID')]
-   param(
-      [Parameter(ParameterSetName = 'ByID', Mandatory = $true, ValueFromPipeline = $true, Position = 0)]
-      [int] $Id,
-
-      [Parameter(ParameterSetName = 'List', Mandatory = $true, ValueFromPipeline = $true, Position = 0)]
-      [int[]] $Ids,
-
-      [Parameter(ParameterSetName = 'List')]
-      [ValidateSet('Fail', 'Omit')]
-      [string] $ErrorPolicy = 'Fail',
-
-      [ValidateSet('None', 'Relations', 'Fields', 'Links', 'All')]
-      [string] $Expand = 'None',
-
-      [string[]] $Fields
-   )
-
-   DynamicParam {
-      _buildProjectNameDynamicParam -mandatory $true -Position 1
-   }
-
-   Process {
-      # Bind the parameter to a friendly variable
-      $ProjectName = $PSBoundParameters["ProjectName"]
-
-      # Call the REST API
-      if ($Ids) {
-         $resp = _callAPI -ProjectName $ProjectName -Area 'wit' -Resource 'workitems'  `
-            -Version $([VSTeamVersions]::Core) `
-            -Querystring @{
-            '$Expand'   = $Expand
-            fields      = ($Fields -join ',')
-            errorPolicy = $ErrorPolicy
-            ids         = ($ids -join ',')
-         }
-
-         foreach ($item in $resp.value) {
-            _applyTypesToWorkItem -item $item
-         }
-      }
-      else {
-         $a = $id[0]
-         $resp = _callAPI -ProjectName $ProjectName -Area 'wit' -Resource 'workitems'  `
-            -Version $([VSTeamVersions]::Core) -id "$a" `
-            -Querystring @{
-            '$Expand' = $Expand
-            fields      = ($Fields -join ',')
-         }
-
-         _applyTypesToWorkItem -item $resp
-      }
-
-      return $resp
-   }
+    [CmdletBinding(DefaultParameterSetName = 'ByID')]
+    param(
+        [Parameter(ParameterSetName = 'ByID', Mandatory = $true, ValueFromPipeline = $true, Position = 0)]
+        [int] $Id,
+
+        [Parameter(ParameterSetName = 'List', Mandatory = $true, ValueFromPipeline = $true, Position = 0)]
+        [int[]] $Ids,
+
+        [Parameter(ParameterSetName = 'List')]
+        [ValidateSet('Fail', 'Omit')]
+        [string] $ErrorPolicy = 'Fail',
+
+        [ValidateSet('None', 'Relations', 'Fields', 'Links', 'All')]
+        [string] $Expand = 'None',
+
+        [string[]] $Fields
+    )
+
+    DynamicParam {
+        _buildProjectNameDynamicParam -mandatory $true -Position 1
+    }
+
+    Process {
+        # Bind the parameter to a friendly variable
+        $ProjectName = $PSBoundParameters["ProjectName"]
+
+        # Call the REST API
+        if ($Ids) {
+            $resp = _callAPI -ProjectName $ProjectName -Area 'wit' -Resource 'workitems'  `
+                -Version $([VSTeamVersions]::Core) `
+                -Querystring @{
+                '$Expand'   = $Expand
+                fields      = ($Fields -join ',')
+                errorPolicy = $ErrorPolicy
+                ids         = ($ids -join ',')
+            }
+
+            foreach ($item in $resp.value) {
+                _applyTypesToWorkItem -item $item
+            }
+        } else {
+            $a = $id[0]
+            $resp = _callAPI -ProjectName $ProjectName -Area 'wit' -Resource 'workitems'  `
+                -Version $([VSTeamVersions]::Core) -id "$a" `
+                -Querystring @{
+                '$Expand' = $Expand
+                fields    = ($Fields -join ',')
+            }
+
+            _applyTypesToWorkItem -item $resp
+        }
+
+        return $resp
+    }
 }
 
 Set-Alias Add-WorkItem Add-VSTeamWorkItem
 Set-Alias Get-WorkItem Get-VSTeamWorkItem
 Set-Alias Show-WorkItem Show-VSTeamWorkItem
 
 Export-ModuleMember `
-   -Function Add-VSTeamWorkItem, Get-VSTeamWorkItem, Show-VSTeamWorkItem `
-   -Alias Add-WorkItem, Get-WorkItem, Show-WorkItem
+    -Function Add-VSTeamWorkItem, Get-VSTeamWorkItem, Show-VSTeamWorkItem `
+    -Alias Add-WorkItem, Get-WorkItem, Show-WorkItem