Home  ›  Tfs Work Item Attach Uploaded Attachments Api C#

Tfs Work Item Attach Uploaded Attachments Api C#

Written By Saturday 16 April 2022 Add Comment Edit
  • Chen V
  • Updated engagement Jul 12, 2017
  • 10.5k
  • 1

It'south like shooting fish in a barrel to utilize Excel add-ins or extensions from market identify to export the piece of work items. And so why would we build a script in PowerShell? Read this blog to learn the answer.

It's easy to utilize Excel add-ins or extensions from marketplace to export the work items, right? Then why build a script in PowerShell?

To answer this in curt, I manage multiple instances for multiple projects so I use PowerShell, which is a quick way for me to explore work items in i go!

Comments

  1. <#
  2. .SYNOPSIS
  3.     A PowerShell function to export Visual Studio Team Servies work items.
  4. .Description
  5.     A PowerShell role to consign Visual Studio Team Servies work items.
  6. .EXAMPLE
  7.     PS C:\> Export-VSTSWorkItem -Instance "Fabrikam" -Token "PAT -WorkItemType Bug
  8.     Yields all the bugsin  from the work items tabular array.
  9. .EXAMPLE
  10.     PS C:\> Consign-VSTSWorkItem -Example "Fabrikam" -Token "PAT"-WorkItemType Task
  11.     Yields all the chorein  from the work items table.
  12. .EXAMPLE
  13.     PS C:\> Export-VSTSWorkItem -Example "Fabrikam" -Token "PAT"-WorkItemType Epic
  14.     Yields all the epicin  from the work items table.
  15. .EXAMPLE
  16.     PS C:\> Consign-VSTSWorkItem -Instance "Fabrikam" -Token "PAT"-WorkItemType Ballsy -ExportAs Csv
  17.     Exports informationevery bit  csv
  18. .EXAMPLE
  19.     PS C:\> Consign-VSTSWorkItem -Instance "Fabrikam" -Token "PAT"-WorkItemType Epic -ExportAs FancyHtml
  20.     Exports dataas  a fancy html
  21. .NOTES
  22.     @ChendrayanV
  23. #>

Parameters are my best friend as always,

  1. param (
  2.         # Visual Studio Team Services Account Name
  3.         [Parameter(Mandatory)]
  4.         $Instance,
  6.         # Create a Personal Admission Token
  7.         [Parameter(Mandatory)]
  8.         $Token,
  10.         # Opt the Work Items Type. (Change as required)
  11.         [Parameter(Mandatory)]
  12.         [ValidateSet('Bug' , 'Task' , 'Ballsy' , 'Characteristic' )]
  13.         $WorkItemType,
  15.         # Consign in your favorite format.
  16.         [Parameter()]
  17.         [ValidateSet('Csv' , 'HTML' , 'FancyHTML' )]
  18.         $ExportAs
  19. )

Nosotros utilise a personal access token so it's a must to convert the token to base 64 cord. Equally a organisation admin, it took some fourth dimension for me to understand but the beneath snippet makes it happen.

  1. $Authentication = ( ":$Token" )
  2. $Hallmark = [System.Text.Encoding]::ASCII.GetBytes($Authentication)
  3. $Authentication = [System.Catechumen]::ToBase64String($Authentication)

Using switch argument, modify the WIQL every bit illustrated below.

  1. switch  ($WorkItemType)
  2. {
  3. "Issues"
  4.     {
  5.         $Body = @{
  6.             Query ="Select * from WorkItems WHERE [System.WorkItemType] = '$WorkItemType'"
  7.         } | ConvertTo-Json
  8.     }
  9. "Task"
  10.     {
  11.         $Body = @{
  12.             Query ="Select * from WorkItems WHERE [System.WorkItemType] = '$WorkItemType'"
  13.         } | ConvertTo-Json
  14.     }
  15. "Ballsy"
  16.     {
  17.         $Body = @{
  18.             Query ="Select * from WorkItems WHERE [Organisation.WorkItemType] = '$WorkItemType'"
  19.         } | ConvertTo-Json
  20.     }
  21. "Feature"
  22.     {
  23.         $Trunk = @{
  24.             Query ="Select * from WorkItems WHERE [System.WorkItemType] = '$WorkItemType'"
  25.         } | ConvertTo-Json
  26.     }
  27. }

Only, we are converting the hash table to JSON using ConvertTo-Json cmdlet and with no more than theory, below is the full script!

  1. part Export-VSTSWorkItem
  2. {
  3. <#
  4. .SYNOPSIS
  5.     A PowerShell function to consign Visual Studio Team Servies piece of work items.
  6. .DESCRIPTION
  7.     A PowerShell function to consign Visual Studio Team Servies piece of work items.
  8. .Case
  9.     PS C:\> Export-VSTSWorkItem -Case'Fabrikam'  -Token "PAT"  -WorkItemType Bug
  10.     Yields all the bugsin  from the work items tabular array.
  11. .EXAMPLE
  12.     PS C:\> Export-VSTSWorkItem -Instance'Fabrikam'  -Token "PAT"  -WorkItemType Task
  13.     Yields all the taskin  from the work items tabular array.
  14. .Example
  15.     PS C:\> Export-VSTSWorkItem -Case'Fabrikam'  -Token "PAT"  -WorkItemType Epic
  16.     Yields all the epicin  from the work items tabular array.
  17. .Instance
  18.     PS C:\> Export-VSTSWorkItem -Instance'Fabrikam'  -Token "PAT"  -WorkItemType Ballsy -ExportAs Csv
  19.     Exports informationas  csv
  20. .EXAMPLE
  21.     PS C:\> Consign-VSTSWorkItem -Case'Fabrikam'  -Token "PAT"  -WorkItemType Epic -ExportAs FancyHtml
  22.     Exports dataequally  a fancy html
  23. .NOTES
  24.     @ChendrayanV
  25. #>
  26.     [CmdletBinding()]
  27.     param (
  28.         # Visual Studio Team Services Account Name
  29.         [Parameter(Mandatory)]
  30.         $Instance,
  32.         # Create a Personal Access Token
  33.         [Parameter(Mandatory)]
  34.         $Token,
  36.         # Opt the Work Items Type. (Change as required)
  37.         [Parameter(Mandatory)]
  38.         [ValidateSet('Bug' , 'Task' , 'Ballsy' , 'Feature' )]
  39.         $WorkItemType,
  41.         # Export in your favorite format.
  42.         [Parameter()]
  43.         [ValidateSet('Csv' , 'HTML' , 'FancyHTML' )]
  44.         $ExportAs
  45.     )
  47.     brainstorm
  48.     {
  49.     }
  51.     process
  52.     {
  53.         $Hallmark = (":$Token" )
  54.         $Authentication = [Arrangement.Text.Encoding]::ASCII.GetBytes($Authentication)
  55.         $Authentication = [System.Catechumen]::ToBase64String($Authentication)
  56. switch  ($WorkItemType)
  57.         {
  58. "Bug"
  59.             {
  60.                 $Body = @{
  61.                     Query ="Select * from WorkItems WHERE [Organisation.WorkItemType] = '$WorkItemType'"
  62.                 } | ConvertTo-Json
  63.             }
  64. "Task"
  65.             {
  66.                 $Body = @{
  67.                     Query ="Select * from WorkItems WHERE [System.WorkItemType] = '$WorkItemType'"
  68.                 } | ConvertTo-Json
  69.             }
  70. "Ballsy"
  71.             {
  72.                 $Body = @{
  73.                     Query ="Select * from WorkItems WHERE [Arrangement.WorkItemType] = '$WorkItemType'"
  74.                 } | ConvertTo-Json
  75.             }
  76. "Feature"
  77.             {
  78.                 $Body = @{
  79.                     Query ="Select * from WorkItems WHERE [System.WorkItemType] = '$WorkItemType'"
  80.                 } | ConvertTo-Json
  81.             }
  82.         }
  83.         $RestParams = @{
  84.             Uri         ="https://$Instance.visualstudio.com/DefaultCollection/_apis/wit/wiql?api-version=one.0"
  85.             Method      ="Mail"
  86.             ContentType ="application/json"
  87.             Headers     = @{
  88.                 Authorization = ("Basic {0}"  -f $Authentication)
  89.             }
  90.             Torso        = $Trunk
  91.         }
  92. effort
  93.         {
  94.             $Id = (Invoke-RestMethod @RestParams).workitems.id -join","
  95. if  ($Id -ne $ cipher )
  96.             {
  97.                 $Fields = @('System.Id' , 'System.Title' , 'System.AssignedTo' ,
  98. 'Organization.Country' , 'System.CreatedBy' , 'System.WorkItemType' ) -join ","
  99.                 $RestParams["Uri" ] = "https://$Instance.visualstudio.com/DefaultCollection/_apis/wit/WorkItems?ids=$Id&fields=$Fields&api-version=1"
  100.                 $RestParams["Method" ] = "Become"
  101.                 $RestParams.Remove("Trunk" )
  102.                 $Issue = Invoke-RestMethod @RestParams
  103. if  (! $PSBoundParameters[ 'ExportAs' ])
  104.                 {
  105.                     ($Result.value.fields)
  106.                 }
  107.             }
  108. else
  109.             {
  110.                 Write-Alert"No Items are available in $WorkItemType"
  111.             }
  113. switch  ($ExportAs)
  114.             {
  115. 'csv'
  116.                 {
  117.                     $Outcome.value.fields | Consign-Csv .\WITReport.csv -NoTypeInformation
  118.                 }
  119. 'HTML'
  120.                 {
  121.                     $Result.value.fields | Consign-Csv .\WITReport.html -NoTypeInformation
  122.                 }
  123. 'FancyHTML'
  124.                 {
  125.                     Add-Content".\style.CSS"   -Value " body {
  126.                     font-family:Calibri;
  127.                     font-size:10pt;
  128.                     }
  129.                     th {
  130.                     background-color:black;
  131.                     color:white;
  132.                     }
  133.                     td {
  134.                     background-color:#19fff0;
  135.                     color:black;}"
  136.                     $Result.value.fields | ConvertTo-Html -CssUri .\Manner.css | Out-File .\Written report.html
  137.                 }
  138.             }
  139.         }
  140. take hold of
  141.         {
  142.             $_.Exception.Message
  143.         }
  144.     }
  146.     terminate
  147.     {
  148.     }
  149. }

Enjoy PowerShell!

Before long I volition connect with you lot all with a series of detailed blog posts under the umbrella of  "Work with Visual Studio Squad Services using REST API in PowerShell".

cabapissompons1998.blogspot.com

Source: https://www.c-sharpcorner.com/blogs/export-visual-studio-team-services-work-items-using-powershell

0 Response to "Tfs Work Item Attach Uploaded Attachments Api C#"

Post a Comment

Subscribe to: Post Comments (Atom)

Iklan Atas Artikel

Iklan Tengah Artikel 1

Iklan Tengah Artikel 2

Iklan Bawah Artikel