Added help, used lean params, set format to existing option

Author: Rick-2CA

ServiceNow/Public/Get-ServiceNowRequestItem.ps1

@@ -1,63 +1,61 @@
 function Get-ServiceNowRequestItem {
+<#
+    .SYNOPSIS
+        Query for Request Item (RITM) tickets.
+
+    .DESCRIPTION
+        Query for Request Item (RITM) tickets from the sc_req_item table.
+
+    .EXAMPLE
+        Get-ServiceNowRequestItem -MatchExact @{number='RITM0000001'}
+
+        Return the details for RITM0000001
+
+    .OUTPUTS
+        System.Management.Automation.PSCustomObject
+#>
+
+    [OutputType([System.Management.Automation.PSCustomObject])]
+    [CmdletBinding(DefaultParameterSetName)]
     param(
         # Machine name of the field to order by
-        [parameter(mandatory = $false)]
-        [parameter(ParameterSetName = 'SpecifyConnectionFields')]
-        [parameter(ParameterSetName = 'UseConnectionObject')]
-        [parameter(ParameterSetName = 'SetGlobalAuth')]
+        [parameter(Mandatory = $false)]
         [string]$OrderBy = 'opened_at',
 
         # Direction of ordering (Desc/Asc)
-        [parameter(mandatory = $false)]
-        [parameter(ParameterSetName = 'SpecifyConnectionFields')]
-        [parameter(ParameterSetName = 'UseConnectionObject')]
-        [parameter(ParameterSetName = 'SetGlobalAuth')]
-        [ValidateSet("Desc", "Asc")]
+        [parameter(Mandatory = $false)]
+        [ValidateSet('Desc', 'Asc')]
         [string]$OrderDirection = 'Desc',
 
         # Maximum number of records to return
-        [parameter(mandatory = $false)]
-        [parameter(ParameterSetName = 'SpecifyConnectionFields')]
-        [parameter(ParameterSetName = 'UseConnectionObject')]
-        [parameter(ParameterSetName = 'SetGlobalAuth')]
+        [parameter(Mandatory = $false)]
         [int]$Limit = 10,
 
         # Hashtable containing machine field names and values returned must match exactly (will be combined with AND)
-        [parameter(mandatory = $false)]
-        [parameter(ParameterSetName = 'SpecifyConnectionFields')]
-        [parameter(ParameterSetName = 'UseConnectionObject')]
-        [parameter(ParameterSetName = 'SetGlobalAuth')]
+        [parameter(Mandatory = $false)]
         [hashtable]$MatchExact = @{},
 
         # Hashtable containing machine field names and values returned rows must contain (will be combined with AND)
-        [parameter(mandatory = $false)]
-        [parameter(ParameterSetName = 'SpecifyConnectionFields')]
-        [parameter(ParameterSetName = 'UseConnectionObject')]
-        [parameter(ParameterSetName = 'SetGlobalAuth')]
+        [parameter(Mandatory = $false)]
         [hashtable]$MatchContains = @{},
 
         # Whether or not to show human readable display values instead of machine values
-        [parameter(mandatory = $false)]
-        [parameter(ParameterSetName = 'SpecifyConnectionFields')]
-        [parameter(ParameterSetName = 'UseConnectionObject')]
-        [parameter(ParameterSetName = 'SetGlobalAuth')]
-        [ValidateSet("true", "false", "all")]
+        [parameter(Mandatory = $false)]
+        [ValidateSet('true', 'false', 'all')]
         [string]$DisplayValues = 'true',
 
         [Parameter(ParameterSetName = 'SpecifyConnectionFields', Mandatory = $True)]
         [ValidateNotNullOrEmpty()]
-        [PSCredential]
-        $ServiceNowCredential,
+        [Alias('ServiceNowCredential')]
+        [PSCredential]$Credential,
 
         [Parameter(ParameterSetName = 'SpecifyConnectionFields', Mandatory = $True)]
         [ValidateNotNullOrEmpty()]
-        [string]
-        $ServiceNowURL,
+        [string]$ServiceNowURL,
 
         [Parameter(ParameterSetName = 'UseConnectionObject', Mandatory = $True)]
         [ValidateNotNullOrEmpty()]
-        [Hashtable]
-        $Connection
+        [hashtable]$Connection
     )
 
     # Query Splat
@@ -88,6 +86,6 @@ function Get-ServiceNowRequestItem {
 
     # Perform query and return each object in the format.ps1xml format
     $Result = Get-ServiceNowTable @getServiceNowTableSplat
-    $Result | ForEach-Object {$_.PSObject.TypeNames.Insert(0, "ServiceNow.RequestItem")}
+    $Result | ForEach-Object {$_.PSObject.TypeNames.Insert(0,'ServiceNow.Request')}
     $Result
 }