Kelverion.ServiceDeskPlus.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <!--Edited with: SAPIEN PowerShell HelpWriter 2018 v2.2.38--> <!--Generated by: SAPIEN PowerShell HelpWriter 2018 v2.2.38--> <!-- Module: Kelverion.ServiceDeskPlus Version: 1.0 --> <!--All Commands--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>New-ServiceDeskPlusRequestNote</command:name> <maml:description> <maml:para>Adds a note to a ServiceDesk Plus request.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>ServiceDeskPlusRequestNote</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-ServiceDeskPlusRequestNote cmdlet adds a note to a ServiceDesk Plus request. You can specify the requests by their resource IDs, or you can use the InputObject parameter to pass an object that represents the request that the note is for.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="InputObject" default="true"> <!--NAME: InputObject--> <!--TAG: DEFAULT--> <maml:name>New-ServiceDeskPlusRequestNote</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="Request"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies objects that represent the ServiceDesk Plus requests that this cmdlet will add notes to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing field values for the request note.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="RequestId"> <!--NAME: RequestId--> <maml:name>New-ServiceDeskPlusRequestNote</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource IDs of the ServiceDesk Plus requests that this cmdlet will add notes to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing field values for the request note.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="Request"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies objects that represent the ServiceDesk Plus requests that this cmdlet will add notes to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing field values for the request note.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource IDs of the ServiceDesk Plus requests that this cmdlet will add notes to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject, System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe objects that represent ServiceDesk Plus requests or strings that contain the resource IDs of ServiceDesk Plus requests to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet generates a System.Management.Automation.PSObject object that represents the request note that was added.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Add a note to a request using an input object.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\>$connection = Get-AutomationConnection -Name SDPlus PS C:\>$requestFilter = [PSCustomObject]@{Name = 'DisplayId'; Operator = 'EqualTo'; Value = '1730'} PS C:\>$request = Get-ServiceDeskPlusRequest -Connection $connection -Filters $requestFilter PS C:\> $noteValues = @{Description = 'Need to order new hard drive.'; MarkFirstResponse = $true} PS C:\>$request | New-ServiceDeskPlusRequestNote -Connection $connection -Values $noteValues</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>New-ServiceDeskPlusRequestTask</command:name> <maml:description> <maml:para>Adds a task to a ServiceDesk Plus request.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>ServiceDeskPlusRequestTask</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-ServiceDeskPlusRequestTask cmdlet adds a task to a ServiceDesk Plus request. You can specify the requests by their resource IDs, or you can use the InputObject parameter to pass an object that represents the request that the task is for.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="InputObject" default="true"> <!--NAME: InputObject--> <!--TAG: DEFAULT--> <maml:name>New-ServiceDeskPlusRequestTask</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="Request"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies objects that represent the ServiceDesk Plus requests that this cmdlet will add tasks to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing field values for the task.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="RequestId"> <!--NAME: RequestId--> <maml:name>New-ServiceDeskPlusRequestTask</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource IDs of the ServiceDesk Plus requests that this cmdlet will add tasks to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing field values for the task.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="Request"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies objects that represent the ServiceDesk Plus requests that this cmdlet will add tasks to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing field values for the task.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource IDs of the ServiceDesk Plus requests that this cmdlet will add tasks to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject, System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe objects that represent ServiceDesk Plus requests or strings that contain the resource IDs of ServiceDesk Plus requests to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet generates a System.Management.Automation.PSObject object that represents the request task that was added.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Add a task to a request.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\>$connection = Get-AutomationConnection -Name 'SDPlus' PS C:\>$requestFilter = [PSCustomObject]@{Name = 'DisplayId'; Operator = 'EqualTo'; Value = '1730'} PS C:\>$request = Get-ServiceDeskPlusRequest -Connection $connection -Filters $requestFilter PS C:\> $taskValues = @{Title = 'Install new hard drive.'; Priority = 'High'} PS C:\>New-ServiceDeskPlusRequestTask -Connection $connection -InputObject $request -Values $taskValues</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>New-ServiceDeskPlusRequestWorklog</command:name> <maml:description> <maml:para>Adds a worklog to a ServiceDesk Plus request.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>ServiceDeskPlusRequestWorklog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-ServiceDeskPlusRequestWorklog cmdlet adds a worklog to a ServiceDesk Plus request. You can specify the requests by their resource IDs, or you can use the InputObject parameter to pass an object that represents the request that the worklog is for.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="InputObject" default="true"> <!--NAME: InputObject--> <!--TAG: DEFAULT--> <maml:name>New-ServiceDeskPlusRequestWorklog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="Request"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the objects that represent the ServiceDesk Plus request that this cmdlet will add worklogs to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing field values for the request worklog.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="RequestId"> <!--NAME: RequestId--> <maml:name>New-ServiceDeskPlusRequestWorklog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus request that this cmdlet will add worklogs to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing field values for the request worklog.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="Request"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the objects that represent the ServiceDesk Plus request that this cmdlet will add worklogs to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing field values for the request worklog.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus request that this cmdlet will add worklogs to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject, System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe objects that represent ServiceDesk Plus requests or strings that contain the resource IDs of ServiceDesk Plus requests to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet generates a System.Management.Automation.PSObject object that represents the request worklog that was added.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Add a worklog to a request.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\>$connection = Get-AutomationConnection -Name 'SDPlus' PS C:\>$requestFilter = [PSCustomObject]@{Name = 'DisplayId'; Operator = 'EqualTo'; Value = '1730'} PS C:\>$request = Get-ServiceDeskPlusRequest -Connection $connection -Filters $requestFilter PS C:\>$owner = Get-ServiceDeskPlusUser -Connection $connection -Name 'John Smith' PS C:\> $worklogValues = @{Owner = $owner; StartTime = [DateTime]::UtcNow} PS C:\>New-ServiceDeskPlusRequestWorklog -Connection $connection -InputObject $request -Values $worklogValues</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Close-ServiceDeskPlusRequest</command:name> <maml:description> <maml:para>Closes a ServiceDesk Plus request.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Close</command:verb> <command:noun>ServiceDeskPlusRequest</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Close-ServiceDeskPlusRequest cmdlet closes each of the specified requests. You can specify the requests by their resource IDs, or you can use the InputObject parameter to pass an object that represents the requests that you want to close.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="InputObject" default="true"> <!--NAME: InputObject--> <!--TAG: DEFAULT--> <maml:name>Close-ServiceDeskPlusRequest</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Acknowledged</maml:name> <maml:description> <maml:para>Indicates whether the requester has acknowledged the resolution they have been given.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ClosureCode</maml:name> <maml:description> <maml:para>Specifies the closure code that identifies the reason for closing the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ClosureComments</maml:name> <maml:description> <maml:para>Specifies the reason for closing the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FirstCallResolution</maml:name> <maml:description> <maml:para>Indicates whether the request has been marked as First Call Resolution.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequesterComments</maml:name> <maml:description> <maml:para>Specifies the comments from the requester in regards to the resolution they were given.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="Request"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies objects that represent the ServiceDesk Plus requests that this cmdlet will close.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="RequestId"> <!--NAME: RequestId--> <maml:name>Close-ServiceDeskPlusRequest</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Acknowledged</maml:name> <maml:description> <maml:para>Indicates whether the requester has acknowledged the resolution they have been given.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ClosureCode</maml:name> <maml:description> <maml:para>Specifies the closure code that identifies the reason for closing the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>ClosureComments</maml:name> <maml:description> <maml:para>Specifies the reason for closing the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>FirstCallResolution</maml:name> <maml:description> <maml:para>Indicates whether the request has been marked as First Call Resolution.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequesterComments</maml:name> <maml:description> <maml:para>Specifies the comments from the requester in regards to the resolution they were given.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource IDs of the ServiceDesk Plus requests that this cmdlet will close.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Acknowledged</maml:name> <maml:description> <maml:para>Indicates whether the requester has acknowledged the resolution they have been given.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ClosureCode</maml:name> <maml:description> <maml:para>Specifies the closure code that identifies the reason for closing the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>ClosureComments</maml:name> <maml:description> <maml:para>Specifies the reason for closing the request.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>FirstCallResolution</maml:name> <maml:description> <maml:para>Indicates whether the request has been marked as First Call Resolution.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>RequesterComments</maml:name> <maml:description> <maml:para>Specifies the comments from the requester in regards to the resolution they were given.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="Request"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies objects that represent the ServiceDesk Plus requests that this cmdlet will close.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource IDs of the ServiceDesk Plus requests that this cmdlet will close.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.String, System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe objects that represent ServiceDesk Plus requests or strings that contain the resource IDs of ServiceDesk Plus requests to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet generates a System.Management.Automation.PSObject object that represents the ServiceDesk Plus request that was closed.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>Example: Cancel a ServiceDesk Plus request.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\>$connection = Get-AutomationConnection -Name 'SDPlus' PS C:\>$request = Get-ServiceDeskPlusRequest -Connection $connection -RequestId '130929000000154248' PS C:\>$request | Close-ServiceDeskPlusRequest -Connection $connection -ClosureCode 'Cancelled'</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Close a successful ServiceDesk Plus request</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\>$connection = Get-AutomationConnection -Name 'SDPlus' PS C:\>$request = Get-ServiceDeskPlusRequest -Connection $connection -RequestId '130929000000154248' PS C:\>$request | Close-ServiceDeskPlusRequest -Connection $connection -ClosureCode 'Success' -ClosingComments 'Replaced old keyboard' -Acknowledged </dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-ServiceDeskPlusRequest</command:name> <maml:description> <maml:para>Gets ServiceDesk Plus requests.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>ServiceDeskPlusRequest</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-ServiceDeskPlusRequest cmdlet gets objects that represent ServiceDesk Plus requests. By default, the Get-ServiceDeskPlusRequest cmdlet will retrieve up to 100 requests. You can direct this cmdlet to retrieve specific requests by resource ID or by specifying one or more custom filter objects.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--NAME: Default--> <!--TAG: DEFAULT--> <maml:name>Get-ServiceDeskPlusRequest</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Ascending</maml:name> <maml:description> <maml:para>Indicates whether to return the results in ascending order. By default, requests are returned in descending order by their resource ID or by the field specified using the OrderBy parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Filter"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies one or more objects representing Runbook Studio filters that will be used to determine which requests to return. Filter objects must have a Name property that specifies a request field name, an Operator property that specifies the filter operator and a Value property that specifies the value to filter on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of request objects to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offset</maml:name> <maml:description> <maml:para>Specifies the zero based offset of the first request object to return. The Offset parameter is typically used in conjunction with the Limit and OrderBy parameters to implement pagination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the name of the field used to order the request objects being retrieved. By default, request objects are retrieved in order of their resource ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="RequestId"> <!--NAME: RequestId--> <maml:name>Get-ServiceDeskPlusRequest</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource IDs of the ServiceDesk Plus requests to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Ascending</maml:name> <maml:description> <maml:para>Indicates whether to return the results in ascending order. By default, requests are returned in descending order by their resource ID or by the field specified using the OrderBy parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases="Filter"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies one or more objects representing Runbook Studio filters that will be used to determine which requests to return. Filter objects must have a Name property that specifies a request field name, an Operator property that specifies the filter operator and a Value property that specifies the value to filter on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of request objects to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Offset</maml:name> <maml:description> <maml:para>Specifies the zero based offset of the first request object to return. The Offset parameter is typically used in conjunction with the Limit and OrderBy parameters to implement pagination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the name of the field used to order the request objects being retrieved. By default, request objects are retrieved in order of their resource ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource IDs of the ServiceDesk Plus requests to return.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe strings that contain request resource IDs to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet generates System.Management.Automation.PSObject objects that represent the ServiceDesk Plus requests that were retrieved.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Get a ServiceDesk Plus request by its resource ID.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\>$connection = Get-AutomationConnection -Name 'SDPlus' PS C:\> Get-ServiceDeskPlusRequest -Connection $connection -RequestId '130929000000154248'</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:title xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Example 2: Get the 10 most recently created ServiceDesk Plus requests.</maml:title> <maml:introduction xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para /> </maml:introduction> <dev:code xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">PS C:\>$connection = Get-AutomationConnection -Name 'SDPlus' PS C:\> Get-ServiceDeskPlusRequest -Connection $connection -Limit 10 -OrderBy 'CreatedTime'</dev:code> <dev:remarks xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:para /> </dev:remarks> </command:example> <command:example xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:title xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Example 3: Get all high priority ServiceDesk Plus requests that are currently open.</maml:title> <maml:introduction xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para /> </maml:introduction> <dev:code xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">PS C:\>$connection = Get-AutomationConnection -Name 'SDPlus' PS C:\>$filters = @([PSCustomObject]@{Name = 'Status'; Operator = 'EqualTo'; Value = Open'}, [PSCustomObject]@{Name = 'Priority'; Operator = 'EqualTo'; Value = 'High'}) PS C:\> Get-ServiceDeskPlusRequest -Connection $connection -Filters $filters</dev:code> <dev:remarks xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-ServiceDeskPlusRequestNote</command:name> <maml:description> <maml:para>Gets notes for a ServiceDesk Plus request.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>ServiceDeskPlusRequestNote</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-ServiceDeskPlusRequestNote cmdlet gets objects that represent ServiceDesk Plus request notes. By default, the Get-ServiceDeskPlusRequestNote cmdlet will retrieve up to 100 notes in descending order by resource ID. You can direct this cmdlet to retrieve specific notes by specifying one or more custom filter objects.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="InputObject" default="true"> <!--NAME: InputObject--> <!--TAG: DEFAULT--> <maml:name>Get-ServiceDeskPlusRequestNote</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Ascending</maml:name> <maml:description> <maml:para>Indicates whether to return the results in ascending order. By default, notes returned in descending order by their resource ID or by the field specified using the OrderBy parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Filter"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies a collection objects representing Runbook Studio filters that will be used to determine which request notes to return. Filter objects must have a Name property that specifies a field name, an Operator property that specifies the filter operator and a Value property that specifies the value to filter on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="Request"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies an object representing the ServiceDesk Plus request that the notes are for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of request note objects to return.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offset</maml:name> <maml:description> <maml:para>Specifies the zero based offset of the first request note object to return. The Offset parameter is typically used in conjunction with the Limit and OrderBy parameters to implement pagination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the name of the field used to order the request note objects. By default, request note objects are ordered by resource ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="RequestId"> <!--NAME: RequestId--> <maml:name>Get-ServiceDeskPlusRequestNote</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Ascending</maml:name> <maml:description> <maml:para>Indicates whether to return the results in ascending order. By default, notes returned in descending order by their resource ID or by the field specified using the OrderBy parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Filter"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies a collection objects representing Runbook Studio filters that will be used to determine which request notes to return. Filter objects must have a Name property that specifies a field name, an Operator property that specifies the filter operator and a Value property that specifies the value to filter on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of request note objects to return.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offset</maml:name> <maml:description> <maml:para>Specifies the zero based offset of the first request note object to return. The Offset parameter is typically used in conjunction with the Limit and OrderBy parameters to implement pagination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the name of the field used to order the request note objects being retrieved. By default, request note objects are ordered by resource ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus request that the notes are for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="NoteId"> <!--NAME: NoteId--> <maml:name>Get-ServiceDeskPlusRequestNote</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus request that the notes are for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>NoteId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the request note to retrieve.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Ascending</maml:name> <maml:description> <maml:para>Indicates whether to return the results in ascending order. By default, notes returned in descending order by their resource ID or by the field specified using the OrderBy parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases="Filter"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies a collection objects representing Runbook Studio filters that will be used to determine which request notes to return. Filter objects must have a Name property that specifies a field name, an Operator property that specifies the filter operator and a Value property that specifies the value to filter on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="Request"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies an object representing the ServiceDesk Plus request that the notes are for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of request note objects to return.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Offset</maml:name> <maml:description> <maml:para>Specifies the zero based offset of the first request note object to return. The Offset parameter is typically used in conjunction with the Limit and OrderBy parameters to implement pagination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the name of the field used to order the request note objects being retrieved. By default, request note objects are ordered by resource ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus request that the notes are for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>NoteId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the request note to retrieve.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject, System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe objects that represent ServiceDesk Plus requests or strings that contain the resource IDs of ServiceDesk Plus requests to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet generates System.Management.Automation.PSObject objects that represent the ServiceDesk Plus request notes that were retrieved.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:title xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Example 1: Get all notes for a ServiceDesk Plus request.</maml:title> <maml:introduction xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para /> </maml:introduction> <dev:code xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">PS C:\>$connection = Get-AutomationConnection -Name 'SDPlus' PS C:\>Get-ServiceDeskPlusRequestNote -Connection $connection -RequestId '130929000000154248'</dev:code> <dev:remarks xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:para /> </dev:remarks> </command:example> <command:example xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:title xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Example 2: Get all notes that have the keyword 'test' in the description.</maml:title> <maml:introduction xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para /> </maml:introduction> <dev:code xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">PS C:\>$connection = Get-AutomationConnection -Name SDPlus PS C:\>$filter = [PSCustomObject]@{Name = 'Description'; Operator = 'Contains'; Value = 'test'} PS C:\>Get-ServiceDeskPlusRequestNote -Connection $connection -RequestId '130929000000154248' -Filter $filter</dev:code> <dev:remarks xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-ServiceDeskPlusRequestTask</command:name> <maml:description> <maml:para>Gets tasks for a ServiceDesk Plus request.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>ServiceDeskPlusRequestTask</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-ServiceDeskPlusRequestTask cmdlet gets objects that represent ServiceDesk Plus request tasks. By default, the Get-ServiceDeskPlusRequestTask cmdlet will retrieve up to 100 tasks in descending order by their resource ID. You can direct this cmdlet to retrieve specific tasks by specifying one or more custom filter objects.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="InputObject" default="true"> <!--NAME: InputObject--> <!--TAG: DEFAULT--> <maml:name>Get-ServiceDeskPlusRequestTask</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Ascending</maml:name> <maml:description> <maml:para>Indicates whether to return the results in ascending order. By default, tasks are returned in descending order by their resource ID or by the field specified by the OrderBy parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Filter"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies one or more objects representing Runbook Studio filters that will be used to determine which request tasks to return. Filter objects must have a Name property that specifies a field name, an Operator property that specifies the filter operator and a Value property that specifies the value to filter on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies an object representing the ServiceDesk Plus request that the tasks are for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Request</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of request task objects to return.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offset</maml:name> <maml:description> <maml:para>Specifies the zero based offset of the first request task object to return. The Offset parameter is typically used in conjunction with the Limit and OrderBy parameters to implement pagination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the name of the field used to order the request task objects. By default, request task objects are ordered by resource ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="RequestId"> <!--NAME: RequestId--> <maml:name>Get-ServiceDeskPlusRequestTask</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Ascending</maml:name> <maml:description> <maml:para>Indicates whether to return the results in ascending order. By default, tasks are returned in descending order by their resource ID or by the field specified by the OrderBy parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Filter"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies one or more objects representing Runbook Studio filters that will be used to determine which request tasks to return. Filter objects must have a Name property that specifies a field name, an Operator property that specifies the filter operator and a Value property that specifies the value to filter on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of request task objects to return.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offset</maml:name> <maml:description> <maml:para>Specifies the zero based offset of the first request task object to return. The Offset parameter is typically used in conjunction with the Limit and OrderBy parameters to implement pagination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the name of the field used to order the request task objects. By default, request task objects are ordered by resource ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus request to retrieve tasks for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="TaskId"> <!--NAME: TaskId--> <maml:name>Get-ServiceDeskPlusRequestTask</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus request to retrieve tasks for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the request task to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Ascending</maml:name> <maml:description> <maml:para>Indicates whether to return the results in ascending order. By default, tasks are returned in descending order by their resource ID or by the field specified by the OrderBy parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases="Filter"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies one or more objects representing Runbook Studio filters that will be used to determine which request tasks to return. Filter objects must have a Name property that specifies a field name, an Operator property that specifies the filter operator and a Value property that specifies the value to filter on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies an object representing the ServiceDesk Plus request that the tasks are for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Request</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of request task objects to return.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Offset</maml:name> <maml:description> <maml:para>Specifies the zero based offset of the first request task object to return. The Offset parameter is typically used in conjunction with the Limit and OrderBy parameters to implement pagination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the name of the field used to order the request task objects. By default, request task objects are ordered by resource ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus request to retrieve tasks for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the request task to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject, System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe objects that represent ServiceDesk Plus requests or strings that contain the resource IDs of ServiceDesk Plus requests to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet generates System.Management.Automation.PSObject objects that represent the ServiceDesk Plus request tasks that were retrieved.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:title xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Example 1: Get all of the tasks for a ServiceDesk Plus request.</maml:title> <maml:introduction xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para /> </maml:introduction> <dev:code xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">PS C:\>$connection = Get-AutomationConnection -Name 'SDPlus' PS C:\> Get-ServiceDeskPlusRequestTask -Connection $connection -RequestId '130929000000154248'</dev:code> <dev:remarks xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:para /> </dev:remarks> </command:example> <command:example xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:title xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Example 2: Get all tasks that where the title starts with the keyword 'Test'..</maml:title> <maml:introduction xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para /> </maml:introduction> <dev:code xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">PS C:\>$connection = Get-AutomationConnection -Name 'SDPlus' PS C:\>$filter = [PSCustomObject]@{Name = 'Title'; Operator = 'StartsWith'; Value = 'Test'} PS C:\>Get-ServiceDeskPlusRequestTask -Connection $connection -RequestId '130929000000154248' -Filter $filter</dev:code> <dev:remarks xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-ServiceDeskPlusRequestWorklog</command:name> <maml:description> <maml:para>Gets worklogs for a specific ServiceDesk Plus request.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>ServiceDeskPlusRequestWorklog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-ServiceDeskPlusRequestWorklog cmdlet gets objects that represent ServiceDesk Plus request worklogs. By default the Get-ServiceDeskPlusRequestWorklog will retrieve up to 100 worklogs in descending order by resource ID. You can direct this cmdlet to retrieve specific worklogs by specifying one or more custom filter objects.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--NAME: Default--> <!--TAG: DEFAULT--> <maml:name>Get-ServiceDeskPlusRequestWorklog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="InputObject"> <!--NAME: InputObject--> <maml:name>Get-ServiceDeskPlusRequestWorklog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Ascending</maml:name> <maml:description> <maml:para>Indicates whether to return the results in ascending order. By default, worklogs are returned in descending order by their resource ID or by the field specified by the OrderBy parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Filter"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies one or more objects representing Runbook Studio filters that will be used to determine which request worklogs to return. Filter objects must have a Name property that specifies a field name, an Operator property that specifies the filter operator and a Value property that specifies the value to filter on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="Request"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies an object representing the ServiceDesk Plus request that the worklogs are for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of request worklog objects to return.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offset</maml:name> <maml:description> <maml:para>Specifies the zero based offset of the first request worklog object to return. The Offset parameter is typically used in conjunction with the Limit and OrderBy parameters to implement pagination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the name of the field used to order the request worklog objects to be retrieved. By default, request worklog objects are ordered by resource ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="RequestId"> <!--NAME: RequestId--> <maml:name>Get-ServiceDeskPlusRequestWorklog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Ascending</maml:name> <maml:description> <maml:para>Indicates whether to return the results in ascending order. By default, worklogs are returned in descending order by their resource ID or by the field specified by the OrderBy parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Filter"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies one or more objects representing Runbook Studio filters that will be used to determine which request worklogs to return. Filter objects must have a Name property that specifies a field name, an Operator property that specifies the filter operator and a Value property that specifies the value to filter on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of request worklog objects to return.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offset</maml:name> <maml:description> <maml:para>Specifies the zero based offset of the first request worklog object to return. The Offset parameter is typically used in conjunction with the Limit and OrderBy parameters to implement pagination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the name of the field used to order the request worklog objects to be retrieved. By default, request worklog objects are ordered by resource ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus request to retrieve worklogs for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="WorklogId"> <!--NAME: WorklogId--> <maml:name>Get-ServiceDeskPlusRequestWorklog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus request to retrieve worklogs for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>WorklogId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the request worklog to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Ascending</maml:name> <maml:description> <maml:para>Indicates whether to return the results in ascending order. By default, worklogs are returned in descending order by their resource ID or by the field specified by the OrderBy parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases="Filter"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies one or more objects representing Runbook Studio filters that will be used to determine which request worklogs to return. Filter objects must have a Name property that specifies a field name, an Operator property that specifies the filter operator and a Value property that specifies the value to filter on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="Request"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies an object representing the ServiceDesk Plus request that the worklogs are for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of request worklog objects to return.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Offset</maml:name> <maml:description> <maml:para>Specifies the zero based offset of the first request worklog object to return. The Offset parameter is typically used in conjunction with the Limit and OrderBy parameters to implement pagination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the name of the field used to order the request worklog objects to be retrieved. By default, request worklog objects are ordered by resource ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus request to retrieve worklogs for.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>WorklogId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the request worklog to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject, System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe objects that represent ServiceDesk Plus requests or strings that contain the resource IDs of ServiceDesk Plus requests to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet generates System.Management.Automation.PSObject objects that represent the ServiceDesk Plus request worklogs that were retrieved.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:title xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Example 1: Get all of the worklogs for a ServiceDesk Plus request.</maml:title> <maml:introduction xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para /> </maml:introduction> <dev:code xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">PS C:\>$connection = Get-AutomationConnection -Name 'SDPlus' PS C:\> Get-ServiceDeskPlusRequestWorklog -Connection $connection -RequestId '130929000000154248'</dev:code> <dev:remarks xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:para /> </dev:remarks> </command:example> <command:example xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:title xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Example 2: Get all of the worklogs where the time spent is more than one hour.</maml:title> <maml:introduction xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para /> </maml:introduction> <dev:code xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">PS C:\>$connection = Get-AutomationConnection -Name SDPlus PS C:\>$filter = [PSCustomObject]@{Name = 'TimeSpent'; Operator = 'GreaterThan'; Value = [TimeSpan]::FromHours(1)} PS C:\>Get-ServiceDeskPlusRequestWorklog -Connection $connection -RequestId '130929000000154248' -Filter $filter</dev:code> <dev:remarks xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-ServiceDeskPlusUser</command:name> <maml:description> <maml:para>Gets information about ServiceDesk Plus users.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>ServiceDeskPlusUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-ServiceDeskUser cmdlet retrieves information about ServiceDesk Plus users. By default, the Get-ServiceDeskPlusUser cmdlet will retrieve up to 100 users objects in descending order by resource ID. You can direct this cmdlet to retrieve specific users by specifying one or more custom filter objects, or by a specific user name or resource ID.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--NAME: Default--> <!--TAG: DEFAULT--> <maml:name>Get-ServiceDeskPlusUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Ascending</maml:name> <maml:description> <maml:para>Indicates whether to return the results in ascending order. By default, users are returned in descending order by their resource ID or by the field specified by the OrderBy parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of user objects to return.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offset</maml:name> <maml:description> <maml:para>Specifies the zero based offset of the first user object to return. The Offset parameter is typically used in conjunction with the Limit and OrderBy parameters to implement pagination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the name of the field used to order the user objects. By default, user objects are ordered by resource ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases="Filter"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies an array of objects representing Runbook Studio filters that will be used to determine which users to return. Filter objects must have a Name property that specifies a field name, an Operator property that specifies the filter operator and a Value property that specifies the value to filter on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="UserId"> <!--NAME: UserId--> <maml:name>Get-ServiceDeskPlusUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus user to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Ascending</maml:name> <maml:description> <maml:para>Indicates whether to return the results in ascending order. By default, users are returned in descending order by their resource ID or by the field specified by the OrderBy parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of user objects to return.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Offset</maml:name> <maml:description> <maml:para>Specifies the zero based offset of the first user object to return. The Offset parameter is typically used in conjunction with the Limit and OrderBy parameters to implement pagination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the name of the field used to order the user objects. By default, user objects are ordered by resource ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases="Filter"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies an array of objects representing Runbook Studio filters that will be used to determine which users to return. Filter objects must have a Name property that specifies a field name, an Operator property that specifies the filter operator and a Value property that specifies the value to filter on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus user to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe strings containing resource IDs of the users that you want to retrieve.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet generates objects that represent the ServiceDesk Plus users that were retrieved.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1: Get a user by their Name</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\>$connection = Get-AutomationConnection -Name 'SDPlus' PS C:\>$filter = [PSCustomObject]@{Name = 'Name'; Operator = 'EqualTo'; Value = 'John Smith'} PS C:\>$user = Get-ServiceDeskPlusUser -Connection $connection -Filter $filter </dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>New-ServiceDeskPlusRequest</command:name> <maml:description> <maml:para>Create a new ServiceDesk Plus request.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>ServiceDeskPlusRequest</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-ServiceDeskPlusRequest cmdlet creates a new ServiceDesk Plus request using a hashtable to provide fields values. The hashtable must include values for all mandatory request fields.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>New-ServiceDeskPlusRequest</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies the field values for the new ServiceDesk Plus request. The hashtable must include values for all mandatory fields.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>Specifies the name of the template used to create the request.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies the field values for the new ServiceDesk Plus request. The hashtable must include values for all mandatory fields.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Template</maml:name> <maml:description> <maml:para>Specifies the name of the template used to create the request.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet generates an object that represents the ServiceDesk Plus request that was created.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>Example: Create a new ServiceDesk Plus request.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\>$connection = Get-AutomationConnection -Name 'SDPlus' PS C:\>$requester = Get-ServiceDeskPlusUser -Connection $connection -Name 'John Smith' PS C:\>$values = @{Requester = $requester; Subject = 'WiFi in board room is not working.'} PS C:\> New-ServiceDeskPlusRequest -Connection $connection -Values $values</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Remove-ServiceDeskPlusRequest</command:name> <maml:description> <maml:para>Removes one or more ServiceDesk Plus requests.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>ServiceDeskPlusRequest</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-ServiceDeskPlusRequest cmdlet removes one or more ServiceDeskPlus requests. You can specify the requests by their resource ID, or you can use the InputObject parameter to pass an object that represents the request that you want to remove.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="InputObject" default="true"> <!--NAME: InputObject--> <!--TAG: DEFAULT--> <maml:name>Remove-ServiceDeskPlusRequest</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="Request"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies objects that represent the requests to remove. Enter a variable that contains the objects, or type a command or expression that gets the request objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="RequestId"> <!--NAME: RequestId--> <maml:name>Remove-ServiceDeskPlusRequest</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource IDs of the requests to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="Request"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies objects that represent the requests to remove. Enter a variable that contains the objects, or type a command or expression that gets the request objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource IDs of the requests to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject, System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe objects that represent ServiceDesk Plus requests or strings that contain the resource IDs of ServiceDesk Plus requests to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject, System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet passes through the value of the InputObject parameter or the RequestId parameter, depending on which parameter set was used.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Remove-ServiceDeskPlusRequestNote</command:name> <maml:description> <maml:para>Removes one or more ServiceDesk Plus request notes.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>ServiceDeskPlusRequestNote</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-ServiceDeskPlusRequestNote cmdlet removes one or more ServiceDeskPlus request notes. You can specify the request notes by their resource ID, or you can use the InputObject parameter to pass an object that represents the request notes that you want to remove.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="InputObject" default="true"> <!--NAME: InputObject--> <!--TAG: DEFAULT--> <maml:name>Remove-ServiceDeskPlusRequestNote</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="Note"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies objects that represent the request notes to remove. Enter a variable that contains the objects, or type a command or expression that gets the request note objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="NoteId"> <!--NAME: NoteId--> <maml:name>Remove-ServiceDeskPlusRequestNote</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>NoteId</maml:name> <maml:description> <maml:para>Specifies the resource IDs of the request notes to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the request that the notes are associated with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="Note"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies objects that represent the request notes to remove. Enter a variable that contains the objects, or type a command or expression that gets the request note objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>NoteId</maml:name> <maml:description> <maml:para>Specifies the resource IDs of the request notes to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the request that the notes are associated with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject, System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe objects that represent ServiceDesk Plus request notes or strings that contain the resource IDs of ServiceDesk Plus request notes to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject, System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet passes through the value of the InputObject parameter or the NoteId parameter, depending on which parameter set was used.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Remove-ServiceDeskPlusRequestTask</command:name> <maml:description> <maml:para>Removes one or more ServiceDesk Plus request tasks.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>ServiceDeskPlusRequestTask</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-ServiceDeskPlusRequestTask cmdlet removes one or more ServiceDeskPlus request tasks. You can specify the request tasks by their resource ID, or you can use the InputObject parameter to pass an object that represents the request tasks that you want to remove.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="InputObject" default="true"> <!--NAME: InputObject--> <!--TAG: DEFAULT--> <maml:name>Remove-ServiceDeskPlusRequestTask</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="Task"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies objects that represent the request tasks to remove. Enter a variable that contains the objects, or type a command or expression that gets the request task objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="TaskId"> <!--NAME: TaskId--> <maml:name>Remove-ServiceDeskPlusRequestTask</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>Specifies the resource IDs of the request tasks to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the request that the tasks are associated with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="Task"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies objects that represent the request tasks to remove. Enter a variable that contains the objects, or type a command or expression that gets the request task objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>Specifies the resource IDs of the request tasks to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the request that the tasks are associated with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject, System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe objects that represent ServiceDesk Plus requests tasks or strings that contain the resource IDs of ServiceDesk Plus request tasks to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject, System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet passes through the value of the InputObject parameter or the TaskId parameter, depending on which parameter set was used.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Remove-ServiceDeskPlusRequestWorklog</command:name> <maml:description> <maml:para>Removes one or more ServiceDesk Plus request worklogs.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>ServiceDeskPlusRequestWorklog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-ServiceDeskPlusRequestWorklog cmdlet removes one or more ServiceDeskPlus request worklogs. You can specify the request worklogs by their resource ID.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Remove-ServiceDeskPlusRequestWorklog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the request that the worklogs are associated with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>WorklogId</maml:name> <maml:description> <maml:para>Specifies the resource IDs of the request worklogs to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the request that the worklogs are associated with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>WorklogId</maml:name> <maml:description> <maml:para>Specifies the resource IDs of the request worklogs to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject, System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe strings that contain the resource IDs of ServiceDesk Plus request worklogs to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet passes through the value of the WorklogId parameter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Set-ServiceDeskPlusRequest</command:name> <maml:description> <maml:para>Updates one or more ServiceDesk Plus requests.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>ServiceDeskPlusRequest</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-ServiceDeskPlusRequest cmdlet updates one or more ServiceDeskPlus requests. You can specify the requests by their resource IDs, or you can use the InputObject parameter to pass an object that represents the request that you want to update.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="InputObject" default="true"> <!--NAME: InputObject--> <!--TAG: DEFAULT--> <maml:name>Set-ServiceDeskPlusRequest</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="Request"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies objects that represent the requests to update. Enter a variable that contains the objects, or type a command or expression that gets the request objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing new field values for the requests.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="RequestId"> <!--NAME: RequestId--> <maml:name>Set-ServiceDeskPlusRequest</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource IDs of the requests to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing new field values for the requests.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="Request"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies objects that represent the requests to update. Enter a variable that contains the objects, or type a command or expression that gets the request objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing new field values for the requests.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource IDs of the requests to update.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject, System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe objects that represent ServiceDesk Plus requests or strings that contain the resource IDs of ServiceDesk Plus requests to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet passes through the value of the InputObject parameter or the RequestId parameter, depending on which parameter set was used.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Set-ServiceDeskPlusRequestNote</command:name> <maml:description> <maml:para>Updates one or more ServiceDesk Plus request notes.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>ServiceDeskPlusRequestNote</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-ServiceDeskPlusRequestNote cmdlet updates one or more ServiceDeskPlus request notes. You can specify the notes by their resource IDs, or you can use the InputObject parameter to pass an object that represents the request note that you want to update.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="InputObject" default="true"> <!--NAME: InputObject--> <!--TAG: DEFAULT--> <maml:name>Set-ServiceDeskPlusRequestNote</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="Note"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies objects that represent the request notes to update. Enter a variable that contains the objects, or type a command or expression that gets the request note objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing new field values for the request notes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="NoteId"> <!--NAME: NoteId--> <maml:name>Set-ServiceDeskPlusRequestNote</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus request that contains the notes to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>NoteId</maml:name> <maml:description> <maml:para>Specifies the resource IDs of the ServiceDesk Plus request notes to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing new field values for the request notes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="Note"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies objects that represent the request notes to update. Enter a variable that contains the objects, or type a command or expression that gets the request note objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing new field values for the request notes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus request that contains the notes to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>NoteId</maml:name> <maml:description> <maml:para>Specifies the resource IDs of the ServiceDesk Plus request notes to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject[] System.String[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe objects that represent ServiceDesk Plus request notes or strings that contain the resource IDs of ServiceDesk Plus request notes to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet passes through the value of the InputObject parameter or the NoteId parameter, depending on which parameter set was used.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Set-ServiceDeskPlusRequestTask</command:name> <maml:description> <maml:para>Updates one or more ServiceDesk Plus request tasks.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>ServiceDeskPlusRequestTask</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-ServiceDeskPlusRequestTask cmdlet updates one or more ServiceDeskPlus request tasks. You can specify the tasks by their resource IDs, or you can use the InputObject parameter to pass an object that represents the task that you want to update.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="InputObject" default="true"> <!--NAME: InputObject--> <!--TAG: DEFAULT--> <maml:name>Set-ServiceDeskPlusRequestTask</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="Task"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies objects that represent the request tasks to update. Enter a variable that contains the objects, or type a command or expression that gets the request task objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing new field values for the request tasks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="TaskId"> <!--NAME: TaskId--> <maml:name>Set-ServiceDeskPlusRequestTask</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus request that contains the tasks to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>Specifies the resource IDs of the ServiceDesk Plus request tasks to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing new field values for the request tasks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="Task"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies objects that represent the request tasks to update. Enter a variable that contains the objects, or type a command or expression that gets the request task objects.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing new field values for the request tasks.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus request that contains the tasks to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>Specifies the resource IDs of the ServiceDesk Plus request tasks to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject, System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe objects that represent ServiceDesk Plus request tasks or strings that contain the resource IDs of ServiceDesk Plus request tasks to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet passes through the value of the InputObject parameter or the TaskId parameter, depending on which parameter set was used.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Set-ServiceDeskPlusRequestWorklog</command:name> <maml:description> <maml:para>Updates one or more ServiceDesk Plus request worklogs.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>ServiceDeskPlusRequestWorklog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-ServiceDeskPlusRequestWorklog cmdlet updates one or more ServiceDeskPlus request worklogs. You can specify the worklogs by their resource IDs.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-ServiceDeskPlusRequestWorklog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus request that contains the worklogs to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>WorklogId</maml:name> <maml:description> <maml:para>Specifies the resource IDs of the ServiceDesk Plus request worklogs to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing new field values for the request worklogs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus request that contains the worklogs to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>WorklogId</maml:name> <maml:description> <maml:para>Specifies the resource IDs of the ServiceDesk Plus request worklogs to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing new field values for the request worklogs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe strings that that contain the resource IDs of ServiceDesk Plus request worklogs to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet passes through the value of the WorklogId parameter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!--Generated by: SAPIEN PowerShell HelpWriter 2018 v2.2.38--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>New-ServiceDeskPlusRequestTaskWorklog</command:name> <maml:description> <maml:para>Adds a new worklog to a ServiceDesk Plus request task.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>ServiceDeskPlusRequestTaskWorklog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-ServiceDeskPlusRequestTaskWorklog cmdlet adds a worklog to a ServiceDesk Plus request task. You can specify the request tasks by their resource IDs, or you can use the InputObject parameter to pass an object that represents the request task that the worklog is for.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="InputObject" default="true"> <!--NAME: InputObject--> <!--TAG: DEFAULT--> <maml:name>New-ServiceDeskPlusRequestTaskWorklog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="Task"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the objects that represent the ServiceDesk Plus request task that this cmdlet will add worklogs to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing field values for the request task worklog.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="TaskId"> <!--NAME: TaskId--> <maml:name>New-ServiceDeskPlusRequestTaskWorklog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus request that the task is associated with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing field values for the request task worklog.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" variableLength="false" position="named"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus request task that this cmdlet will add worklogs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="Task"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies the objects that represent the ServiceDesk Plus request task that this cmdlet will add worklogs to.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing field values for the request task worklog.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus request that the task is associated with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus request task that this cmdlet will add worklogs to.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject, System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe objects that represent ServiceDesk Plus request tasks or strings that contain the resource IDs of ServiceDesk Plus request tasks to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet passes through the value of the InputObject parameter or the TaskId parameter, depending on which parameter set was used.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Add a worklog to a request task.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\>$connection = Get-AutomationConnection -Name 'SDPlus' PS C:\>$filter = [PSCustomObject]@{Name = 'Request.Id'; Operator = 'EqualTo'; Value = '1730'} PS C:\>$request = Get-ServiceDeskPlusRequest -Connection $connection -Filters $requestFilter PS C:\>$task = Get-ServiceDeskPlusRequestTask -Connection $connection -InputObject $request PS C:\>$owner = Get-ServiceDeskPlusTechnician -Connection $connection -Name 'John Smith' PS C:\> $worklogValues = @{Owner = $owner; StartTime = [DateTime]::UtcNow} PS C:\> New-ServiceDeskPlusRequestTaskWorklog -Connection $connection -InputObject $task -Values $worklogValues</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <!--Edited with: SAPIEN PowerShell HelpWriter 2018 v2.2.38--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Set-ServiceDeskPlusRequestTaskWorklog</command:name> <maml:description> <maml:para>Updates one or more ServiceDesk Plus request task worklogs.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>ServiceDeskPlusRequestTaskWorklog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-ServiceDeskPlusRequestTaskWorklog cmdlet updates one or more ServiceDeskPlus request task worklogs. You can specify the worklogs by their resource IDs.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-ServiceDeskPlusRequestTaskWorklog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus request task that the task is associated with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>WorklogId</maml:name> <maml:description> <maml:para>Specifies the resource IDs of the ServiceDesk Plus request worklogs to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing new field values for the request task worklogs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" variableLength="false" position="named"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus request task that contains the worklogs to be updated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus request task that the task is associated with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>WorklogId</maml:name> <maml:description> <maml:para>Specifies the resource IDs of the ServiceDesk Plus request worklogs to be updated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies a hashtable containing new field values for the request task worklogs.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus request task that contains the worklogs to be updated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe strings that that contain the resource IDs of ServiceDesk Plus request task worklogs to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet passes through the value of the TaskId parameter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!--Edited with: SAPIEN PowerShell HelpWriter 2018 v2.2.38--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Remove-ServiceDeskPlusRequestTaskWorklog</command:name> <maml:description> <maml:para>Removes one or more ServiceDesk Plus request task worklogs.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>ServiceDeskPlusRequestTaskWorklog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Remove-ServiceDeskPlusRequestTaskWorklog cmdlet removes one or more ServiceDeskPlus requests. You can specify the request task worklogs by their resource ID.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Remove-ServiceDeskPlusRequestTaskWorklog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the request that the tasks are associated with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>WorklogId</maml:name> <maml:description> <maml:para>Specifies the resource IDs of the request task worklogs to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the request that the tasks are associated with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>WorklogId</maml:name> <maml:description> <maml:para>Specifies the resource IDs of the request task worklogs to remove.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject, System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe strings that contain the resource IDs of ServiceDesk Plus request task worklogs to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet passes through the value of the TaskId parameter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-ServiceDeskPlusRequestTaskWorklog</command:name> <maml:description> <maml:para>Gets worklogs for a specific ServiceDesk Plus request task.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>ServiceDeskPlusRequestTaskWorklog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-ServiceDeskPlusRequestTaskWorklog cmdlet gets objects that represent ServiceDesk Plus request task worklogs. By default, the Get-ServiceDeskPlusRequestTaskWorklog retrieves up to 100 worklogs in descending order by resource ID. You can direct this cmdlet to retrieve specific worklogs by specifying one or more custom filter objects.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--NAME: Default--> <!--TAG: DEFAULT--> <maml:name>Get-ServiceDeskPlusRequestTaskWorklog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="InputObject"> <!--NAME: InputObject--> <maml:name>Get-ServiceDeskPlusRequestTaskWorklog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Ascending</maml:name> <maml:description> <maml:para>Indicates whether to return the results in ascending order. By default, worklogs are returned in descending order by their resource ID or by the field specified using the OrderBy parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Filter"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies one or more objects representing Runbook Studio filters that will be used to determine which request worklogs to return. Filter objects must have a Name property that specifies a field name, an Operator property that specifies the filter operator and a Value property that specifies the value to filter on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies ab object that represents the request task that contains the worklog. Enter a variable that contains the object, or type a command or expression that gets the request task object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of request task worklog objects to return.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offset</maml:name> <maml:description> <maml:para>Specifies the zero based offset of the first request task worklog object to return. The Offset parameter is typically used in conjunction with the Limit and OrderBy parameters to implement pagination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the name of the field used to order the request task worklog objects to be retrieved. By default, request worklog objects are ordered by resource ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="TaskId"> <!--NAME: TaskId--> <maml:name>Get-ServiceDeskPlusRequestTaskWorklog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Ascending</maml:name> <maml:description> <maml:para>Indicates whether to return the results in ascending order. By default, worklogs are returned in descending order by their resource ID or by the field specified using the OrderBy parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of request task worklog objects to return.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offset</maml:name> <maml:description> <maml:para>Specifies the zero based offset of the first request task worklog object to return. The Offset parameter is typically used in conjunction with the Limit and OrderBy parameters to implement pagination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the name of the field used to order the request task worklog objects to be retrieved. By default, request worklog objects are ordered by resource ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus request that the task is associated with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByValue)" variableLength="false" position="named"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the request task that contains the worklogs to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false" /> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases="Filter"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies one or more objects representing Runbook Studio filters that will be used to determine which request worklogs to return. Filter objects must have a Name property that specifies a field name, an Operator property that specifies the filter operator and a Value property that specifies the value to filter on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="WorklogId"> <!--NAME: WorklogId--> <maml:name>Get-ServiceDeskPlusRequestTaskWorklog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the request task that contains the worklogs to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false" /> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus request that the task is associated with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>WorklogId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the request task worklog to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Ascending</maml:name> <maml:description> <maml:para>Indicates whether to return the results in ascending order. By default, worklogs are returned in descending order by their resource ID or by the field specified using the OrderBy parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases="Filter"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies one or more objects representing Runbook Studio filters that will be used to determine which request worklogs to return. Filter objects must have a Name property that specifies a field name, an Operator property that specifies the filter operator and a Value property that specifies the value to filter on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>Specifies ab object that represents the request task that contains the worklog. Enter a variable that contains the object, or type a command or expression that gets the request task object.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of request task worklog objects to return.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Offset</maml:name> <maml:description> <maml:para>Specifies the zero based offset of the first request task worklog object to return. The Offset parameter is typically used in conjunction with the Limit and OrderBy parameters to implement pagination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the name of the field used to order the request task worklog objects to be retrieved. By default, request worklog objects are ordered by resource ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>RequestId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus request that the task is associated with.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="True (ByValue)" variableLength="false" position="named"> <maml:name>TaskId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the request task that contains the worklogs to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false" /> <dev:type> <maml:name /> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>WorklogId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the request task worklog to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject, System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe objects that represent ServiceDesk Plus request tasks or strings that contain the resource IDs of ServiceDesk Plus request tasks to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet generates objects that represent the ServiceDesk Plus request task worklogs that were retrieved.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:title xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Example 1: Get all of the worklogs for a ServiceDesk Plus request task.</maml:title> <maml:introduction xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para /> </maml:introduction> <dev:code xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10">PS C:\>$connection = Get-AutomationConnection -Name SDPlus PS C:\>$task = Get-ServiceDeskPlusRequestTask -Connection $connection -RequestId '130929000000154248' PS C:\> $worklogs = Get-ServiceDeskPlusRequestTaskWorklog -Connection $connection -InputObject $task </dev:code> <dev:remarks xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <!--Edited with: SAPIEN PowerShell HelpWriter 2018 v2.2.38--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-ServiceDeskPlusTechnician</command:name> <maml:description> <maml:para>Gets information about ServiceDesk Plus technicians.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>ServiceDeskPlusTechnician</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-ServiceDeskTechnician cmdlet retrieves information about ServiceDesk Plus users. By default, the Get-ServiceDeskPlusTechnician cmdlet will retrieve up to 100 users objects in descending order by resource ID. You can direct this cmdlet to retrieve specific technicians by specifying one or more custom filter objects, or by a specific user name or resource ID.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default" default="true"> <!--NAME: Default--> <!--TAG: DEFAULT--> <maml:name>Get-ServiceDeskPlusTechnician</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Ascending</maml:name> <maml:description> <maml:para>Indicates whether to return the results in ascending order. By default, technicians are returned in descending order by their resource ID or by the field specified by the OrderBy parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of technician objects to return.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Offset</maml:name> <maml:description> <maml:para>Specifies the zero based offset of the first technician object to return. The Offset parameter is typically used in conjunction with the Limit and OrderBy parameters to implement pagination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the name of the field used to order the technician objects. By default, technician objects are ordered by resource ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases="Filter"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies an array of objects representing Runbook Studio filters that will be used to determine which technicians to retrieve. Filter objects must have a Name property that specifies a field name, an Operator property that specifies the filter operator and a Value property that specifies the value to filter on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="UserId"> <!--NAME: UserId--> <maml:name>Get-ServiceDeskPlusTechnician</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>TechnicianId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus technician to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Ascending</maml:name> <maml:description> <maml:para>Indicates whether to return the results in ascending order. By default, technicians are returned in descending order by their resource ID or by the field specified by the OrderBy parameter.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of technician objects to return.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Offset</maml:name> <maml:description> <maml:para>Specifies the zero based offset of the first technician object to return. The Offset parameter is typically used in conjunction with the Limit and OrderBy parameters to implement pagination.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>OrderBy</maml:name> <maml:description> <maml:para>Specifies the name of the field used to order the technician objects. By default, technician objects are ordered by resource ID.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies a hashtable that contains information used to license the module and to connect to a ServiceDesk Plus instance.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named" aliases="Filter"> <maml:name>Filters</maml:name> <maml:description> <maml:para>Specifies an array of objects representing Runbook Studio filters that will be used to determine which technicians to retrieve. Filter objects must have a Name property that specifies a field name, an Operator property that specifies the filter operator and a Value property that specifies the value to filter on.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">PSObject[]</command:parameterValue> <dev:type> <maml:name>PSObject[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="named"> <maml:name>TechnicianId</maml:name> <maml:description> <maml:para>Specifies the resource ID of the ServiceDesk Plus technician to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe strings containing resource IDs of the technicians that you want to retrieve.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>This cmdlet generates objects that represent the ServiceDesk Plus technicians that were retrieved.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>EXAMPLE 1: Get a technician by their Name using filters</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\>$connection = Get-AutomationConnection -Name 'SDPlus' PS C:\>$filter = [PSCustomObject]@{Name = 'Name'; Operator = 'EqualTo'; Value = 'John Smith'} PS C:\>$user = Get-ServiceDeskPlusTechnician -Connection $connection -Filter $filter </dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <!--Edited with: SAPIEN PowerShell HelpWriter 2018 v2.2.38--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>New-ServiceDeskPlusRefreshToken</command:name> <maml:description> <maml:para>Creates a new OAuth 2.0 refresh token.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>ServiceDeskPlusRefreshToken</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-ServiceDeskPlusRefreshToken activity generates a new OAuth 2.0 refresh token that can be used to authenticate the other activities in this module.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default"> <!--NAME: Default--> <maml:name>New-ServiceDeskPlusRefreshToken</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>Authority</maml:name> <maml:description> <maml:para>Specifies the URL of the OAuth 2.0 authority used to authorize the refresh token request.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>ClientId</maml:name> <maml:description> <maml:para>Specifies the consumer ID of the connected application.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>ClientSecret</maml:name> <maml:description> <maml:para>Specifies the consumer secret of the connected application.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>AuthorizationCode</maml:name> <maml:description> <maml:para>Specifies the temporary token created by the authorization server that can be used to obtain access and refresh tokens.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You cannot pipe objects to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The cmdlet outputs a System.String that contains the OAuth 2.0 refresh token that can be used by the activities in this module to connect to ServiceDesk Plus. Assign this value to the RefreshToken key of the hashtable used for the Connection parameter.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>Create a new refresh token.</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> New-ServiceDeskPlusRefreshToken -Authority 'https://accounts.zoho.com' -ClientId '1000.15S25B602CISR5WO9RUZ8UT39O3RIH' -ClientSecret '9ea302935eb150d9d6cbefd35b1eb8891332d815b8' -AuthorizationCode '1000.2afabf2f5a396325e88f715c6de34d12.edce6130ca3832a14e5f80d005a5324d'</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <!--Edited with: SAPIEN PowerShell HelpWriter 2018 v2.2.38--> </helpItems> |