Fix failure on successful record removal (#159)

* don't fail on 204 with delete

* make get all tables optional

* fix pipelining

* release prep

* changelog update

Author: gdbarron

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 3.1.1
+- Fix [#158](https://github.com/Snow-Shell/servicenow-powershell/issues/158), failure on successful record deletion
+- Move table details retrieval in `New-ServiceNowSession` to be switch operated, `-GetAllTable` and reduce function time
+- Fix pipelining in `Remove-ServiceNowRecord`
+
 ## 3.1.0
 - Add DateTime support to querying, [#68](https://github.com/Snow-Shell/servicenow-powershell/issues/68)
 - Add `-between` operator

ServiceNow/Private/Invoke-ServiceNowRestMethod.ps1

@@ -156,22 +156,32 @@ function Invoke-ServiceNowRestMethod {
         throw $_
     }
 
-    # TODO: this could use some work
-    # checking for content is good, but at times we'll get content that's not valid
-    # eg. html content when a dev instance is hibernating
-    if ( $response.Content ) {
-        $content = $response.content | ConvertFrom-Json
-        if ( $content.PSobject.Properties.Name -contains "result" ) {
-            $records = @($content | Select-Object -ExpandProperty result)
+    # validate response
+    switch ($Method) {
+        'Delete' {
+            if ( $response.StatusCode -ne 204 ) {
+                throw ('"{0} : {1}' -f $response.StatusCode, $response | Out-String )
+            }
         }
-        else {
-            $records = @($content)
+        Default {
+            # TODO: this could use some work
+            # checking for content is good, but at times we'll get content that's not valid
+            # eg. html content when a dev instance is hibernating
+            if ( $response.Content ) {
+                $content = $response.content | ConvertFrom-Json
+                if ( $content.PSobject.Properties.Name -contains "result" ) {
+                    $records = @($content | Select-Object -ExpandProperty result)
+                }
+                else {
+                    $records = @($content)
+                }
+            }
+            else {
+                # invoke-webrequest didn't throw an error per se, but we didn't get content back either
+                throw ('"{0} : {1}' -f $response.StatusCode, $response | Out-String )
+            }
         }
     }
-    else {
-        # invoke-webrequest didn't throw an error per se, but we didn't get content back either
-        throw ('"{0} : {1}' -f $response.StatusCode, $response | Out-String )
-    }
 
     $totalRecordCount = 0
     if ( $response.Headers.'X-Total-Count' ) {
@@ -187,7 +197,10 @@ function Invoke-ServiceNowRestMethod {
     # if option to get all records was provided, loop and get them all
     if ( $PSCmdlet.PagingParameters.IncludeTotalCount.IsPresent ) {
 
-        Write-Warning "Getting $($totalRecordCount - $PSCmdlet.PagingParameters.Skip) records, this could take a while..."
+        $retrieveRecordCount = $totalRecordCount - $PSCmdlet.PagingParameters.Skip
+        if ( $retrieveRecordCount -ne 0 ) {
+            Write-Warning "Getting $retrieveRecordCount records..."
+        }
 
         $setPoint = $params.body.sysparm_offset + $params.body.sysparm_limit
 

ServiceNow/Public/New-ServiceNowSession.ps1

@@ -29,6 +29,9 @@ Credential of user who can access Proxy.  If not provided, the current user will
 .PARAMETER ApiVersion
 Specific API version to use.  The default is the latest.
 
+.PARAMETER GetAllTable
+Populate $ServiceNowTable with data from all tables the user has access to
+
 .PARAMETER PassThru
 Provide the resulting session object to the pipeline as opposed to setting as a script scoped variable to be used by default for other calls.
 This is useful if you want to have multiple sessions with different api versions, credentials, etc.
@@ -99,6 +102,9 @@ function New-ServiceNowSession {
         [Parameter()]
         [int] $ApiVersion,
 
+        [Parameter()]
+        [switch] $GetAllTable,
+
         [Parameter()]
         [switch] $PassThru
     )
@@ -217,25 +223,27 @@ function New-ServiceNowSession {
         $Script:ServiceNowSession = $newSession
     }
 
-    Write-Verbose 'Getting table number prefixes'
-    $defaultTable = $ServiceNowTable
-    try {
-        $numbers = Get-ServiceNowRecord -Table 'sys_number' -Property prefix, category -First 10000
-        foreach ($number in $numbers) {
-            if ( $number.prefix.ToLower() -notin $defaultTable.NumberPrefix ) {
-                $ServiceNowTable.Add(
-                    [pscustomobject] @{
-                        "Name"             = ($number.category.link | Select-String -Pattern '^.*\?name=(.*)$').matches.groups[1].Value
-                        "ClassName"        = $number.category.display_value
-                        "Type"             = $null
-                        "NumberPrefix"     = $number.prefix.ToLower()
-                        "DescriptionField" = "short_description"
-                    }
-                ) | Out-Null
+    if ( $GetAllTable.IsPresent ) {
+        Write-Verbose 'Getting table number prefixes'
+        $defaultTable = $ServiceNowTable
+        try {
+            $numbers = Get-ServiceNowRecord -Table 'sys_number' -Property prefix, category -First 10000 -IncludeTotalCount
+            foreach ($number in $numbers) {
+                if ( $number.prefix.ToLower() -notin $defaultTable.NumberPrefix ) {
+                    $ServiceNowTable.Add(
+                        [pscustomobject] @{
+                            "Name"             = ($number.category.link | Select-String -Pattern '^.*\?name=(.*)$').matches.groups[1].Value
+                            "ClassName"        = $number.category.display_value
+                            "Type"             = $null
+                            "NumberPrefix"     = $number.prefix.ToLower()
+                            "DescriptionField" = "short_description"
+                        }
+                    ) | Out-Null
+                }
             }
         }
-    }
-    catch {
-        Write-Verbose "Session created, but failed to populate ServiceNowTable.  Prefixes beyond the default won't be available.  $_"
+        catch {
+            Write-Verbose "Session created, but failed to populate ServiceNowTable.  Prefixes beyond the default won't be available.  $_"
+        }
     }
 }

ServiceNow/Public/Remove-ServiceNowRecord.ps1

@@ -1,13 +1,17 @@
 function Remove-ServiceNowRecord {
+
     [CmdletBinding(ConfirmImpact = 'High')]
+
     Param(
         # Table containing the entry we're deleting
         [parameter(Mandatory, ValueFromPipelineByPropertyName)]
+        [ValidateNotNullOrEmpty()]
         [Alias('sys_class_name')]
         [string] $Table,
 
         # sys_id of the entry we're deleting
         [parameter(Mandatory, ValueFromPipelineByPropertyName)]
+        [ValidateNotNullOrEmpty()]
         [Alias('sys_id')]
         [string] $SysId,
 
@@ -18,13 +22,19 @@ function Remove-ServiceNowRecord {
         [hashtable] $ServiceNowSession = $script:ServiceNowSession
     )
 
-    $params = @{
-        Method            = 'Delete'
-        Table             = $Table
-        SysId             = $SysId
-        Connection        = $Connection
-        ServiceNowSession = $ServiceNowSession
+    begin {
+
+    }
+
+    process {
+        $params = @{
+            Method            = 'Delete'
+            Table             = $Table
+            SysId             = $SysId
+            Connection        = $Connection
+            ServiceNowSession = $ServiceNowSession
+        }
+
+        Invoke-ServiceNowRestMethod @params
     }
-    
-    Invoke-ServiceNowRestMethod @params
 }

ServiceNow/ServiceNow.psd1

@@ -5,7 +5,7 @@
 RootModule = 'ServiceNow.psm1'
 
 # Version number of this module.
-ModuleVersion = '3.1.0'
+ModuleVersion = '3.1.1'
 
 # ID used to uniquely identify this module
 GUID = 'b90d67da-f8d0-4406-ad74-89d169cd0633'