Kelverion.Freshservice.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <!--Edited with: SAPIEN PowerShell HelpWriter 2017 v2.1.34--> <!--Generated by: SAPIEN PowerShell HelpWriter 2017 v2.1.34--> <!-- Module: Kelverion.Freshservice Version: 1.0 --> <!--All Commands--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Add-FreshserviceTicketNote</command:name> <maml:description> <maml:para>Add a note to an existing ticket.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Add</command:verb> <command:noun>FreshserviceTicketNote</command:noun> <dev:version /> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Add-FreshserviceTicketNote</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</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>TicketId</maml:name> <maml:description> <maml:para>Identifies the ticket the note is to be added to.</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>Field values for the ticket note. Example: @{'body'='<note text>';'source'='Chat'}</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>AttachmentFileName</maml:name> <maml:description> <maml:para>Specifies a file name for the attachment, when also adding an attachment with the note.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AttachmentContent</maml:name> <maml:description> <maml:para>Specifies the attachment to be added with the note.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">Byte[]</command:parameterValue> <dev:type> <maml:name>Byte[]</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>TicketId</maml:name> <maml:description> <maml:para>Identifies the ticket the note is to be added to.</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>Field values for the ticket note. Example: @{'body'='<note text>';'source'='Chat'}</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 connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</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>AttachmentFileName</maml:name> <maml:description> <maml:para>Specifies a file name for the attachment, when also adding an attachment with the note.</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>AttachmentContent</maml:name> <maml:description> <maml:para>Specifies the attachment to be added with the note.</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></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe Ticket IDs to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Note ID for the newly created ticket note.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-FreshserviceAgent</command:name> <maml:description> <maml:para>Retrieves and filters agent users.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>FreshserviceAgent</command:noun> <dev:version /> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="ByState"> <!--NAME: ByState--> <maml:name>Get-FreshserviceAgent</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</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>State</maml:name> <maml:description> <maml:para>Specifies the state for agents to be retrieved. Valid values are: full-time, occasional.</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="ByEmail"> <!--NAME: ByEmail--> <maml:name>Get-FreshserviceAgent</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</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>Email</maml:name> <maml:description> <maml:para>Specifies the email for an agent to be retrieved.</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="ByPhone"> <!--NAME: ByPhone--> <maml:name>Get-FreshserviceAgent</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</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>Phone</maml:name> <maml:description> <maml:para>Specifies the work phone number for an agent to be retrieved.</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="ById" default="true"> <!--NAME: ById--> <!--TAG: DEFAULT--> <maml:name>Get-FreshserviceAgent</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</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>AgentId</maml:name> <maml:description> <maml:para>Specifies the ID for an agent to be retrieved.</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="ByMobilePhone"> <!--NAME: ByMobilePhone--> <maml:name>Get-FreshserviceAgent</maml:name> <command:parameter required="false" globbing="false" pipelineInput="false" variableLength="false" position="named"> <maml:name>MobilePhone</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <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>State</maml:name> <maml:description> <maml:para>Specifies the state for agents to be retrieved. Valid values are: full-time, occasional.</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 connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</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>Email</maml:name> <maml:description> <maml:para>Specifies the email for an agent to be retrieved.</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>Phone</maml:name> <maml:description> <maml:para>Specifies the work phone number for an agent to be retrieved.</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>AgentId</maml:name> <maml:description> <maml:para>Specifies the ID for an agent to be retrieved.</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" globbing="false" pipelineInput="false" variableLength="false" position="named"> <maml:name>MobilePhone</maml:name> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe Agent IDs to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Active - Indicates if user is active. Address - User address. AgentId - Agent unique ID. Created - Time when user was created. Email - User email. ExternalId - External identifier. FirstName - User first name. JobTitle - User job title. Language - User language. LastName - User last name. MobilePhone - User mobile phone number. Occasional - Indicates if agent is occasional or full-time. WorkPhone - User work phone. TimeZone - User time zone. Updated - Time when user record was last 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>Get-FreshserviceRequester</command:name> <maml:description> <maml:para>Retrieves and filters requesters.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>FreshserviceRequester</command:noun> <dev:version /> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="ByState"> <!--NAME: ByState--> <maml:name>Get-FreshserviceRequester</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</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>State</maml:name> <maml:description> <maml:para>Specifies the state for requesters to be retrieved. Valid values are: all, deleted, unverified, verified.</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="ByEmail"> <!--NAME: ByEmail--> <maml:name>Get-FreshserviceRequester</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</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>State</maml:name> <maml:description> <maml:para>Specifies the state for requesters to be retrieved. Valid values are: all, deleted, unverified, verified.</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>Email</maml:name> <maml:description> <maml:para>Specifies the email for a requester to be retrieved.</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="ByPhone"> <!--NAME: ByPhone--> <maml:name>Get-FreshserviceRequester</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</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>State</maml:name> <maml:description> <maml:para>Specifies the state for requesters to be retrieved. Valid values are: all, deleted, unverified, verified.</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>Phone</maml:name> <maml:description> <maml:para>Specifies the phone for a requester to be retrieved.</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="ByMobilePhone"> <!--NAME: ByMobilePhone--> <maml:name>Get-FreshserviceRequester</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</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>State</maml:name> <maml:description> <maml:para>Specifies the state for requesters to be retrieved. Valid values are: all, deleted, unverified, verified.</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>MobilePhone</maml:name> <maml:description> <maml:para>Specifies the mobile phone for a requester to be retrieved.</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="ById" default="true"> <!--NAME: ById--> <!--TAG: DEFAULT--> <maml:name>Get-FreshserviceRequester</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</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>RequesterId</maml:name> <maml:description> <maml:para>Specifies the ID for a requester to be retrieved.</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:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="False" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Specifies the state for requesters to be retrieved. Valid values are: all, deleted, unverified, verified.</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 connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</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>Email</maml:name> <maml:description> <maml:para>Specifies the email for a requester to be retrieved.</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>Phone</maml:name> <maml:description> <maml:para>Specifies the phone for a requester to be retrieved.</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>MobilePhone</maml:name> <maml:description> <maml:para>Specifies the mobile phone for a requester to be retrieved.</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>RequesterId</maml:name> <maml:description> <maml:para>Specifies the ID for a requester to be retrieved.</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>System.Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe Requester IDs to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Active - Indicates if user is active. Address - User address. Created - Time when user was created. Email - User email. ExternalId - External identifier. FirstName - User first name. JobTitle - User job title. Language - User language. LastName - User last name. MobilePhone - User mobile phone number. RequesterId - Requester unique ID. WorkPhone - User work phone. TimeZone - User time zone. Updated - Time when user record was last 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>Get-FreshserviceTicket</command:name> <maml:description> <maml:para>Retrieves and filters tickets.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>FreshserviceTicket</command:noun> <dev:version /> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="ByFilter"> <!--NAME: ByFilter--> <maml:name>Get-FreshserviceTicket</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies a pre-defined Freshservice filter to be used when retrieving tickets. Valid values are: All Tickets, All Unresolved Tickets, Incidents, New & My Open Tickets, Service Requests, Spam, Tickets I Requested, Tickets I’m Watching, Trash.</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>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</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>WorkspaceId</maml:name> <maml:description> <maml:para>Specifies the workspace ID used when retrieving tickets.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ByEmail"> <!--NAME: ByEmail--> <maml:name>Get-FreshserviceTicket</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</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>Filter</maml:name> <maml:description> <maml:para>Specifies a pre-defined Freshservice filter to be used when retrieving tickets. Valid values are: All Tickets, All Unresolved Tickets, Incidents, New & My Open Tickets, Service Requests, Spam, Tickets I Requested, Tickets I’m Watching, Trash.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Email</maml:name> <maml:description> <maml:para>Specifies a requester for which tickets are to be retrieved.</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>WorkspaceId</maml:name> <maml:description> <maml:para>Specifies the workspace ID used when retrieving tickets.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ByRequesterId"> <!--NAME: ByRequesterId--> <maml:name>Get-FreshserviceTicket</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</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>RequesterId</maml:name> <maml:description> <maml:para>Specifies a requester for which tickets are to be retrieved.</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>WorkspaceId</maml:name> <maml:description> <maml:para>Specifies the workspace ID used when retrieving tickets.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ById" default="true"> <!--NAME: ById--> <!--TAG: DEFAULT--> <maml:name>Get-FreshserviceTicket</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="true" pipelineInput="True (ByPropertyName, ByValue)" variableLength="false" position="named"> <maml:name>TicketId</maml:name> <command:parameterValue required="true" variableLength="false">System.In64[]</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WorkspaceId</maml:name> <maml:description> <maml:para>Specifies the workspace ID used when retrieving tickets.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" variableLength="false" position="named"> <maml:name>IncludeAssets</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="Default"> <!--NAME: Default--> <maml:name>Get-FreshserviceTicket</maml:name> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>WorkspaceId</maml:name> <maml:description> <maml:para>Specifies the workspace ID used when retrieving tickets.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Filter</maml:name> <maml:description> <maml:para>Specifies a pre-defined Freshservice filter to be used when retrieving tickets. Valid values are: All Tickets, All Unresolved Tickets, Incidents, New & My Open Tickets, Service Requests, Spam, Tickets I Requested, Tickets I’m Watching, Trash.</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 connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</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>Email</maml:name> <maml:description> <maml:para>Specifies a requester for which tickets are to be retrieved.</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>RequesterId</maml:name> <maml:description> <maml:para>Specifies a requester for which tickets are to be retrieved.</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>WorkspaceId</maml:name> <maml:description> <maml:para>Specifies the workspace ID used when retrieving tickets.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="true" pipelineInput="True (ByPropertyName, ByValue)" variableLength="false" position="named"> <maml:name>TicketId</maml:name> <command:parameterValue required="true" variableLength="false">System.In64[]</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" variableLength="false" position="named"> <maml:name>IncludeAssets</maml:name> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe Ticket IDs to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Assets - Ticket assets. Category - Ticket category. Created - Time when ticket was created. Deleted - True if the ticket is deleted/trashed. Deleted tickets will not be considered in any views except Deleted/Trash filter. DepartmentId - Department ID for the ticket. Description - HTML content of the ticket. DescriptionText - Ticket description. DueBy - Ticket due-by time. ID - Ticket unique ID. GroupId - Group ID to which the ticket is assigned. Impact - Impact of the ticket. IsEscalated - True if an escalation was sent. ItemCategory - Ticket item category. Priority - Priority of the ticket. RequesterId - User ID of the requester. Source - The channel through which the ticket was created. Spam - True if the ticket is marked as spam. Status - Status of the ticket. SubCategory - Ticket sub-category. Subject - Ticket subject. TicketType - Type of ticket. Updated - Time when ticket was last modified. Urgency - Urgency of the ticket. WorkspaceId - Workspace ID of ticket.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Get-FreshserviceTicketNote</command:name> <maml:description> <maml:para>Retrieves ticket notes associated with a ticket.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Get</command:verb> <command:noun>FreshserviceTicketNote</command:noun> <dev:version /> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets" default="true"> <!--NAME: __AllParameterSets--> <!--TAG: DEFAULT--> <maml:name>Get-FreshserviceTicketNote</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</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"> <maml:name>TicketId</maml:name> <maml:description> <maml:para>Specifies a Freshservice account specific ticket identifier for which notes are to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int64</command:parameterValue> <dev:type> <maml:name>Int64</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"> <maml:name>TicketId</maml:name> <maml:description> <maml:para>Specifies a Freshservice account specific ticket identifier for which notes are to be retrieved.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.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 connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</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.Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe Ticket IDs to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Id - Ticket note unique ID Body - Note body HTML BodyText- Note body text Private - Specifies if the note is private or public. Incoming- Specifies if the note should appear as being created from the outside. UserId - ID of the user who creates the note. NotifyEmails - Email addresses of agents/users who need to be notified about this note.</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-FreshserviceTicket</command:name> <maml:description> <maml:para>Creates a new ticket.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>New</command:verb> <command:noun>FreshserviceTicket</command:noun> <dev:version /> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>New-FreshserviceTicket</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Field values for the new ticket. Example: @{'category'='Hardware';'department_id'='IT';'description'='My 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="false" globbing="false" pipelineInput="false" variableLength="false" position="named"> <maml:name>WorkspaceId</maml:name> <maml:description> <maml:para>Specifies the workspace ID for the new ticket.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">System.Int64</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Values</maml:name> <maml:description> <maml:para>Field values for the new ticket. Example: @{'category'='Hardware';'department_id'='IT';'description'='My 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 connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" variableLength="false" position="named"> <maml:name>WorkspaceId</maml:name> <maml:description> <maml:para>Specifies the workspace ID for the new ticket.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">System.Int64</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Ticket ID for the newly created ticket.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--TAG: HASCOMMONPARAMETERS--> <!--Command--> <command:details> <command:name>Remove-FreshserviceTicket</command:name> <maml:description> <maml:para>Deletes a ticket.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>FreshserviceTicket</command:noun> <dev:version /> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="_AllParameterSets" default="true"> <!--NAME: _AllParameterSets--> <!--TAG: DEFAULT--> <maml:name>Remove-FreshserviceTicket</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</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"> <maml:name>TicketId</maml:name> <maml:description> <maml:para>Identifies the ticket to be deleted.</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:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" position="named"> <maml:name>TicketId</maml:name> <maml:description> <maml:para>Identifies the ticket to be deleted.</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 connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</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.Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe Ticket IDs to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Ticket ID for the ticket that was deleted.</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-FreshserviceTicket</command:name> <maml:description> <maml:para>Update an existing ticket.</maml:para> </maml:description> <maml:copyright> <maml:para></maml:para> </maml:copyright> <command:verb>Set</command:verb> <command:noun>FreshserviceTicket</command:noun> <dev:version /> </command:details> <maml:description> <maml:para></maml:para> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="__AllParameterSets"> <!--NAME: __AllParameterSets--> <maml:name>Set-FreshserviceTicket</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="0"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</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"> <maml:name>TicketId</maml:name> <maml:description> <maml:para>Identifies the ticket to be updated.</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>Field values for the updated ticket. Example: @{'category'='Hardware';'department_id'='IT';'description'='My 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="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>AssetDisplayId</maml:name> <maml:description> <maml:para>Asset Display ID of an asset to be associated with the ticket.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">System.Int64[]</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" variableLength="false" position="named"> <maml:name>WorkspaceId</maml:name> <maml:description> <maml:para>The workspace ID of the tickets being updated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">System.Int64</command:parameterValue> <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"> <maml:name>TicketId</maml:name> <maml:description> <maml:para>Identifies the ticket to be updated.</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>Field values for the updated ticket. Example: @{'category'='Hardware';'department_id'='IT';'description'='My 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 connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</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>AssetDisplayId</maml:name> <maml:description> <maml:para>Asset Display ID of an asset to be associated with the ticket.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">System.Int64[]</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="false" globbing="false" pipelineInput="false" variableLength="false" position="named"> <maml:name>WorkspaceId</maml:name> <maml:description> <maml:para>The workspace ID of the tickets being updated.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">System.Int64</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe ticket Ticket IDs to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Ticket ID for the updated created ticket.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!--Generated by: SAPIEN PowerShell HelpWriter 2017 v2.1.34--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-FreshserviceAsset</command:name> <maml:description> <maml:para>Retrieves and filters assets.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>FreshserviceAsset</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="ByName"> <!--NAME: ByName--> <maml:name>Get-FreshserviceAsset</maml:name> <command:parameter required="true" globbing="false" pipelineInput="false" variableLength="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" variableLength="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ById"> <!--NAME: ById--> <maml:name>Get-FreshserviceAsset</maml:name> <command:parameter required="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" variableLength="false" position="named"> <maml:name>DisplayId</maml:name> <command:parameterValue required="true" variableLength="false">System.Int64[]</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" variableLength="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="Default"> <!--NAME: Default--> <maml:name>Get-FreshserviceAsset</maml:name> <command:parameter required="true" globbing="false" pipelineInput="false" variableLength="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" globbing="false" pipelineInput="false" variableLength="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" variableLength="false" position="named"> <maml:name>DisplayId</maml:name> <command:parameterValue required="true" variableLength="false">System.Int64[]</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" variableLength="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe asset Display IDs to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Tag - Asset tag. AssetType - Asset type. Description - Description of the asset. DisplayId - Asset Display ID. ID - Asset unique ID. Name - Name of the asset.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!--Edited with: SAPIEN PowerShell HelpWriter 2017 v2.1.34--> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <!--Command--> <command:details> <command:name>Get-FreshserviceDepartment</command:name> <maml:description> <maml:para>Retrieves and filters departments.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>FreshserviceDepartment</command:noun> <dev:version /> </command:details> <maml:description> <maml:para /> </maml:description> <command:syntax> <!--Parameter Sets--> <command:syntaxItem parametersetname="ByName"> <!--NAME: ByName--> <maml:name>Get-FreshserviceDepartment</maml:name> <command:parameter required="true" globbing="false" pipelineInput="false" variableLength="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" variableLength="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="ById"> <!--NAME: ById--> <maml:name>Get-FreshserviceDepartment</maml:name> <command:parameter required="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" variableLength="false" position="named"> <maml:name>DepartmentId</maml:name> <command:parameterValue required="true" variableLength="false">System.Int64[]</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" variableLength="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem parametersetname="Default"> <!--NAME: Default--> <maml:name>Get-FreshserviceDepartment</maml:name> <command:parameter required="true" globbing="false" pipelineInput="false" variableLength="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!--All Parameters--> <command:parameter required="true" globbing="false" pipelineInput="false" variableLength="false" position="named"> <maml:name>Connection</maml:name> <maml:description> <maml:para>Specifies connection information to the Freshservice site. For example: @{ ServerUrl='<Freshservice Site URL>'; ApiKey='<user API key>'; LicenseKey='<license key>'; SkipCertificateValidation=$false }</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="false" variableLength="false" position="named"> <maml:name>Name</maml:name> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="True (ByPropertyName, ByValue)" variableLength="false" position="named"> <maml:name>DepartmentId</maml:name> <command:parameterValue required="true" variableLength="false">System.Int64[]</command:parameterValue> <dev:defaultValue></dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <!--Inputs--> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>You can pipe asset Department IDs to this cmdlet.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!--Outputs--> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri></maml:uri> </dev:type> <maml:description> <maml:para>Description - Description of the department. ID - Department unique ID. Name - Name of the department.</maml:para> </maml:description> </command:returnValue> </command:returnValues> </command:command> <!--Edited with: SAPIEN PowerShell HelpWriter 2017 v2.1.34--> </helpItems> |