PowerShell Rest API V3

PowerShell Rest API V3

I figured it would be worthwhile to share the PowerShell script I have that uses API v3 for working with requests. Hopefully this will help some people that are trying to use this.

  2. $ApiKey = "API Key here" # Technician API Key
  3. $SdpUri = "http://sdpurl.com" # SDP URL

  5. # Gets information on an existing request
  6. function Get-Request
  7. {
  8. [CmdletBinding()]
  9. param
  10. (
  11. [Parameter(Mandatory=$true, ValueFromPipelineByPropertyName=$true, Position=0)] 
  12. [alias ("id")]
  13. [Int32]
  14. $RequestID,
  15. [Parameter(Mandatory=$true, ValueFromPipelineByPropertyName=$true, Position=2)] 
  16. [String]
  17. $ApiKey,
  18. [Parameter(Mandatory=$true, ValueFromPipelineByPropertyName=$true, Position=3)] 
  19. [String]
  20. $SdpUri,
  21. [Parameter(Mandatory=$false, ValueFromPipelineByPropertyName=$true)]
  22. [String] 
  23. $Manager, # Manager field
  24. [Parameter(Mandatory=$false, ValueFromPipelineByPropertyName=$true)]
  25. [String] 
  26. $RequestFor, # Person Request is For
  27. [Parameter(Mandatory=$false, ValueFromPipelineByPropertyName=$true)] 
  28. [Int32]
  29. $OracleID # Oracle iD 
  30. )

  32. $input= @"
  33. {
  34. "request":{
  35. "udf_fields":{
  36. "udf_sline_18083": "$RequestFor",
  37. "udf_sline_18081": "$Manager",
  38. "udf_long_18098": "$OracleID"
  39. }
  40. } 
  41. }
  42. "@


  45. $header = @{TECHNICIAN_KEY=$ApiKey} 
  46. $params = @{input_data=$input;format='json'}
  47. $Uri = $SdpUri + "/api/v3/requests/" + $RequestID
  48. $result = Invoke-RestMethod -Method Get -Uri $Uri -Headers $header -OutFile "\\server\users\username\Ticket.json"
  49. $result
  50. }

  52. # Creates a request using provided information
  53. function Add-Request
  54. {
  55. [CmdletBinding()]
  56. param
  57. (
  58. [Parameter(Mandatory=$true, ValueFromPipelineByPropertyName=$true, Position=2)] 
  59. [String]
  60. $ApiKey,
  61. [Parameter(Mandatory=$true, ValueFromPipelineByPropertyName=$true, Position=3)] 
  62. [String]
  63. $SdpUri,
  64. [Parameter(Mandatory=$false, ValueFromPipelineByPropertyName=$true)]
  65. [String] 
  66. $Requester
  67. )

  69. $input= @"
  70. {
  71. "request":{
  72. "subject": "Unable to fetch mails",
  73. "description": "I am unable to fetch mails from the mail server",
  74. "requester":{
  75. "name": "$Requester",
  76. },
  77. "template": {
  78. "name": "Software Request",
  79. },
  80. "udf_fields":{
  81. "udf_date_21049":{
  82. "display_value": "1551462180000",
  83. },
  84. "udf_sline_18083": "John Doe",
  85. "udf_sline_18081": "John Smith"
  86. },
  87. "status":{
  88. "name": "Open"
  89. }
  90. } 
  91. }
  92. "@

  94. $header = @{TECHNICIAN_KEY=$ApiKey} 
  95. $params = @{input_data=$input;format='json'}
  96. $Uri = $SdpUri + "/api/v3/requests"
  97. $result = Invoke-RestMethod -Method POST -Uri $Uri -Headers $header -Body $params -ContentType "application/x-www-form-urlencoded"
  98. $result
  99. }

  101. # Edits an existing request
  102. function Edit-Request
  103. {
  104. <#
  105. This function can edit any field of a request ticket. Input for field values would have to be added if additional input is needed.
  106. #>

  108. [CmdletBinding()]
  109. param
  110. (
  111. [Parameter(Mandatory=$true, ValueFromPipelineByPropertyName=$true, Position=0)] 
  112. [alias ("id")]
  113. [Int32]
  114. $RequestID,
  115. [Parameter(Mandatory=$true, ValueFromPipelineByPropertyName=$true, Position=2)] 
  116. [String]
  117. $ApiKey,
  118. [Parameter(Mandatory=$true, ValueFromPipelineByPropertyName=$true, Position=3)] 
  119. [String]
  120. $SdpUri,
  121. [Parameter(Mandatory=$false, ValueFromPipelineByPropertyName=$true)]
  122. [String] 
  123. $Manager, # Manager field
  124. [Parameter(Mandatory=$true, ValueFromPipelineByPropertyName=$true)] 
  125. [String]
  126. $OracleID # Oracle iD 
  127. )

  129. # Input for the request fields
  130. $input= @"
  131. {
  132. "request":{
  133. "udf_fields":{
  134. "udf_sline_18081": "$Manager",
  135. "udf_long_18098": "$OracleID"
  136. }
  137. } 
  138. }
  139. "@
  140. $header = @{TECHNICIAN_KEY=$ApiKey} 
  141. $params = @{input_data=$input;format='json'}
  142. $Uri = $SdpUri + "/api/v3/requests/" + $RequestID
  143. $result = Invoke-RestMethod -Method PUT -Uri $Uri -Headers $header -Body $params -ContentType "application/x-www-form-urlencoded"
  144. $result
  145. }  

  147. # Gets ticket information from the specified request ID. Response is stored in a json file then used as an input.
  148. function Update-Request 
  149. {
  150. Get-Request -ApiKey $ApiKey -SdpUri $SdpUri -RequestID 94036 
  151. $Json= Get-Content -Raw "\\server\users\username\Ticket.json" | Out-String | ConvertFrom-Json
  152. $oDataHash = @{}
  153. $Json.request | Get-Member -MemberType NoteProperty | ForEach-Object{
  154.     $oDataHash += @{
  155.         $_.name = $Json.request."$($_.name)" 
  156.     }
  157. }

  159. #Convert hashtable to pscustomobject
  160. $oData = New-Object -TypeName PSCustomObject

  162. $oData | Add-Member -MemberType ScriptMethod -Name AddNote -Value {
  163.     Add-Member -InputObject $this -MemberType NoteProperty -Name $args[0] -Value $args[1]
  164. } 

  166. $oDataHash.Keys | Sort-Object | ForEach-Object{

  168.     $oData.AddNote($_,$oDataHash.$_)
  169. }

  171. Import-Module ActiveDirectory
  172. $adid= Get-ADUser -Filter "Name -like '$($oData.udf_fields.udf_sline_18083)'" -Properties EmployeeID,Manager | Select-Object EmployeeID,@{n="ManagerName";e={(Get-ADUser -Identity $_.Manager -Properties displayName).DisplayName}}
  173. Edit-Request -ApiKey $ApiKey -SdpUri $SdpUri -RequestID 94036 -OracleID "$($adid.employeeid)" -Manager "$($adid.managername)"
  174. }
  175. # Put function you want to use below here