Kelverion.EasyVista.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.EasyVista Version: 1.2 --> <!--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>Close-EasyVistaRequest</command:name> <maml:description> <maml:para>Close an incident or request ticket.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Close</command:verb> <command:noun>EasyVistaRequest</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Close-EasyVistaRequest cmdlet closes one or more incident and/or request tickets in EasyVista Service Manager.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Close-EasyVistaRequest</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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 (ByPropertyName, ByValue)" position="named" aliases="Request Number"> <maml:name>RequestNumber</maml:name> <maml:description> <maml:para>Specifies the identifiers of the incident or request tickets to 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:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies one or more parameters used to close the incident or request ticket.</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 (ByPropertyName, ByValue)" position="named" aliases="Request Number"> <maml:name>RequestNumber</maml:name> <maml:description> <maml:para>Specifies the identifiers of the incident or request tickets to 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:parameter required="false" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Specifies one or more parameters used to close the incident or request ticket.</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 information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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 ticket identifiers to the cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The identifier of the incident or request ticket that was closed.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Close an incident ticket and set the status to 'Solved'</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Test' PS C:\> Close-EasyVistaRequest -Connection $connection -RequestNumber 'I200320_000031' -Values @{STATUS_GUID = 'Solved'}</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>Complete-EasyVistaAction</command:name> <maml:description> <maml:para>End one or more onging actions of a specified incident or request ticket.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Complete</command:verb> <command:noun>EasyVistaAction</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Complete-EasyVistaAction cmdlet ends one or more ticket actions in EasyVista Service Manager. You can end all actions for a specified ticket or specify action IDs to end specific actions.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default"> <!--NAME: Default--> <maml:name>Complete-EasyVistaAction</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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 (ByPropertyName, ByValue)" position="named" aliases="Request Number"> <maml:name>RequestNumber</maml:name> <maml:description> <maml:para>Specifies the identifier of the incident or request ticket that owns the action to be ended.</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>Values</maml:name> <maml:description> <maml:para>Specifies one or more parameter values to assist in ending the action.</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="ByActionId"> <!--NAME: ByActionId--> <maml:name>Complete-EasyVistaAction</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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 (ByPropertyName)" position="named" aliases="Request Number"> <maml:name>RequestNumber</maml:name> <maml:description> <maml:para>Specifies the identifier of the incident or request ticket that owns the action to be ended.</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 (ByPropertyName, ByValue)" position="named" aliases="Action ID"> <maml:name>ActionId</maml:name> <maml:description> <maml:para>Specifies the IDs of the actions to end.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</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>Values</maml:name> <maml:description> <maml:para>Specifies one or more parameter values to assist in ending the action.</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 (ByPropertyName, ByValue)" position="named" aliases="Request Number"> <maml:name>RequestNumber</maml:name> <maml:description> <maml:para>Specifies the identifier of the incident or request ticket that owns the action to be ended.</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>Values</maml:name> <maml:description> <maml:para>Specifies one or more parameter values to assist in ending the action.</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 information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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 (ByPropertyName, ByValue)" position="named" aliases="Action ID"> <maml:name>ActionId</maml:name> <maml:description> <maml:para>Specifies the IDs of the actions to end.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe ticket identifiers, action records and action IDs to the cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The unique identifier of the incident or request ticket.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: End all actions for an incident ticket</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Test' PS C:\> Get-EasyVistaAction -Connection $connection -RequestNumber 'I200320_000031'</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: End all 'Customer Comment' actions for an incident ticket</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Test' PS C:\> $actionFilter = [PSCustomObject]@{Id = 'ACTION_LABEL_EN'; Operator = 'EqualTo'; Value = 'Customer Comment'} PS C:\> $requestFilter = [PSCustomObject]@{Id = 'REQUEST.RFC_NUMBER'; Operator = 'EqualTo'; Value = 'I200320_000031'} PS C:\> $filters = @($actionFilter, $requestFilter) PS C:\> $actions = Get-EasyVistaAction -Connection $connection -Filters $filters PS C:\> $actions | Close-EasyVistaAction -Connection $connections</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-EasyVistaAction</command:name> <maml:description> <maml:para>Retrieve the action records for one or more tickets.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>EasyVistaAction</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-EasyVistaAction cmdlet retrieves action records for one or more tickets in EasyVista Service Manager. You can specify an action by action ID or by filter criteria.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="ByActionId"> <!--NAME: ByActionId--> <maml:name>Get-EasyVistaAction</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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 (ByPropertyName, ByValue)" position="named" aliases="Action ID"> <maml:name>ActionId</maml:name> <maml:description> <maml:para>Specifies the IDs of the action records to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ByFilter"> <!--NAME: ByFilter--> <maml:name>Get-EasyVistaAction</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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>Filters</maml:name> <maml:description> <maml:para>Specifies custom filters used to determine which action records to retrieve. Each filter object must for constructed as follows: [PSCustomObject]@{'Id'=<Field Name>;' Operator'=<Filter Operator>;' Value'=<Filter Value>}</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 action records to retrieve.</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>Descending</maml:name> <maml:description> <maml:para>Indicates that the action records should be returned in descending order. The default is ascending order.</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>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field used to order the action records.</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>Fields</maml:name> <maml:description> <maml:para>Specifies a comma delimited list of fields to retrieve. The default is to retieve all action fields.</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="Default"> <!--NAME: Default--> <maml:name>Get-EasyVistaAction</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of action records to retrieve.</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>Descending</maml:name> <maml:description> <maml:para>Indicates that the action records should be returned in descending order. The default is ascending order.</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>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field used to order the action records.</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>Fields</maml:name> <maml:description> <maml:para>Specifies a comma delimited list of fields to retrieve. The default is to retieve all action fields.</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 (ByPropertyName, ByValue)" position="named" aliases="Action ID"> <maml:name>ActionId</maml:name> <maml:description> <maml:para>Specifies the IDs of the action records to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</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 information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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>Filters</maml:name> <maml:description> <maml:para>Specifies custom filters used to determine which action records to retrieve. Each filter object must for constructed as follows: [PSCustomObject]@{'Id'=<Field Name>;' Operator'=<Filter Operator>;' Value'=<Filter Value>}</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 action records to retrieve.</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>Descending</maml:name> <maml:description> <maml:para>Indicates that the action records should be returned in descending order. The default is ascending order.</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>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field used to order the action records.</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>Fields</maml:name> <maml:description> <maml:para>Specifies a comma delimited list of fields to retrieve. The default is to retieve all action fields.</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>Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe action IDs to the 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>An object that represents the action record that was retrieved.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Get all actions for an incident ticket</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Test' PS C:\> $filter = [PSCustomObject]@{Id = 'REQUEST.RFC_NUMBER'; Operator = 'EqualTo'; Value = 'I200320_000031'} PS C:\> $actions = Get-EasyVistaAction -Connection $connection -Filters $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>Get-EasyVistaComment</command:name> <maml:description> <maml:para>Get the justification (comment field) of a specified action or ticket.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>EasyVistaComment</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-EasyVistaComment cmdlet retrieves the comment field from an action or ticket record in EasyVista Service Manager. This cmdlet is necessary as the comment field is not included in the records returned by the Get-EasyVistaAction or Get-EasyVistaRequest cmdlets.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="ByActionId"> <!--NAME: ByActionId--> <maml:name>Get-EasyVistaComment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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" aliases="Action ID"> <maml:name>ActionId</maml:name> <maml:description> <maml:para>Specifies the IDs of the actions to retrieve comments from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ByRequestNumber"> <!--NAME: ByRequestNumber--> <maml:name>Get-EasyVistaComment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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 (ByPropertyName, ByValue)" position="named" aliases="Request Number"> <maml:name>RequestNumber</maml:name> <maml:description> <maml:para>Specifies the identifiers of the tickets to retrieve comments from.</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="named" aliases="Action ID"> <maml:name>ActionId</maml:name> <maml:description> <maml:para>Specifies the IDs of the actions to retrieve comments from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</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 information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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 (ByPropertyName, ByValue)" position="named" aliases="Request Number"> <maml:name>RequestNumber</maml:name> <maml:description> <maml:para>Specifies the identifiers of the tickets to retrieve comments from.</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>Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe action IDs to the cmdlet.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe ticket identifiers to the cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The comment that was retrieved from the action or ticket.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Get the comment from an incident ticket</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Test' PS C:\> $comment = Get-EasyVistaComment -Connection $connection -RequestNumber 'I200320_000031'</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 comments for all actions associated with an incident ticket</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 'Test'c PS C:\> $actions = Get-EasyVistaAction -Connection $connection -RequestNumber 'I200320_000031' PS C:\> $actionIds = $actions | Select-Object -ExpandProperty 'Action ID PS C:\> $comments = Get-EasyVistaComment -Connection $connection -ActionId $actionIds</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-EasyVistaDepartment</command:name> <maml:description> <maml:para>Gets department records.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb> Get</command:verb> <command:noun>EasyVistaDepartment</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-EasyVistaDepartment cmdlet retrieves department records from EasyVista Service Manager. You can retrieve department records by department ID or with one or more department filters.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="ByDepartmentId"> <!--NAME: ByDepartmentId--> <maml:name> Get-EasyVistaDepartment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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 (ByPropertyName, ByValue)" position="named" aliases="Department ID"> <maml:name>DepartmentId</maml:name> <maml:description> <maml:para>Specifies the IDs of the department records to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ByFilter"> <!--NAME: ByFilter--> <maml:name> Get-EasyVistaDepartment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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>Filters</maml:name> <maml:description> <maml:para>Specifies filter objects that determine which department records to retrieve. Each filter object must for constructed as follows: [PSCustomObject]@{'Id'=<Field Name>;' Operator'=<Filter Operator>;' Value'=<Filter Value>}</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 department records to retrieve.</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>Descending</maml:name> <maml:description> <maml:para>Indicates that the department records should be returned in descending order. The default is ascending order.</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>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field used to order the deparment records.</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="Default"> <!--NAME: Default--> <maml:name> Get-EasyVistaDepartment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of department records to retrieve.</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>Descending</maml:name> <maml:description> <maml:para>Indicates that the department records should be returned in descending order. The default is ascending order.</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>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field used to order the deparment records.</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 (ByPropertyName, ByValue)" position="named" aliases="Department ID"> <maml:name>DepartmentId</maml:name> <maml:description> <maml:para>Specifies the IDs of the department records to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</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 information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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>Filters</maml:name> <maml:description> <maml:para>Specifies filter objects that determine which department records to retrieve. Each filter object must for constructed as follows: [PSCustomObject]@{'Id'=<Field Name>;' Operator'=<Filter Operator>;' Value'=<Filter Value>}</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 department records to retrieve.</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>Descending</maml:name> <maml:description> <maml:para>Indicates that the department records should be returned in descending order. The default is ascending order.</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>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field used to order the deparment records.</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>Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe department IDs to the 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>An object that represents the department record that were retrieved.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Get all departments whose name starts with 'IT'</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Test'] PS C:\> $filter = [PSCustomObject]@{Id = 'DEPARTMENT_EN'; Operator = 'StartsWith'; Value = 'IT'} PS C:\> $departments = Get-EasyVistaDepartment -Connection $connection -Filters $filter </dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Get the first 10 departments ordered by department name</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Test'] PS C:\> $departments = Get-EasyVistaDepartment -Connection $connection -OrderBy 'Department' -Limit 10 </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-EasyVistaDescription</command:name> <maml:description> <maml:para>Get the description from a specified action or ticket.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>EasyVistaDescription</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-EasyVistaDescription cmdlet retrieves the description field from an action or ticket record in EasyVista Service Manager. This cmdlet is necessary because the description field is not included in the records returned by the Get-EasyVistaAction or Get-EasyVistaRequest cmdlets.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="ByActionId"> <!--NAME: ByActionId--> <maml:name>Get-EasyVistaDescription</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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" aliases="Action ID"> <maml:name>ActionId</maml:name> <maml:description> <maml:para>Specifies the IDs of the actions to retrieve descriptions from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ByRequestNumber"> <!--NAME: ByRequestNumber--> <maml:name>Get-EasyVistaDescription</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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 (ByPropertyName, ByValue)" position="named" aliases="Request Number"> <maml:name>RequestNumber</maml:name> <maml:description> <maml:para>Specifies the identifiers of the tickets to retrieve descriptions from.</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="named" aliases="Action ID"> <maml:name>ActionId</maml:name> <maml:description> <maml:para>Specifies the IDs of the actions to retrieve descriptions from.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</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 information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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 (ByPropertyName, ByValue)" position="named" aliases="Request Number"> <maml:name>RequestNumber</maml:name> <maml:description> <maml:para>Specifies the identifiers of the tickets to retrieve descriptions from.</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>Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe action IDs to the cmdlet.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe ticket identifiers to the 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 description that was retrieved from the action or ticket.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Get the description from an incident ticket</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Test' PS C:\> $comment = Get-EasyVistaDescription -Connection $connection -RequestNumber 'I200320_000031'</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 descriptions for all actions associated with an incident ticket</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 'Test' PS C:\> $actions = Get-EasyVistaAction -Connection $connection -RequestNumber 'I200320_000031' PS C:\> $actionIds = $actions | Select-Object -ExpandProperty 'Action ID PS C:\> $descriptions = Get-EasyVistaDescription -Connection $connection -ActionId $actionIds</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-EasyVistaEmployee</command:name> <maml:description> <maml:para>Get employee records.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>EasyVistaEmployee</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-EasyVistaEmployee cmdlet retrieves employee records from EasyVista Service Manager. You can retrieve employee records by ID or with one or more employee filters.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="ByEmployeeId"> <!--NAME: ByEmployeeId--> <maml:name>Get-EasyVistaEmployee</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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 (ByPropertyName, ByValue)" position="named" aliases="Employee ID"> <maml:name>EmployeeId</maml:name> <maml:description> <maml:para>Specifies the IDs of the employee records to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ByFilter"> <!--NAME: ByFilter--> <maml:name>Get-EasyVistaEmployee</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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>Filters</maml:name> <maml:description> <maml:para>Specifies filter object that identify which employee records to retrieve. Each filter object must for constructed as follows: [PSCustomObject]@{'Id'=<Field Name>;' Operator'=<Filter Operator>;' Value'=<Filter Value>}</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 employee records to retrieve.</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>Descending</maml:name> <maml:description> <maml:para>Indicates that the employee records should be returned in descending order. The default is ascending order.</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>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the employee records.</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="Default"> <!--NAME: Default--> <maml:name>Get-EasyVistaEmployee</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of employee records to retrieve.</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>Descending</maml:name> <maml:description> <maml:para>Indicates that the employee records should be returned in descending order. The default is ascending order.</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>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the employee records.</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 (ByPropertyName, ByValue)" position="named" aliases="Employee ID"> <maml:name>EmployeeId</maml:name> <maml:description> <maml:para>Specifies the IDs of the employee records to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</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 information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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>Filters</maml:name> <maml:description> <maml:para>Specifies filter object that identify which employee records to retrieve. Each filter object must for constructed as follows: [PSCustomObject]@{'Id'=<Field Name>;' Operator'=<Filter Operator>;' Value'=<Filter Value>}</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 employee records to retrieve.</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>Descending</maml:name> <maml:description> <maml:para>Indicates that the employee records should be returned in descending order. The default is ascending order.</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>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field by which to order the employee records.</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>Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe employee IDs to the 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>An object that represents the employee record that was retrieved.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Get an employee record using their email</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Test' PS C:\> $filter = [PSCustomObject]@{Id = 'E_MAIL'; Operator = 'EqualTo'; Value = 'hank.scorpio@globex.com'} PS C:\> $employee = Get-EasyVistaEmployee -Connection $connection -Filters $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>Get-EasyVistaLocation</command:name> <maml:description> <maml:para>Get location records.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>EasyVistaLocation</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-EasyVistaLocation cmdlet retrieves location records from EasyVista Service Manager. You can retrieve location records by ID or with one or more location filters.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="ByLocationId"> <!--NAME: ByLocationId--> <maml:name>Get-EasyVistaLocation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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 (ByPropertyName, ByValue)" position="named" aliases="Location ID"> <maml:name>LocationId</maml:name> <maml:description> <maml:para>Specifies the IDs of the location records to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ByFilter"> <!--NAME: ByFilter--> <maml:name>Get-EasyVistaLocation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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>Filters</maml:name> <maml:description> <maml:para>Specifies filter objects that identify which location records to retrieve. Each filter object must for constructed as follows: [PSCustomObject]@{'Id'=<Field Name>;' Operator'=<Filter Operator>;' Value'=<Filter Value>}</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 location records to retrieve.</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>Descending</maml:name> <maml:description> <maml:para>Indicates that the location records should be returned in descending order. The default is ascending order.</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>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field that should be used to order the location records.</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="Default"> <!--NAME: Default--> <maml:name>Get-EasyVistaLocation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of location records to retrieve.</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>Descending</maml:name> <maml:description> <maml:para>Indicates that the location records should be returned in descending order. The default is ascending order.</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>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field that should be used to order the location records.</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 (ByPropertyName, ByValue)" position="named" aliases="Location ID"> <maml:name>LocationId</maml:name> <maml:description> <maml:para>Specifies the IDs of the location records to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</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 information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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>Filters</maml:name> <maml:description> <maml:para>Specifies filter objects that identify which location records to retrieve. Each filter object must for constructed as follows: [PSCustomObject]@{'Id'=<Field Name>;' Operator'=<Filter Operator>;' Value'=<Filter Value>}</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 location records to retrieve.</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>Descending</maml:name> <maml:description> <maml:para>Indicates that the location records should be returned in descending order. The default is ascending order.</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>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field that should be used to order the location records.</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>Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe location IDs to the 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>An object that represents the location record that was retrieved.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>Example: Get all locations where location name starts with 'Main'</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Test' PS C:\> $filter = [PSCustomObject]@{Id = 'LOCATION_EN'; Operator = 'StartsWith'; Value = 'Main'} PS C:\> $locations = Get-EasyVistaLocation -Connection $connection -Filters $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>Get-EasyVistaRequest</command:name> <maml:description> <maml:para>Get incident and request records.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>EasyVistaRequest</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-EasyVistaRequest cmdlet retrieves incident and request ticket records from EasyVista Service Manager. You can retrieve employee records by ID, ticket identifier or with one or more request filters.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="ByRequestNumber"> <!--NAME: ByRequestNumber--> <maml:name>Get-EasyVistaRequest</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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 (ByPropertyName, ByValue)" position="named" aliases="Request Number"> <maml:name>RequestNumber</maml:name> <maml:description> <maml:para>Specifies the identifiers of the incident and request records 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:syntaxItem parametersetname="ByRequestId"> <!--NAME: ByRequestId--> <maml:name>Get-EasyVistaRequest</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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 IDs of the incidents and request records to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ByFilter"> <!--NAME: ByFilter--> <maml:name>Get-EasyVistaRequest</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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>Filters</maml:name> <maml:description> <maml:para>Specifies filter objects used to identify which incident or request records to retrieve. Each filter object must for construted as follows: [PSCustomObject]@{'Id'=<Field Name>;' Operator'=<Filter Operator>;' Value'=<Filter Value>}</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 ticket records to retrieve.</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>Descending</maml:name> <maml:description> <maml:para>Indicates that the ticket records should be returned in descending order. The default is ascending order.</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>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field used to order the ticket records.</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>Fields</maml:name> <maml:description> <maml:para>Specifies a comma delimted list of fields to retrieve for each ticket record. The default is to retrieve all fields.</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="Default"> <!--NAME: Default--> <maml:name>Get-EasyVistaRequest</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of ticket records to retrieve.</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>Descending</maml:name> <maml:description> <maml:para>Indicates that the ticket records should be returned in descending order. The default is ascending order.</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>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field used to order the ticket records.</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>Fields</maml:name> <maml:description> <maml:para>Specifies a comma delimted list of fields to retrieve for each ticket record. The default is to retrieve all fields.</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 (ByPropertyName, ByValue)" position="named" aliases="Request Number"> <maml:name>RequestNumber</maml:name> <maml:description> <maml:para>Specifies the identifiers of the incident and request records 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:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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 IDs of the incidents and request records to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</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>Filters</maml:name> <maml:description> <maml:para>Specifies filter objects used to identify which incident or request records to retrieve. Each filter object must for construted as follows: [PSCustomObject]@{'Id'=<Field Name>;' Operator'=<Filter Operator>;' Value'=<Filter Value>}</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 ticket records to retrieve.</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>Descending</maml:name> <maml:description> <maml:para>Indicates that the ticket records should be returned in descending order. The default is ascending order.</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>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field used to order the ticket records.</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>Fields</maml:name> <maml:description> <maml:para>Specifies a comma delimted list of fields to retrieve for each ticket record. The default is to retrieve all fields.</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>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe ticket identifiers to the cmdlet.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe ticket IDs to the cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>An object that represents the incident or request record that was retrieved.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Get an incident ticket by incident number</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Test' PS C:\> $ticket = Get-EasyVistaRequest -Connection $connection -RequestNumber 'I200320_000031'</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> <command:example> <maml:title>Example 2: Get the 25 most urgent incident tickets</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Test' PS C:\> $filter = [PSCustomObject]@{Id = 'URGENCY_ID'; Operator = 'EqualTo'; Value = '1 - High'} PS C:\> $tickets = Get-EasyVistaRequest -Connection $connection -Filters $filter -Descending -Limit 25 -OrderBy 'Create Date' </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-EasyVistaRequestCatalog</command:name> <maml:description> <maml:para>Get ticket catalog records.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>EasyVistaRequestCatalog</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-EasyVistaRequestCatalog cmdlet retrieves ticket catalog records from EasyVista Service Manager. You can retrieve catalog records by ID or by using one or more catalog filters.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="ByCatalogId"> <!--NAME: ByCatalogId--> <maml:name>Get-EasyVistaRequestCatalog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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>CatalogId</maml:name> <maml:description> <maml:para>Specifies the IDs of the catalog records to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ByFilter"> <!--NAME: ByFilter--> <maml:name>Get-EasyVistaRequestCatalog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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>Filters</maml:name> <maml:description> <maml:para>Specifies filter objects used to identify which catalog records to retrieve. Each filter object must for construted as follows: [PSCustomObject]@{'Id'=<Field Name>;' Operator'=<Filter Operator>;' Value'=<Filter Value>}</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 catalog records to retrieve.</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>Descending</maml:name> <maml:description> <maml:para>Indicates that the catalog records should be returned in descending order. The default is ascending order.</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>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field that should be used to order the catalog records.</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="Default"> <!--NAME: Default--> <maml:name>Get-EasyVistaRequestCatalog</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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>Limit</maml:name> <maml:description> <maml:para>Specifies the maximum number of catalog records to retrieve.</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>Descending</maml:name> <maml:description> <maml:para>Indicates that the catalog records should be returned in descending order. The default is ascending order.</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>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field that should be used to order the catalog records.</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>CatalogId</maml:name> <maml:description> <maml:para>Specifies the IDs of the catalog records to retrieve.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</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 information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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>Filters</maml:name> <maml:description> <maml:para>Specifies filter objects used to identify which catalog records to retrieve. Each filter object must for construted as follows: [PSCustomObject]@{'Id'=<Field Name>;' Operator'=<Filter Operator>;' Value'=<Filter Value>}</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 catalog records to retrieve.</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>Descending</maml:name> <maml:description> <maml:para>Indicates that the catalog records should be returned in descending order. The default is ascending order.</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>OrderBy</maml:name> <maml:description> <maml:para>Specifies the field that should be used to order the catalog records.</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>Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe catalog IDs to the 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>An object that represents the catalog record that was retrieved.</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>New-EasyVistaAction</command:name> <maml:description> <maml:para>Create a new action for an incident or request ticket.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>EasyVistaAction</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-EasyVistaAction cmdlet creates a new action for an incident or request ticket in EasyVista Service Manager.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="Default"> <!--NAME: Default--> <maml:name>New-EasyVistaAction</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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 (ByPropertyName, ByValue)" position="named" aliases="Request Number"> <maml:name>RequestNumber</maml:name> <maml:description> <maml:para>Specifies the identifier of the incident or request ticket.</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>ActionType</maml:name> <maml:description> <maml:para>Specifies the the type of action to create (i.e. 'Customer Comment').</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 values to assign to the new action.</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="WithParentAction"> <!--NAME: WithParentAction--> <maml:name>New-EasyVistaAction</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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 (ByPropertyName, ByValue)" position="named" aliases="Request Number"> <maml:name>RequestNumber</maml:name> <maml:description> <maml:para>Specifies the identifier of the incident or request ticket.</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>ActionType</maml:name> <maml:description> <maml:para>Specifies the the type of action to create (i.e. 'Customer Comment').</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>ParentActionId</maml:name> <maml:description> <maml:para>Specifies the ID of the parent action.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</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 values to assign to the new action.</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 (ByPropertyName, ByValue)" position="named" aliases="Request Number"> <maml:name>RequestNumber</maml:name> <maml:description> <maml:para>Specifies the identifier of the incident or request ticket.</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>ActionType</maml:name> <maml:description> <maml:para>Specifies the the type of action to create (i.e. 'Customer Comment').</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 values to assign to the new action.</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 information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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>ParentActionId</maml:name> <maml:description> <maml:para>Specifies the ID of the parent action.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe ticket identifiers to the cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The ID of the action that was created.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>Example: Create a new Customer Comment action</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Test' PS C:\> $values = @{DESCRIPTION = 'Waiting for manager approval'} PS C:\> New-EasyVistaAction -ActionType 'Customer Comment' -Connection $connection -RequestNumber 'I200320_000031' -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>New-EasyVistaRequest</command:name> <maml:description> <maml:para>Create a new incident or request ticket.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>EasyVistaRequest</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The New-EasyVistaRequest cmdlet creates a new incident or request ticket in EasyVista Service Manager.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="WithCatalogCode"> <!--NAME: WithCatalogCode--> <maml:name>New-EasyVistaRequest</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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>CatalogCode</maml:name> <maml:description> <maml:para>Specifies the code of the catalog to use as the subject of the incident or request ticket.</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>Values</maml:name> <maml:description> <maml:para>Specifies the values to assign to the new incident or request ticket.</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="WithCatalogGuid"> <!--NAME: WithCatalogGuid--> <maml:name>New-EasyVistaRequest</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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>CatalogGuid</maml:name> <maml:description> <maml:para>Specifies the identifier of the catalog to use as the subject of the incident or request ticket.</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>Values</maml:name> <maml:description> <maml:para>Specifies the values to assign to the new incident or request ticket.</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>CatalogCode</maml:name> <maml:description> <maml:para>Specifies the code of the catalog to use as the subject of the incident or request ticket.</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>Values</maml:name> <maml:description> <maml:para>Specifies the values to assign to the new incident or request ticket.</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 information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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>CatalogGuid</maml:name> <maml:description> <maml:para>Specifies the identifier of the catalog to use as the subject of the incident or request ticket.</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:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The unique identifier of the incident or request ticket that was created.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>Example: Create a new incident ticket</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Test' PS C:\> $catalogFilter = [PSCustomObject]@{Id = 'TITLE_EN'; Operator = 'EqualTo'; Value = 'Network'} PS C:\> $catalogCode = Get-EasyVistaRequestCatalog -Connection $connection -Filters $catalogFilter PS C:\> $values = @{REQUESTOR_MAIL = 'scorpio@globex.com'; SEVERITY_ID = '2 - Medium'; URGENCY_ID = '2 - Medium'} PS C:\> New-EasyVistaRequest -CatalogCode '$catalogCode' -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>Resume-EasyVistaRequest</command:name> <maml:description> <maml:para>Resume a previously suspended ticket.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Resume</command:verb> <command:noun>EasyVistaRequest</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Resume-EasyVistaRequest cmdlet resumes a previously suspended incident or request ticket in EasyVista Service Manager.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Resume-EasyVistaRequest</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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 (ByPropertyName, ByValue)" position="named" aliases="Request Number"> <maml:name>RequestNumber</maml:name> <maml:description> <maml:para>Specifies the identifiers of the tickets to be resumed.</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>Values</maml:name> <maml:description> <maml:para>Specifies parameter values used to resume the incident or request ticket.</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 (ByPropertyName, ByValue)" position="named" aliases="Request Number"> <maml:name>RequestNumber</maml:name> <maml:description> <maml:para>Specifies the identifiers of the tickets to be resumed.</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>Values</maml:name> <maml:description> <maml:para>Specifies parameter values used to resume the incident or request ticket.</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 information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe ticket identifiers to the cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The identifier of the ticket that was resumed.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Resume an incident ticket</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Test' PS C:\> Resume-EasyVistaRequest -Connection $connection -RequestNumber 'I200320_000031'</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>Set-EasyVistaAction</command:name> <maml:description> <maml:para>Modify one or more fields of an action.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>EasyVistaAction</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-EasyVistaAction cmdlet modifies one or more fields of an incident or request action in EasyVista Service Manager.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-EasyVistaAction</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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 (ByPropertyName, ByValue)" position="named" aliases="Action ID"> <maml:name>ActionId</maml:name> <maml:description> <maml:para>Specifies the IDs of the action records to modify.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</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 to assign to the action record.</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 (ByPropertyName, ByValue)" position="named" aliases="Action ID"> <maml:name>ActionId</maml:name> <maml:description> <maml:para>Specifies the IDs of the action records to modify.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Int64[]</command:parameterValue> <dev:type> <maml:name>Int64[]</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 to assign to the action record.</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 information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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>Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe action IDs to the cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The ID of the action that was updated.</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-EasyVistaRequest</command:name> <maml:description> <maml:para>Update one or more fields of a ticket.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>EasyVistaRequest</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Set-EasyVistaRequest cmdlet modifies one or more fields of an incident or request ticket in EasyVista Service Manager.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-EasyVistaRequest</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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 (ByPropertyName, ByValue)" position="named" aliases="Request Number"> <maml:name>RequestNumber</maml:name> <maml:description> <maml:para>Specifies the identifiers of the incident or request tickets 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 the field values to assign to the incident or request ticket.</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 (ByPropertyName, ByValue)" position="named" aliases="Request Number"> <maml:name>RequestNumber</maml:name> <maml:description> <maml:para>Specifies the identifiers of the incident or request tickets 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 the field values to assign to the incident or request ticket.</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 information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe ticket identifiers to the cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The ticket identifier of the incident or request that was updated.</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>Suspend-EasyVistaRequest</command:name> <maml:description> <maml:para>Suspend an incident or request ticket.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Suspend</command:verb> <command:noun>EasyVistaRequest</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Suspend-EasyVistaRequest cmdlet suspends an incident or request ticket in EasyVista Service Manager.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Suspend-EasyVistaRequest</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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 (ByPropertyName, ByValue)" position="named" aliases="Request Number"> <maml:name>RequestNumber</maml:name> <maml:description> <maml:para>Specifies the identifiers of the incident or request tickets to suspend.</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>Values</maml:name> <maml:description> <maml:para>Specifies values used to suspend the incident or request ticket.</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 (ByPropertyName, ByValue)" position="named" aliases="Request Number"> <maml:name>RequestNumber</maml:name> <maml:description> <maml:para>Specifies the identifiers of the incident or request tickets to suspend.</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>Values</maml:name> <maml:description> <maml:para>Specifies values used to suspend the incident or request ticket.</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 information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</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>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe ticket identifiers to the cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The unique identifier of the incident or request ticket that was suspended.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Suspend an incident ticket</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Test' PS C:\> Suspend-EasyVistaRequest -Connection $connection -RequestNumber 'I200320_000031'</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </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>Add-EasyVistaAttachment</command:name> <maml:description> <maml:para>Upload an attachment to a ticket.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>EasyVistaAttachment</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Add-EasyVistaAttachment cmdlet uploads an attachment to one or more incident or request tickets in EasyVista Service Manager.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Add-EasyVistaAttachment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Connection</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Hashtable</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Request Number" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">RequestNumber</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>Specifies the unique identifiers of the tickets to be modified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"></dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Specifies the name of the attachment.</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:parameter required="true" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>Content</maml:name> <maml:description> <maml:para>Specifies the content to be uploaded to the ticket.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Byte[]</command:parameterValue> <dev:type> <maml:name>Byte[]</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" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Connection</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Hashtable</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Request Number" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">RequestNumber</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>Specifies the unique identifiers of the tickets to be modified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">String[]</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"></dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>FileName</maml:name> <maml:description> <maml:para>Specifies the name of the attachment.</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:parameter required="true" globbing="false" pipelineInput="False" variableLength="false" position="named"> <maml:name>Content</maml:name> <maml:description> <maml:para>Specifies the content to be uploaded to the ticket.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Byte[]</command:parameterValue> <dev:type> <maml:name>Byte[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe ticket identifiers to the cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The unique identifier of the incident or request that was modified.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Upload an error image to an incident ticket</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Test' PS C:\> $content = Get-Content -Path '.\Error.png' PS C:\> Add-EasyVistaAttachmentContent -Connection $connection -RequestNumber 'I200320_000031' -FileName 'Error.png' -Content $content </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>Get-EasyVistaAttachment</command:name> <maml:description> <maml:para>Get the attachment records associated a ticket.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>EasyVistaAttachment</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-EasyVistaAttachment cmdlet retrieves attachment records for an incident or request ticket in EasyVista Service Manager.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-EasyVistaAttachment</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Connection</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Hashtable</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Request Number" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">RequestNumber</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>Specifies the unique identifier of the incident or request ticket.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">String</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Connection</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Hashtable</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named" aliases="Request Number" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">RequestNumber</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>Specifies the unique identifier of the incident or request ticket.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">String</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe ticket identifiers to the cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The unique identifier of the incident or request.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Get the attachment records for an incident ticket</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Test' PS C:\> $attachments = Get-EasyVistaAttachment -Connection $connection -RequestNumber 'I200320_000031'</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>Get-EasyVistaAttachmentContent</command:name> <maml:description> <maml:para>Download the content of a ticket attachment.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>EasyVistaAttachmentContent</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>The Get-EasyVistaAttachmentContent cmdlet downloads the content of an incident or request ticket attachment in EasyVista Service Manager.</maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Get-EasyVistaAttachmentContent</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="0" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Connection</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Hashtable</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"></dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" variableLength="false" position="named" aliases="Attachment ID"> <maml:name>AttachmentId</maml:name> <maml:description> <maml:para>Specifies the ID of the attachment to download.</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" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Connection</maml:name> <maml:description xmlns:maml="http://schemas.microsoft.com/maml/2004/10"> <maml:para>Specifies information used to connect to an EasyVista Service Manager instance. The value for this parameter is usually obtained using a connection asset data source or Get-AutomationConnection activity.</maml:para> <maml:para>The following properties must be included in the hashtable:</maml:para> <maml:para>ServerUrl: the URL of the EasyVista Service Manager REST API endpoint. Account: your EasyVista Service Manager account number. User: your EasyVista Service Manager user name. Password: your EasyVista ServiceManager password. UserDateFormat: the format used for publishing date values (i.e. mm/dd/yy). SkipCertificateValidation: indicates whether certificate validation should be skipped. RequestTimeoutSeconds: the number of seconds to wait for the request to be processed. LicenseKey: the license key that entitles you to use the integration module.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <maml:name xmlns:maml="http://schemas.microsoft.com/maml/2004/10">Hashtable</maml:name> <maml:uri xmlns:maml="http://schemas.microsoft.com/maml/2004/10" /> </dev:type> <dev:defaultValue xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"></dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" variableLength="false" position="named" aliases="Attachment ID"> <maml:name>AttachmentId</maml:name> <maml:description> <maml:para>Specifies the ID of the attachment to download.</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>String</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe attachment IDs to the cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>Byte[]</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>The attachment content that was downloaded.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:examples> <!--Examples--> <command:example> <maml:title>Example 1: Download the content of an attachment from an incident ticket</maml:title> <maml:introduction> <maml:para /> </maml:introduction> <dev:code>PS C:\> $connection = Get-AutomationConnection -Name 'Test' PS C:\> $attachment = Get-EasyVistaAttachment -Connection $connection -RequestNumber 'I200320_000031' PS C:\> $content = Get-EasyVistaAttachmentContent -Connection $connection -AttachmentId $attachment.'Attachment ID'</dev:code> <dev:remarks> <maml:para /> </dev:remarks> </command:example> </command:examples> </command:command> <!--Edited with: SAPIEN PowerShell HelpWriter 2018 v2.2.38--> </helpItems> |