diff --git a/Docs/MarkDown/Connect-HaloAPI.md b/Docs/MarkDown/Connect-HaloAPI.md index 54226d7..8dd60c7 100644 --- a/Docs/MarkDown/Connect-HaloAPI.md +++ b/Docs/MarkDown/Connect-HaloAPI.md @@ -30,15 +30,15 @@ This logs into Halo using the Client Credentials authorisation flow. ## PARAMETERS -### -AdditionalHeaders -Hashtable containing additional parameters to be sent with each request. +### -URL +The URL of the Halo instance to connect to. ```yaml -Type: Hashtable +Type: Uri Parameter Sets: (All) Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -107,15 +107,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -URL -The URL of the Halo instance to connect to. +### -AdditionalHeaders +Hashtable containing additional parameters to be sent with each request. ```yaml -Type: Uri +Type: Hashtable Parameter Sets: (All) Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False diff --git a/Docs/MarkDown/Get-HaloAction.md b/Docs/MarkDown/Get-HaloAction.md index f32db45..1d43b4e 100644 --- a/Docs/MarkDown/Get-HaloAction.md +++ b/Docs/MarkDown/Get-HaloAction.md @@ -54,57 +54,58 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AgentOnly -Only get actions performed by agents. +### -Count +The number of actions to return. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: Int64 +Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -ConversationOnly -Only get actions that are part of agent to end user conversations. +### -TicketID +Get actions for a single ticket with the specified ID. +\[HaloPipelineIDArgumentTransformation()\] ```yaml -Type: SwitchParameter -Parameter Sets: Multi -Aliases: +Type: Int32 +Parameter Sets: (All) +Aliases: ticket_id -Required: False +Required: True Position: Named -Default value: False -Accept pipeline input: False +Default value: 0 +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Count -The number of actions to return. +### -ExcludeSys +Exclude system-performed actions. ```yaml -Type: Int64 +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -EmailOnly -Only get email actions. +### -ConversationOnly +Only get actions that are part of agent to end user conversations. ```yaml Type: SwitchParameter -Parameter Sets: Single +Parameter Sets: Multi Aliases: Required: False @@ -114,12 +115,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludePrivate -Exclude private actions. +### -AgentOnly +Only get actions performed by agents. ```yaml Type: SwitchParameter -Parameter Sets: Multi +Parameter Sets: (All) Aliases: Required: False @@ -129,8 +130,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeSys -Exclude system-performed actions. +### -SupplierOnly +Only get actions that involve suppliers. ```yaml Type: SwitchParameter @@ -144,8 +145,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ImportantOnly -Only get important actions. +### -ExcludePrivate +Exclude private actions. ```yaml Type: SwitchParameter @@ -159,8 +160,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeAttachments -Include attachment details in the response. +### -IncludeHTMLNote +Include the action note HTML in the response. ```yaml Type: SwitchParameter @@ -174,12 +175,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDetails -Include extra detail objects. +### -IncludeHTMLEmail +Include the action email HTML in the response. ```yaml Type: SwitchParameter -Parameter Sets: Single +Parameter Sets: Multi Aliases: Required: False @@ -189,12 +190,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeEmail -Include the HTML and plain text email body in the response. +### -IncludeAttachments +Include attachment details in the response. ```yaml Type: SwitchParameter -Parameter Sets: Single +Parameter Sets: Multi Aliases: Required: False @@ -204,8 +205,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeHTMLEmail -Include the action email HTML in the response. +### -ImportantOnly +Only get important actions. ```yaml Type: SwitchParameter @@ -219,8 +220,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeHTMLNote -Include the action note HTML in the response. +### -SLAOnly +Only get SLA hold and release actions. ```yaml Type: SwitchParameter @@ -249,8 +250,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MostRecent -Ignore the '-ActionID' and get the most recent action for the '-TicketID' +### -IncludeEmail +Include the HTML and plain text email body in the response. ```yaml Type: SwitchParameter @@ -264,8 +265,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NonSystem -Exclude system-performed actions. +### -IncludeDetails +Include extra detail objects. ```yaml Type: SwitchParameter @@ -279,12 +280,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SLAOnly -Only get SLA hold and release actions. +### -MostRecent +Ignore the '-ActionID' and get the most recent action for the '-TicketID' ```yaml Type: SwitchParameter -Parameter Sets: Multi +Parameter Sets: Single Aliases: Required: False @@ -294,12 +295,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SupplierOnly -Only get actions that involve suppliers. +### -EmailOnly +Only get email actions. ```yaml Type: SwitchParameter -Parameter Sets: Multi +Parameter Sets: Single Aliases: Required: False @@ -309,19 +310,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TicketID -Get actions for a single ticket with the specified ID. -\[HaloPipelineIDArgumentTransformation()\] +### -NonSystem +Exclude system-performed actions. ```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: ticket_id +Type: SwitchParameter +Parameter Sets: Single +Aliases: -Required: True +Required: False Position: Named -Default value: 0 -Accept pipeline input: True (ByValue) +Default value: False +Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloAgent.md b/Docs/MarkDown/Get-HaloAgent.md index f1af518..8602e6e 100644 --- a/Docs/MarkDown/Get-HaloAgent.md +++ b/Docs/MarkDown/Get-HaloAgent.md @@ -16,7 +16,7 @@ Gets agents from the Halo API. ``` Get-HaloAgent [-Team ] [-Search ] [-SectionID ] [-DepartmentID ] [-ClientID ] [-Role ] [-IncludeEnabled] [-IncludeDisabled] [-IncludeUnassigned] [-IncludeRoles] - [] + [-ShowAll] [-IncludeAPIAgents] [-CanEditOnly] [-IncludeNamedCount] [] ``` ### Me @@ -43,6 +43,21 @@ PS C:\> {{ Add example code here }} ## PARAMETERS +### -Me +Get the agent object for the access token owner + +```yaml +Type: SwitchParameter +Parameter Sets: Me +Aliases: + +Required: True +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -AgentID Agent ID. @@ -58,13 +73,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ClientID -Filter by the specified client ID (agents who have access to this client). +### -Team +Filter by the specified team name. + +```yaml +Type: String +Parameter Sets: Multi +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Search +Filter by name, email address or telephone number using the specified search string. + +```yaml +Type: String +Parameter Sets: Multi +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SectionID +Filter by the specified team ID. +?ACT Query with Halo what this does! ```yaml Type: Int32 Parameter Sets: Multi -Aliases: client_id +Aliases: section_id Required: False Position: Named @@ -88,32 +134,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDetails -Include extra detail objects (for example teams and roles) in the response. +### -ClientID +Filter by the specified client ID (agents who have access to this client). ```yaml -Type: SwitchParameter -Parameter Sets: Single -Aliases: +Type: Int32 +Parameter Sets: Multi +Aliases: client_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDisabled -Include agents with disabled accounts. +### -Role +Filter by the specified role ID (requires int as string.) ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -133,8 +179,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeRoles -Include the agent's roles list in the response. +### -IncludeDisabled +Include agents with disabled accounts. ```yaml Type: SwitchParameter @@ -163,78 +209,92 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Me -Get the agent object for the access token owner +### -IncludeRoles +Include the agent's roles list in the response. ```yaml Type: SwitchParameter -Parameter Sets: Me +Parameter Sets: Multi Aliases: -Required: True +Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Role -Filter by the specified role ID (requires int as string.) +### -IncludeDetails +Include extra detail objects (for example teams and roles) in the response. ```yaml -Type: String +Type: SwitchParameter +Parameter Sets: Single +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowAll +Show all agents, including those that have been deleted. + +```yaml +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Search -Filter by name, email address or telephone number using the specified search string. +### -IncludeAPIAgents +Include API agents in the response. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -SectionID -Filter by the specified team ID. -?ACT Query with Halo what this does! +### -CanEditOnly +Show only agents the API user has permissions to edit. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: section_id +Aliases: can_edit_only Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Team -Filter by the specified team name. +### -IncludeNamedCount +Include counts of named license consumption in the response. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloAppointment.md b/Docs/MarkDown/Get-HaloAppointment.md index 9cd0470..fcedfa0 100644 --- a/Docs/MarkDown/Get-HaloAppointment.md +++ b/Docs/MarkDown/Get-HaloAppointment.md @@ -38,22 +38,6 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -Agents -Comma separated list of agent IDs. -Returns these agent's appointments - -```yaml -Type: String -Parameter Sets: Multi -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AppointmentID Appointment ID @@ -69,8 +53,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AppointmentsOnly -Only return appointments in the response +### -ShowAll +Admin override to return all appointments ```yaml Type: SwitchParameter @@ -84,13 +68,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EndDate -Return appointments with an end date greater than this value +### -StartDate +Return appointments with a start date greater than this value. ```yaml Type: String Parameter Sets: Multi -Aliases: end_date +Aliases: start_date Required: False Position: Named @@ -99,53 +83,54 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HideCompleted -Exclude completed appointments from the response +### -EndDate +Return appointments with an end date greater than this value ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi -Aliases: +Aliases: end_date Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDetails -Whether to include extra objects in the response +### -Agents +Comma separated list of agent IDs. +Returns these agent's appointments ```yaml -Type: SwitchParameter -Parameter Sets: Single +Type: String +Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Search -Return appointments like this search string +### -ShowHolidays +Include the appointment type 'holiday' in the response ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowAll -Admin override to return all appointments +### -ShowProjects +Include projects in the response ```yaml Type: SwitchParameter @@ -159,8 +144,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowAppointments -Include appointments in the response +### -ShowChanges +Include change requests in the response ```yaml Type: SwitchParameter @@ -174,8 +159,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowChanges -Include change requests in the response +### -ShowAppointments +Include appointments in the response ```yaml Type: SwitchParameter @@ -189,23 +174,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowHolidays -Include the appointment type 'holiday' in the response +### -Search +Return appointments like this search string ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowProjects -Include projects in the response +### -AppointmentsOnly +Only return appointments in the response ```yaml Type: SwitchParameter @@ -219,23 +204,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StartDate -Return appointments with a start date greater than this value. +### -TasksOnly +Only return tasks in the response ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi -Aliases: start_date +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -TasksOnly -Only return tasks in the response +### -HideCompleted +Exclude completed appointments from the response ```yaml Type: SwitchParameter @@ -264,6 +249,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IncludeDetails +Whether to include extra objects in the response + +```yaml +Type: SwitchParameter +Parameter Sets: Single +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Get-HaloAsset.md b/Docs/MarkDown/Get-HaloAsset.md index 83a971a..75cd35c 100644 --- a/Docs/MarkDown/Get-HaloAsset.md +++ b/Docs/MarkDown/Get-HaloAsset.md @@ -39,21 +39,6 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -AssetGroupID -Filter by Assets belonging to a particular Asset group - -```yaml -Type: Int64 -Parameter Sets: Multi -Aliases: assetgroup_id - -Required: False -Position: Named -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AssetID Asset ID @@ -69,43 +54,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AssetTypeID -Filter by Assets belonging to a particular Asset type +### -Paginate +Paginate results ```yaml -Type: Int64 +Type: SwitchParameter Parameter Sets: Multi -Aliases: assettype_id +Aliases: pageinate Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ClientID -Filter by Assets belonging to a particular client +### -PageSize +Number of results per page. ```yaml -Type: Int64 +Type: Int32 Parameter Sets: Multi -Aliases: client_id +Aliases: page_size Required: False Position: Named -Default value: 0 +Default value: $Script:HAPIDefaultPageSize Accept pipeline input: False Accept wildcard characters: False ``` -### -ContractID -Filter by Assets linked to a particular Asset +### -PageNo +Which page to return. ```yaml -Type: Int64 +Type: Int32 Parameter Sets: Multi -Aliases: contract_id +Aliases: page_no Required: False Position: Named @@ -114,23 +99,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FullObjects -Parameter to return the complete objects. +### -Order +Which field to order results based on. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -includeactive -Include active Assets in the response +### -OrderDesc +Order results in descending order (respects the field choice in '-Order') ```yaml Type: SwitchParameter @@ -144,118 +129,118 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -includechildren -Include child Assets in the response +### -Search +Filter by Assets with an asset field like your search ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDetails -Include extra objects in the result. +### -TicketID +Filter by Assets belonging to a particular ticket ```yaml -Type: SwitchParameter -Parameter Sets: Single -Aliases: +Type: Int64 +Parameter Sets: Multi +Aliases: ticket_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDiagramDetails -Include the last action in the result. +### -ClientID +Filter by Assets belonging to a particular client ```yaml -Type: SwitchParameter -Parameter Sets: Single -Aliases: +Type: Int64 +Parameter Sets: Multi +Aliases: client_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -includeinactive -Include inactive Assets in the response +### -SiteID +Filter by Assets belonging to a particular site ```yaml -Type: SwitchParameter +Type: Int64 Parameter Sets: Multi -Aliases: +Aliases: site_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -LinkedToID -Filter by Assets linked to a particular Asset +### -Username +Filter by Assets belonging to a particular user ```yaml -Type: Int64 +Type: String Parameter Sets: Multi -Aliases: linkedto_id +Aliases: Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Order -Which field to order results based on. +### -AssetGroupID +Filter by Assets belonging to a particular Asset group ```yaml -Type: String +Type: Int64 Parameter Sets: Multi -Aliases: +Aliases: assetgroup_id Required: False Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderDesc -Order results in descending order (respects the field choice in '-Order') +### -AssetTypeID +Filter by Assets belonging to a particular Asset type ```yaml -Type: SwitchParameter +Type: Int64 Parameter Sets: Multi -Aliases: +Aliases: assettype_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -PageNo -Which page to return. +### -LinkedToID +Filter by Assets linked to a particular Asset ```yaml -Type: Int32 +Type: Int64 Parameter Sets: Multi -Aliases: page_no +Aliases: linkedto_id Required: False Position: Named @@ -264,28 +249,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PageSize -Number of results per page. +### -includeinactive +Include inactive Assets in the response ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: page_size +Aliases: Required: False Position: Named -Default value: $Script:HAPIDefaultPageSize +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Paginate -Paginate results +### -includeactive +Include active Assets in the response ```yaml Type: SwitchParameter Parameter Sets: Multi -Aliases: pageinate +Aliases: Required: False Position: Named @@ -294,28 +279,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Search -Filter by Assets with an asset field like your search +### -includechildren +Include child Assets in the response ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -SiteID -Filter by Assets belonging to a particular site +### -ContractID +Filter by Assets linked to a particular Asset ```yaml Type: Int64 Parameter Sets: Multi -Aliases: site_id +Aliases: contract_id Required: False Position: Named @@ -324,32 +309,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TicketID -Filter by Assets belonging to a particular ticket +### -FullObjects +Parameter to return the complete objects. ```yaml -Type: Int64 +Type: SwitchParameter Parameter Sets: Multi -Aliases: ticket_id +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Username -Filter by Assets belonging to a particular user +### -IncludeDetails +Include extra objects in the result. ```yaml -Type: String -Parameter Sets: Multi +Type: SwitchParameter +Parameter Sets: Single Aliases: Required: False Position: Named -Default value: None +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDiagramDetails +Include the last action in the result. + +```yaml +Type: SwitchParameter +Parameter Sets: Single +Aliases: + +Required: False +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloAssetType.md b/Docs/MarkDown/Get-HaloAssetType.md new file mode 100644 index 0000000..70be141 --- /dev/null +++ b/Docs/MarkDown/Get-HaloAssetType.md @@ -0,0 +1,261 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# Get-HaloAssetType + +## SYNOPSIS +Gets asset types from the Halo API. + +## SYNTAX + +### Multi (Default) +``` +Get-HaloAssetType [-Paginate] [-PageSize ] [-PageNo ] [-Order ] [-OrderDesc] + [-Search ] [-AssetGroupID ] [-includeinactive] [-includeactive] [-FullObjects] [-ShowAll] + [] +``` + +### Single +``` +Get-HaloAssetType -AssetTypeID [-IncludeDetails] [-IncludeDiagramDetails] [] +``` + +## DESCRIPTION +Retrieves asset types from the Halo API - supports a variety of filtering parameters. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -AssetTypeID +Asset Type ID + +```yaml +Type: Int64 +Parameter Sets: Single +Aliases: + +Required: True +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Paginate +Paginate results + +```yaml +Type: SwitchParameter +Parameter Sets: Multi +Aliases: pageinate + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +Number of results per page. + +```yaml +Type: Int32 +Parameter Sets: Multi +Aliases: page_size + +Required: False +Position: Named +Default value: $Script:HAPIDefaultPageSize +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageNo +Which page to return. + +```yaml +Type: Int32 +Parameter Sets: Multi +Aliases: page_no + +Required: False +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Order +Which field to order results based on. + +```yaml +Type: String +Parameter Sets: Multi +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrderDesc +Order results in descending order (respects the field choice in '-Order') + +```yaml +Type: SwitchParameter +Parameter Sets: Multi +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Search +Filter by AssetTypes with an asset type group like your search + +```yaml +Type: String +Parameter Sets: Multi +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AssetGroupID +Filter by Asset Types belonging to a particular Asset group + +```yaml +Type: Int64 +Parameter Sets: Multi +Aliases: assetgroup_id + +Required: False +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -includeinactive +Include inactive Asset Types in the response + +```yaml +Type: SwitchParameter +Parameter Sets: Multi +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -includeactive +Include active Asset Types in the response + +```yaml +Type: SwitchParameter +Parameter Sets: Multi +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FullObjects +Parameter to return the complete objects. + +```yaml +Type: SwitchParameter +Parameter Sets: Multi +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDetails +Include extra objects in the result. + +```yaml +Type: SwitchParameter +Parameter Sets: Single +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDiagramDetails +Include the last action in the result. + +```yaml +Type: SwitchParameter +Parameter Sets: Single +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowAll +{{ Fill ShowAll Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Multi +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### A powershell object containing the response. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/Get-HaloAttachment.md b/Docs/MarkDown/Get-HaloAttachment.md index 04577f0..cac6afd 100644 --- a/Docs/MarkDown/Get-HaloAttachment.md +++ b/Docs/MarkDown/Get-HaloAttachment.md @@ -47,28 +47,28 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -ActionID -Returns attachments from the action ID specified (requires ticket_id) +### -AttachmentID +Attachment ID ```yaml Type: Int64 -Parameter Sets: Multi -Aliases: action_id +Parameter Sets: SinglePath, SingleFile, Single +Aliases: -Required: False +Required: True Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -AttachmentID -Attachment ID +### -TicketID +Returns attachments from the ticket ID specified ```yaml Type: Int64 -Parameter Sets: SinglePath, SingleFile, Single -Aliases: +Parameter Sets: Multi +Aliases: ticket_id Required: True Position: Named @@ -77,92 +77,92 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDetails -Include extra objects in the result. +### -ActionID +Returns attachments from the action ID specified (requires ticket_id) ```yaml -Type: SwitchParameter -Parameter Sets: Single -Aliases: +Type: Int64 +Parameter Sets: Multi +Aliases: action_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -OutFile -Allow Writing Directly to File, using the specified path and file name eg c:\temp\myfile.txt +### -Type +Returns attachments of the specified type ```yaml -Type: String -Parameter Sets: SingleFile +Type: Int64 +Parameter Sets: Multi Aliases: -Required: True +Required: False Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -OutPath -Allow Writing Directly to File, using the specified path and the original file name eg c:\temp\ +### -UniqueID +Returns an attachment with the unique ID specified ```yaml -Type: String -Parameter Sets: SinglePath -Aliases: +Type: Int64 +Parameter Sets: Multi +Aliases: unique_id -Required: True +Required: False Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -TicketID -Returns attachments from the ticket ID specified +### -IncludeDetails +Include extra objects in the result. ```yaml -Type: Int64 -Parameter Sets: Multi -Aliases: ticket_id +Type: SwitchParameter +Parameter Sets: Single +Aliases: -Required: True +Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -Returns attachments of the specified type +### -OutFile +Allow Writing Directly to File, using the specified path and file name eg c:\temp\myfile.txt ```yaml -Type: Int64 -Parameter Sets: Multi +Type: String +Parameter Sets: SingleFile Aliases: -Required: False +Required: True Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UniqueID -Returns an attachment with the unique ID specified +### -OutPath +Allow Writing Directly to File, using the specified path and the original file name eg c:\temp\ ```yaml -Type: Int64 -Parameter Sets: Multi -Aliases: unique_id +Type: String +Parameter Sets: SinglePath +Aliases: -Required: False +Required: True Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloAzureADConnection.md b/Docs/MarkDown/Get-HaloAzureADConnection.md new file mode 100644 index 0000000..57ef6c2 --- /dev/null +++ b/Docs/MarkDown/Get-HaloAzureADConnection.md @@ -0,0 +1,125 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# Get-HaloAzureADConnection + +## SYNOPSIS +Gets Azure AD Connection information from the Halo API. + +## SYNTAX + +### Multi (Default) +``` +Get-HaloAzureADConnection [-Type ] [-ShowAll ] [] +``` + +### Single +``` +Get-HaloAzureADConnection -AzureConnectionID [-Type ] [-IncludeDetails] [-IncludeTenants] + [] +``` + +## DESCRIPTION +Retrieves Azure AD Connection from the Halo API - supports a variety of filtering parameters. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -AzureConnectionID +Lookup Item ID + +```yaml +Type: Int64 +Parameter Sets: Single +Aliases: + +Required: True +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Type + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowAll +Show All + +```yaml +Type: String +Parameter Sets: Multi +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDetails +Include Details + +```yaml +Type: SwitchParameter +Parameter Sets: Single +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeTenants +Include Tenants + +```yaml +Type: SwitchParameter +Parameter Sets: Single +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### A powershell object containing the response. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/Get-HaloBillingTemplate.md b/Docs/MarkDown/Get-HaloBillingTemplate.md index 6ade0cd..0cbe51f 100644 --- a/Docs/MarkDown/Get-HaloBillingTemplate.md +++ b/Docs/MarkDown/Get-HaloBillingTemplate.md @@ -36,17 +36,17 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -IncludeDetails -Include details in results +### -TemplateID +Template ID ```yaml -Type: SwitchParameter +Type: Int64 Parameter Sets: Single Aliases: -Required: False +Required: True Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` @@ -66,17 +66,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TemplateID -Template ID +### -IncludeDetails +Include details in results ```yaml -Type: Int64 +Type: SwitchParameter Parameter Sets: Single Aliases: -Required: True +Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloCRMNote.md b/Docs/MarkDown/Get-HaloCRMNote.md index 1e0ad5d..4f097dd 100644 --- a/Docs/MarkDown/Get-HaloCRMNote.md +++ b/Docs/MarkDown/Get-HaloCRMNote.md @@ -39,19 +39,18 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -ClientID -Get CRM notes for a single client with the specified ID. -\[HaloPipelineIDArgumentTransformation()\] +### -CRMNoteID +CRM note ID. ```yaml -Type: Int32 -Parameter Sets: Multi -Aliases: client_id +Type: Int64 +Parameter Sets: Single +Aliases: Required: True Position: Named Default value: 0 -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -70,23 +69,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CRMNoteID -CRM note ID. +### -ClientID +Get CRM notes for a single client with the specified ID. +\[HaloPipelineIDArgumentTransformation()\] ```yaml -Type: Int64 -Parameter Sets: Single -Aliases: +Type: Int32 +Parameter Sets: Multi +Aliases: client_id Required: True Position: Named Default value: 0 -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -IncludeAttachments -Include attachment details in the response. +### -IncludeHTMLNote +Include the CRM note HTML in the response. ```yaml Type: SwitchParameter @@ -100,8 +100,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeHTMLNote -Include the CRM note HTML in the response. +### -IncludeAttachments +Include attachment details in the response. ```yaml Type: SwitchParameter diff --git a/Docs/MarkDown/Get-HaloCategory.md b/Docs/MarkDown/Get-HaloCategory.md index 8765845..117c2f5 100644 --- a/Docs/MarkDown/Get-HaloCategory.md +++ b/Docs/MarkDown/Get-HaloCategory.md @@ -51,32 +51,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowAll -Include Details +### -TypeID +Type ID ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi -Aliases: +Aliases: type_id Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TypeID -Type ID +### -ShowAll +Include Details ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi -Aliases: type_id +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloClient.md b/Docs/MarkDown/Get-HaloClient.md index 9fc7e1e..0aaabfe 100644 --- a/Docs/MarkDown/Get-HaloClient.md +++ b/Docs/MarkDown/Get-HaloClient.md @@ -53,72 +53,72 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Count -The number of clients to return if not using pagination. +### -Paginate +Paginate results ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: +Aliases: pageinate Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -FullObjects -Parameter to return the complete objects. +### -PageSize +Number of results per page. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: page_size Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeActive -Include active clients in the results. +### -PageNo +Which page to return. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: page_no Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeActivity -Include ticket activity in the result. +### -Order +Which field to order results based on. ```yaml -Type: SwitchParameter -Parameter Sets: Single +Type: String +Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDetails -Include extra objects in the result. +### -OrderDesc +Order results in descending order (respects the field choice in '-Order') ```yaml Type: SwitchParameter -Parameter Sets: Single +Parameter Sets: Multi Aliases: Required: False @@ -128,38 +128,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeInactive -Include inactive clients in the results. +### -Search +Return clients matching the search term in the results. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Order -Which field to order results based on. +### -TopLevelID +Filter by the specified top level ID. ```yaml -Type: String +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: toplevel_id Required: False Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderDesc -Order results in descending order (respects the field choice in '-Order') +### -IncludeActive +Include active clients in the results. ```yaml Type: SwitchParameter @@ -173,28 +173,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PageNo -Which page to return. +### -IncludeInactive +Include inactive clients in the results. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: page_no +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -PageSize -Number of results per page. +### -Count +The number of clients to return if not using pagination. ```yaml Type: Int32 Parameter Sets: Multi -Aliases: page_size +Aliases: Required: False Position: Named @@ -203,13 +203,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Paginate -Paginate results +### -FullObjects +Parameter to return the complete objects. ```yaml Type: SwitchParameter Parameter Sets: Multi -Aliases: pageinate +Aliases: Required: False Position: Named @@ -218,32 +218,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Search -Return clients matching the search term in the results. +### -IncludeDetails +Include extra objects in the result. ```yaml -Type: String -Parameter Sets: Multi +Type: SwitchParameter +Parameter Sets: Single Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -TopLevelID -Filter by the specified top level ID. +### -IncludeActivity +Include ticket activity in the result. ```yaml -Type: Int32 -Parameter Sets: Multi -Aliases: toplevel_id +Type: SwitchParameter +Parameter Sets: Single +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloContract.md b/Docs/MarkDown/Get-HaloContract.md index 8526232..a0946e5 100644 --- a/Docs/MarkDown/Get-HaloContract.md +++ b/Docs/MarkDown/Get-HaloContract.md @@ -37,21 +37,6 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -ClientID -Filter by the specified client ID. - -```yaml -Type: Int32 -Parameter Sets: Multi -Aliases: client_id - -Required: False -Position: Named -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ContractID Contract ID @@ -67,47 +52,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Count -The number of contracts to return if not using pagination. +### -Paginate +Paginate results ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: +Aliases: pageinate Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -FullObjects -Parameter to return the complete objects. +### -PageSize +Number of results per page. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: page_size Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -includeDetails -Include invoice Details +### -PageNo +Which page to return. ```yaml -Type: SwitchParameter -Parameter Sets: Single -Aliases: +Type: Int32 +Parameter Sets: Multi +Aliases: page_no Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` @@ -142,28 +127,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PageNo -Which page to return. +### -Search +Return contracts matching the search term in the results. ```yaml -Type: Int32 +Type: String Parameter Sets: Multi -Aliases: page_no +Aliases: Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PageSize -Number of results per page. +### -Count +The number of contracts to return if not using pagination. ```yaml Type: Int32 Parameter Sets: Multi -Aliases: page_size +Aliases: Required: False Position: Named @@ -172,13 +157,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Paginate -Paginate results +### -FullObjects +Parameter to return the complete objects. ```yaml Type: SwitchParameter Parameter Sets: Multi -Aliases: pageinate +Aliases: Required: False Position: Named @@ -187,17 +172,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Search -Return contracts matching the search term in the results. +### -includeDetails +Include invoice Details ```yaml -Type: String -Parameter Sets: Multi +Type: SwitchParameter +Parameter Sets: Single Aliases: Required: False Position: Named -Default value: None +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientID +Filter by the specified client ID. + +```yaml +Type: Int32 +Parameter Sets: Multi +Aliases: client_id + +Required: False +Position: Named +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloCustomButton.md b/Docs/MarkDown/Get-HaloCustomButton.md index dc72192..bbc4725 100644 --- a/Docs/MarkDown/Get-HaloCustomButton.md +++ b/Docs/MarkDown/Get-HaloCustomButton.md @@ -51,62 +51,62 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDetails -Include extra detail objects in the response. +### -Type +Filter by the specified type. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IsButtonSetup -Include custom buttons which are setup (defaults to $True). +### -TypeID +Filter by the specified type ID. ```yaml -Type: SwitchParameter +Type: Int64 Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -Filter by the specified type. +### -IsButtonSetup +Include custom buttons which are setup (defaults to $True). ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -TypeID -Filter by the specified type ID. +### -IncludeDetails +Include extra detail objects in the response. ```yaml -Type: Int64 -Parameter Sets: Multi +Type: SwitchParameter +Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloCustomField.md b/Docs/MarkDown/Get-HaloCustomField.md new file mode 100644 index 0000000..b9ec441 --- /dev/null +++ b/Docs/MarkDown/Get-HaloCustomField.md @@ -0,0 +1,170 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# Get-HaloCustomField + +## SYNOPSIS +Gets Custom Fields from the Halo API. + +## SYNTAX + +### Multi (Default) +``` +Get-HaloCustomField [-Count ] [-Paginate] [-PageSize ] [-PageNo ] [-Order ] + [-OrderDesc] [] +``` + +### Single +``` +Get-HaloCustomField -CustomFieldID [-IncludeDetails] [] +``` + +## DESCRIPTION +Retrieves Custom Fields from the Halo API - supports a variety of filtering parameters. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -CustomFieldID +Item ID + +```yaml +Type: Int64 +Parameter Sets: Single +Aliases: + +Required: True +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Count +Number of records to return + +```yaml +Type: Int64 +Parameter Sets: Multi +Aliases: + +Required: False +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Paginate +Paginate results + +```yaml +Type: SwitchParameter +Parameter Sets: Multi +Aliases: pageinate + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +Number of results per page. + +```yaml +Type: Int32 +Parameter Sets: Multi +Aliases: page_size + +Required: False +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageNo +Which page to return. + +```yaml +Type: Int32 +Parameter Sets: Multi +Aliases: page_no + +Required: False +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Order +The name of the first field to order by + +```yaml +Type: String +Parameter Sets: Multi +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrderDesc +Whether to order ascending or descending + +```yaml +Type: SwitchParameter +Parameter Sets: Multi +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDetails +Include extra objects in the result. + +```yaml +Type: SwitchParameter +Parameter Sets: Single +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### A powershell object containing the response. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/Get-HaloCustomTable.md b/Docs/MarkDown/Get-HaloCustomTable.md new file mode 100644 index 0000000..4b43fa5 --- /dev/null +++ b/Docs/MarkDown/Get-HaloCustomTable.md @@ -0,0 +1,64 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# Get-HaloCustomTable + +## SYNOPSIS +Gets custom tables from the Halo API. + +## SYNTAX + +### Multi (Default) +``` +Get-HaloCustomTable [] +``` + +### Single +``` +Get-HaloCustomTable -CustomTableId [] +``` + +## DESCRIPTION +Retrieves custom tables from the Halo API - supports a variety of filtering parameters. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -CustomTableId +Custom Table ID. + +```yaml +Type: Int64 +Parameter Sets: Single +Aliases: + +Required: True +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### A powershell object containing the response. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/Get-HaloFAQList.md b/Docs/MarkDown/Get-HaloFAQList.md index 8b6fc98..38eefb5 100644 --- a/Docs/MarkDown/Get-HaloFAQList.md +++ b/Docs/MarkDown/Get-HaloFAQList.md @@ -51,17 +51,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDetails -Include Details +### -Type +Type ```yaml -Type: SwitchParameter -Parameter Sets: Single +Type: String +Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -81,17 +81,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -Type +### -IncludeDetails +Include Details ```yaml -Type: String -Parameter Sets: Multi +Type: SwitchParameter +Parameter Sets: Single Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloField.md b/Docs/MarkDown/Get-HaloField.md index 5c8705c..5d5c950 100644 --- a/Docs/MarkDown/Get-HaloField.md +++ b/Docs/MarkDown/Get-HaloField.md @@ -51,32 +51,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDetails -Include Details +### -Kind +Kind ```yaml -Type: SwitchParameter -Parameter Sets: Multi +Type: String +Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Kind -Kind +### -IncludeDetails +Include Details ```yaml -Type: String -Parameter Sets: (All) +Type: SwitchParameter +Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloInvoice.md b/Docs/MarkDown/Get-HaloInvoice.md index f83a049..d64e38d 100644 --- a/Docs/MarkDown/Get-HaloInvoice.md +++ b/Docs/MarkDown/Get-HaloInvoice.md @@ -17,7 +17,7 @@ Gets invoices from the Halo API. Get-HaloInvoice [-Count ] [-Search ] [-Paginate] [-PageSize ] [-PageNo ] [-OrderBy ] [-OrderByDesc] [-OrderBy2 ] [-OrderByDesc2] [-OrderBy3 ] [-OrderByDesc3] [-OrderBy4 ] [-OrderByDesc4] [-OrderBy5 ] [-OrderByDesc5] [-TicketID ] - [-ClientID ] [-SiteID ] [-UserID ] [] + [-ClientID ] [-SiteID ] [-UserID ] [-PostedOnly] [-NotPostedOnly] [] ``` ### Single @@ -39,15 +39,15 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -ClientID -Filter by the specified client ID. +### -InvoiceID +Invoice ID ```yaml -Type: Int32 -Parameter Sets: Multi -Aliases: client_id +Type: Int64 +Parameter Sets: Single +Aliases: -Required: False +Required: True Position: Named Default value: 0 Accept pipeline input: False @@ -69,53 +69,68 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InvoiceID -Invoice ID +### -Search +Return contracts matching the search term in the results. ```yaml -Type: Int64 -Parameter Sets: Single +Type: String +Parameter Sets: Multi Aliases: -Required: True +Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderBy -First field to order the results by. +### -Paginate +Paginate results ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi -Aliases: +Aliases: pageinate Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderBy2 -Second field to order the results by. +### -PageSize +Number of results per page. ```yaml -Type: String +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: page_size Required: False Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderBy3 -Third field to order the results by. +### -PageNo +Which page to return. + +```yaml +Type: Int32 +Parameter Sets: Multi +Aliases: page_no + +Required: False +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrderBy +First field to order the results by. ```yaml Type: String @@ -129,23 +144,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderBy4 -Fourth field to order the results by. +### -OrderByDesc +Order results for the first field in descending order (respects the field choice in '-OrderBy') ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderBy5 -Fifth field to order the results by. +### -OrderBy2 +Second field to order the results by. ```yaml Type: String @@ -159,8 +174,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderByDesc -Order results for the first field in descending order (respects the field choice in '-OrderBy') +### -OrderByDesc2 +Order results for the second field in descending order (respects the field choice in '-OrderBy2') ```yaml Type: SwitchParameter @@ -174,17 +189,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderByDesc2 -Order results for the second field in descending order (respects the field choice in '-OrderBy2') +### -OrderBy3 +Third field to order the results by. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -204,23 +219,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderByDesc4 -Order results for the fourth field in descending order (respects the field choice in '-OrderBy4') +### -OrderBy4 +Fourth field to order the results by. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderByDesc5 -Order results for the fifth field in descending order (respects the field choice in '-OrderBy5') +### -OrderByDesc4 +Order results for the fourth field in descending order (respects the field choice in '-OrderBy4') ```yaml Type: SwitchParameter @@ -234,62 +249,62 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PageNo -Which page to return. +### -OrderBy5 +Fifth field to order the results by. ```yaml -Type: Int32 +Type: String Parameter Sets: Multi -Aliases: page_no +Aliases: Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PageSize -Number of results per page. +### -OrderByDesc5 +Order results for the fifth field in descending order (respects the field choice in '-OrderBy5') ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: page_size +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Paginate -Paginate results +### -TicketID +Filter by the specified ticket ID. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: pageinate +Aliases: ticket_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -Search -Return contracts matching the search term in the results. +### -ClientID +Filter by the specified client ID. ```yaml -Type: String +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: client_id Required: False Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` @@ -309,13 +324,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TicketID -Filter by the specified ticket ID. +### -UserID +Filter by the specified user ID. ```yaml Type: Int32 Parameter Sets: Multi -Aliases: ticket_id +Aliases: user_id Required: False Position: Named @@ -324,17 +339,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserID -Filter by the specified user ID. +### -PostedOnly +Filter for posted invoices only. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: user_id +Aliases: Required: False Position: Named -Default value: 0 +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NotPostedOnly +Filter for non-posted invoices only. + +```yaml +Type: SwitchParameter +Parameter Sets: Multi +Aliases: + +Required: False +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloItem.md b/Docs/MarkDown/Get-HaloItem.md index d0a7433..63b2770 100644 --- a/Docs/MarkDown/Get-HaloItem.md +++ b/Docs/MarkDown/Get-HaloItem.md @@ -38,98 +38,98 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -Count -Number of records to return +### -ItemID +Item ID ```yaml Type: Int64 -Parameter Sets: Multi +Parameter Sets: Single Aliases: -Required: False +Required: True Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDetails -Include extra objects in the result. +### -Count +Number of records to return ```yaml -Type: SwitchParameter -Parameter Sets: Single +Type: Int64 +Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -ItemID -Item ID +### -Search +Filters response based on the search string ```yaml -Type: Int64 -Parameter Sets: Single +Type: String +Parameter Sets: Multi Aliases: -Required: True +Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderBy -The name of the first field to order by +### -Paginate +Paginate results ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi -Aliases: +Aliases: pageinate Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderBy2 -The name of the second field to order by +### -PageSize +Number of results per page. ```yaml -Type: String +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: page_size Required: False Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderBy3 -The name of the third field to order by +### -PageNo +Which page to return. ```yaml -Type: String +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: page_no Required: False Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderBy4 -The name of the fourth field to order by +### -OrderBy +The name of the first field to order by ```yaml Type: String @@ -143,32 +143,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderBy5 -The name of the fifth field to order by +### -OrderByDesc +Whether to order ascending or descending ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderByDesc -Whether to order ascending or descending +### -OrderBy2 +The name of the second field to order by ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -188,22 +188,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderByDesc3 -Whether to order ascending or descending +### -OrderBy3 +The name of the third field to order by ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderByDesc4 +### -OrderByDesc3 Whether to order ascending or descending ```yaml @@ -218,58 +218,58 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderByDesc5 -Whether to order ascending or descending +### -OrderBy4 +The name of the fourth field to order by ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PageNo -Which page to return. +### -OrderByDesc4 +Whether to order ascending or descending ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: page_no +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -PageSize -Number of results per page. +### -OrderBy5 +The name of the fifth field to order by ```yaml -Type: Int32 +Type: String Parameter Sets: Multi -Aliases: page_size +Aliases: Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Paginate -Paginate results +### -OrderByDesc5 +Whether to order ascending or descending ```yaml Type: SwitchParameter Parameter Sets: Multi -Aliases: pageinate +Aliases: Required: False Position: Named @@ -278,17 +278,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Search -Filters response based on the search string +### -IncludeDetails +Include extra objects in the result. ```yaml -Type: String -Parameter Sets: Multi +Type: SwitchParameter +Parameter Sets: Single Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloKBArticle.md b/Docs/MarkDown/Get-HaloKBArticle.md index 9d1cdd2..8b07cf5 100644 --- a/Docs/MarkDown/Get-HaloKBArticle.md +++ b/Docs/MarkDown/Get-HaloKBArticle.md @@ -37,17 +37,17 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -AdvancedSearch -Advanced Search +### -KBArticleID +Article ID ```yaml -Type: String -Parameter Sets: Multi -Aliases: advanced_search +Type: Int64 +Parameter Sets: Single +Aliases: -Required: False +Required: True Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` @@ -67,62 +67,62 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDetails -Include extra objects in the result. +### -Search +Filters response based on the search string ```yaml -Type: SwitchParameter -Parameter Sets: Single +Type: String +Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -KBArticleID -Article ID +### -AdvancedSearch +Advanced Search ```yaml -Type: Int64 -Parameter Sets: Single -Aliases: +Type: String +Parameter Sets: Multi +Aliases: advanced_search -Required: True +Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Order -The name of the first field to order by +### -Paginate +Paginate results ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi -Aliases: +Aliases: pageinate Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderDesc -Whether to order ascending or descending +### -PageSize +Number of results per page. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: page_size Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` @@ -142,28 +142,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PageSize -Number of results per page. +### -Order +The name of the first field to order by ```yaml -Type: Int32 +Type: String Parameter Sets: Multi -Aliases: page_size +Aliases: Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Paginate -Paginate results +### -OrderDesc +Whether to order ascending or descending ```yaml Type: SwitchParameter Parameter Sets: Multi -Aliases: pageinate +Aliases: Required: False Position: Named @@ -172,17 +172,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Search -Filters response based on the search string +### -IncludeDetails +Include extra objects in the result. ```yaml -Type: String -Parameter Sets: Multi +Type: SwitchParameter +Parameter Sets: Single Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloLookup.md b/Docs/MarkDown/Get-HaloLookup.md index ebef9bf..62b22be 100644 --- a/Docs/MarkDown/Get-HaloLookup.md +++ b/Docs/MarkDown/Get-HaloLookup.md @@ -36,21 +36,6 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -ExcludeZero -Exclude default lookup options with ID 0. - -```yaml -Type: SwitchParameter -Parameter Sets: Multi -Aliases: exclude_zero - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ItemID Lookup Item ID @@ -111,6 +96,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ExcludeZero +Exclude default lookup options with ID 0. + +```yaml +Type: SwitchParameter +Parameter Sets: Multi +Aliases: exclude_zero + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Get-HaloNullObject.md b/Docs/MarkDown/Get-HaloNullObject.md new file mode 100644 index 0000000..a059c1f --- /dev/null +++ b/Docs/MarkDown/Get-HaloNullObject.md @@ -0,0 +1,58 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# Get-HaloNullObject + +## SYNOPSIS +Nulls all values of an object + +## SYNTAX + +``` +Get-HaloNullObject [-NullObject] [] +``` + +## DESCRIPTION +Provides an null object for use in provisioning items in the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -NullObject +{{ Fill NullObject Description }} + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### A powershell object containing the response. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/Get-HaloObjectTemplate.md b/Docs/MarkDown/Get-HaloObjectTemplate.md index d227593..e71a84a 100644 --- a/Docs/MarkDown/Get-HaloObjectTemplate.md +++ b/Docs/MarkDown/Get-HaloObjectTemplate.md @@ -30,32 +30,32 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -NullVariables -Return with null values +### -Type +Type of object to get template for ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -Required: False -Position: Named -Default value: False +Required: True +Position: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -Type of object to get template for +### -NullVariables +Return with null values ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) Aliases: -Required: True -Position: 1 -Default value: None +Required: False +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloOpportunity.md b/Docs/MarkDown/Get-HaloOpportunity.md index 6a7dbbc..5c391cb 100644 --- a/Docs/MarkDown/Get-HaloOpportunity.md +++ b/Docs/MarkDown/Get-HaloOpportunity.md @@ -51,43 +51,43 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -Agent -Filter by the specified array of agent IDs. +### -OpportunityID +Opportunity ID ```yaml -Type: Int32[] -Parameter Sets: Multi +Type: Int64 +Parameter Sets: Single Aliases: -Required: False +Required: True Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -AgentID -Filter by the specified agent. +### -Paginate +Paginate results ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: agent_id +Aliases: pageinate Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -AssetID -Filter by the specified asset. +### -PageSize +Number of results per page. ```yaml Type: Int32 Parameter Sets: Multi -Aliases: asset_id +Aliases: page_size Required: False Position: Named @@ -96,28 +96,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Category1 -Filter by the specified array of category 1 IDs. +### -PageNo +Which page to return. ```yaml -Type: Int32[] +Type: Int32 Parameter Sets: Multi -Aliases: category_1 +Aliases: page_no Required: False Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -Category2 -Filter by the specified array of category 2 IDs. +### -Order +Which field to order results based on. ```yaml -Type: Int32[] +Type: String Parameter Sets: Multi -Aliases: category_2 +Aliases: Required: False Position: Named @@ -126,43 +126,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Category3 -Filter by the specified array of category 3 IDs. +### -OrderDesc +Order results in descending order (respects the field choice in '-Order') ```yaml -Type: Int32[] +Type: SwitchParameter Parameter Sets: Multi -Aliases: category_3 +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Category4 -Filter by the specified array of category 4 IDs. +### -TicketIDOnly +Return only the 'ID' fields (Ticket ID, SLA ID, Status ID, Client ID, Client Name and Last Incoming Email date) ```yaml -Type: Int32[] -Parameter Sets: Multi -Aliases: category_4 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ClientID -Filter by the specified client. +### -ViewID +The ID of the filter profile to use to filter results. ```yaml Type: Int32 Parameter Sets: Multi -Aliases: client_id +Aliases: view_id Required: False Position: Named @@ -171,21 +171,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ClosedOnly -Return only closed tickets in the results. - -```yaml -Type: SwitchParameter -Parameter Sets: Multi -Aliases: closed_only - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ColumnsID The ID of the column profile to use to control data returned in the results. @@ -201,83 +186,83 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ContractID -Filter by the specified contract ID. +### -IncludeColumns +Include column details in the the results. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: contract_id +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -DateSearch -Which date field to search against. +### -IncludeSLAActionDate +Include SLA action date in the results. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -EndDate -End date for use with the '-datesearch' parameter. +### -IncludeSLATimer +Include SLA timer in the results. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeThese -Exclude the specified array of ticket IDs. +### -IncludeTimeTaken +Include time taken in the results. ```yaml -Type: Int32[] +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Flagged -Filter by the specified array of flagged ticket IDs. +### -IncludeSupplier +Include supplier details in the results. ```yaml -Type: Int32[] +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeChildIDs -Include child ticket IDs in the results. +### -IncludeRelease1 +Include release 1 details in the results. ```yaml Type: SwitchParameter @@ -291,8 +276,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeColumns -Include column details in the the results. +### -IncludeRelease2 +Include release 2 details in the results. ```yaml Type: SwitchParameter @@ -306,12 +291,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDetails -Include extra objects in the result. +### -IncludeRelease3 +Include release 3 details in the results. ```yaml Type: SwitchParameter -Parameter Sets: Single +Parameter Sets: Multi Aliases: Required: False @@ -321,12 +306,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeLastAction -Include the last action in the result. +### -IncludeChildIDs +Include child ticket IDs in the results. ```yaml Type: SwitchParameter -Parameter Sets: Single +Parameter Sets: Multi Aliases: Required: False @@ -351,118 +336,118 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeRelease1 -Include release 1 details in the results. +### -ListID +Filter by the specified list. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: list_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeRelease2 -Include release 2 details in the results. +### -AgentID +Filter by the specified agent. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: agent_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeRelease3 -Include release 3 details in the results. +### -StatusID +Filter by the specified status. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: status_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeSLAActionDate -Include SLA action date in the results. +### -RequestTypeID +Filter by the specified request type. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: requesttype_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeSLATimer -Include SLA timer in the results. +### -SupplierID +Filter by the specified supplier. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: supplier_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeSupplier -Include supplier details in the results. +### -ClientID +Filter by the specified client. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: client_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeTimeTaken -Include time taken in the results. +### -Site +Filter by the specified site. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -ITILRequestType -Filter by the specified array of ITIL request type IDs. +### -UserName +Filter by the specified user name. ```yaml -Type: Int32[] +Type: String Parameter Sets: Multi -Aliases: itil_requesttype +Aliases: Required: False Position: Named @@ -471,13 +456,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ITILRequestTypeID -Filter by the specified ITIL request type. +### -UserID +Filter by the specified user ID. ```yaml Type: Int32 Parameter Sets: Multi -Aliases: itil_requesttype_id +Aliases: user_id Required: False Position: Named @@ -486,13 +471,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ListID -Filter by the specified list. +### -ReleaseID +Filter by the specified release. ```yaml Type: Int32 Parameter Sets: Multi -Aliases: list_id +Aliases: release_id Required: False Position: Named @@ -501,58 +486,58 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OpenOnly -Return only open tickets in the results. +### -AssetID +Filter by the specified asset. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: open_only +Aliases: asset_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -OpportunityID -Opportunity ID +### -ITILRequestTypeID +Filter by the specified ITIL request type. ```yaml -Type: Int64 -Parameter Sets: Single -Aliases: +Type: Int32 +Parameter Sets: Multi +Aliases: itil_requesttype_id -Required: True +Required: False Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -Order -Which field to order results based on. +### -OpenOnly +Return only open tickets in the results. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi -Aliases: +Aliases: open_only Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderDesc -Order results in descending order (respects the field choice in '-Order') +### -ClosedOnly +Return only closed tickets in the results. ```yaml Type: SwitchParameter Parameter Sets: Multi -Aliases: +Aliases: closed_only Required: False Position: Named @@ -561,28 +546,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PageNo -Which page to return. +### -UnlinkedOnly +Return only unlinked tickets in the results. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: page_no +Aliases: unlinked_only Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -PageSize -Number of results per page. +### -ContractID +Filter by the specified contract ID. ```yaml Type: Int32 Parameter Sets: Multi -Aliases: page_size +Aliases: contract_id Required: False Position: Named @@ -591,13 +576,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Paginate -Paginate results +### -WithAttachments +Return only tickets with attachments in the results. ```yaml Type: SwitchParameter Parameter Sets: Multi -Aliases: pageinate +Aliases: Required: False Position: Named @@ -606,8 +591,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Priority -Filter by the specified array of priority IDs. +### -Team +Filter by the specified array of team IDs. + +```yaml +Type: Int32[] +Parameter Sets: Multi +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Agent +Filter by the specified array of agent IDs. ```yaml Type: Int32[] @@ -621,8 +621,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Products -Filter by the specified array of product IDs. +### -Status +Filter by the specified array of status IDs. ```yaml Type: Int32[] @@ -636,28 +636,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReleaseID -Filter by the specified release. +### -RequestType +Filter by the specified array of request type IDs. ```yaml -Type: Int32 +Type: Int32[] Parameter Sets: Multi -Aliases: release_id +Aliases: Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RequestType -Filter by the specified array of request type IDs. +### -ITILRequestType +Filter by the specified array of ITIL request type IDs. ```yaml Type: Int32[] Parameter Sets: Multi -Aliases: +Aliases: itil_requesttype Required: False Position: Named @@ -666,28 +666,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequestTypeID -Filter by the specified request type. +### -Category1 +Filter by the specified array of category 1 IDs. ```yaml -Type: Int32 +Type: Int32[] Parameter Sets: Multi -Aliases: requesttype_id +Aliases: category_1 Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Search -Return tickets matching the search term in the results. +### -Category2 +Filter by the specified array of category 2 IDs. ```yaml -Type: String +Type: Int32[] Parameter Sets: Multi -Aliases: +Aliases: category_2 Required: False Position: Named @@ -696,28 +696,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchActions -Include actions when searching. +### -Category3 +Filter by the specified array of category 3 IDs. ```yaml -Type: SwitchParameter +Type: Int32[] Parameter Sets: Multi -Aliases: +Aliases: category_3 Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchDetails -Return tickets where the details matches the search term. +### -Category4 +Filter by the specified array of category 4 IDs. ```yaml -Type: String +Type: Int32[] Parameter Sets: Multi -Aliases: search_details +Aliases: category_4 Required: False Position: Named @@ -726,13 +726,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchInventoryNumber -Return tickets where the asset tag matches the search term. +### -SLA +Filter by the specified array of SLA IDs. ```yaml -Type: String +Type: Int32[] Parameter Sets: Multi -Aliases: search_invenotry_number +Aliases: Required: False Position: Named @@ -741,13 +741,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchOppCompanyName -Return tickets where the opportunity company name matches the search term. +### -Priority +Filter by the specified array of priority IDs. ```yaml -Type: String +Type: Int32[] Parameter Sets: Multi -Aliases: search_oppcompanyname +Aliases: Required: False Position: Named @@ -756,13 +756,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchOppContactName -Return tickets where the opportunity contact name matches the search term. +### -Products +Filter by the specified array of product IDs. ```yaml -Type: String +Type: Int32[] Parameter Sets: Multi -Aliases: search_oppcontactname +Aliases: Required: False Position: Named @@ -771,13 +771,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchRelease1 -Return tickets where release 1 matches the search term. +### -Flagged +Filter by the specified array of flagged ticket IDs. ```yaml -Type: String +Type: Int32[] Parameter Sets: Multi -Aliases: search_release1 +Aliases: Required: False Position: Named @@ -786,13 +786,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchRelease2 -Return tickets where release 2 matches the search term. +### -ExcludeThese +Exclude the specified array of ticket IDs. ```yaml -Type: String +Type: Int32[] Parameter Sets: Multi -Aliases: search_release2 +Aliases: Required: False Position: Named @@ -801,13 +801,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchRelease3 -Return tickets where release 3 matches the search term. +### -Search +Return tickets matching the search term in the results. ```yaml Type: String Parameter Sets: Multi -Aliases: search_release3 +Aliases: Required: False Position: Named @@ -816,28 +816,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchReleaseNote -Return tickets where the release note matches the search term. +### -SearchActions +Include actions when searching. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi -Aliases: search_releasenote +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchReportedBy -Return tickets where the reported by matches the search term. +### -DateSearch +Which date field to search against. ```yaml Type: String Parameter Sets: Multi -Aliases: search_reportedby +Aliases: Required: False Position: Named @@ -846,13 +846,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchSummary -Return tickets where the summary matches the search term. +### -StartDate +Start date for use with the '-datesearch' parameter. ```yaml Type: String Parameter Sets: Multi -Aliases: search_summary +Aliases: Required: False Position: Named @@ -861,13 +861,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchUserName -Return tickets where the user name matches the search term. +### -EndDate +End date for use with the '-datesearch' parameter. ```yaml Type: String Parameter Sets: Multi -Aliases: search_user_name +Aliases: Required: False Position: Named @@ -876,13 +876,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchVersion -Return tickets where the software version matches the search term. +### -SearchUserName +Return tickets where the user name matches the search term. ```yaml Type: String Parameter Sets: Multi -Aliases: search_version +Aliases: search_user_name Required: False Position: Named @@ -891,28 +891,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Site -Filter by the specified site. +### -SearchSummary +Return tickets where the summary matches the search term. ```yaml -Type: Int32 +Type: String Parameter Sets: Multi -Aliases: +Aliases: search_summary Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SLA -Filter by the specified array of SLA IDs. +### -SearchDetails +Return tickets where the details matches the search term. ```yaml -Type: Int32[] +Type: String Parameter Sets: Multi -Aliases: +Aliases: search_details Required: False Position: Named @@ -921,13 +921,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StartDate -Start date for use with the '-datesearch' parameter. +### -SearchReportedBy +Return tickets where the reported by matches the search term. ```yaml Type: String Parameter Sets: Multi -Aliases: +Aliases: search_reportedby Required: False Position: Named @@ -936,13 +936,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Status -Filter by the specified array of status IDs. +### -SearchVersion +Return tickets where the software version matches the search term. ```yaml -Type: Int32[] +Type: String Parameter Sets: Multi -Aliases: +Aliases: search_version Required: False Position: Named @@ -951,43 +951,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StatusID -Filter by the specified status. +### -SearchRelease1 +Return tickets where release 1 matches the search term. ```yaml -Type: Int32 +Type: String Parameter Sets: Multi -Aliases: status_id +Aliases: search_release1 Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SupplierID -Filter by the specified supplier. +### -SearchRelease2 +Return tickets where release 2 matches the search term. ```yaml -Type: Int32 +Type: String Parameter Sets: Multi -Aliases: supplier_id +Aliases: search_release2 Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Team -Filter by the specified array of team IDs. +### -SearchRelease3 +Return tickets where release 3 matches the search term. ```yaml -Type: Int32[] +Type: String Parameter Sets: Multi -Aliases: +Aliases: search_release3 Required: False Position: Named @@ -996,58 +996,58 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TicketIDOnly -Return only the 'ID' fields (Ticket ID, SLA ID, Status ID, Client ID, Client Name and Last Incoming Email date) +### -SearchReleaseNote +Return tickets where the release note matches the search term. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: +Type: String +Parameter Sets: Multi +Aliases: search_releasenote Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UnlinkedOnly -Return only unlinked tickets in the results. +### -SearchInventoryNumber +Return tickets where the asset tag matches the search term. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi -Aliases: unlinked_only +Aliases: search_invenotry_number Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserID -Filter by the specified user ID. +### -SearchOppContactName +Return tickets where the opportunity contact name matches the search term. ```yaml -Type: Int32 +Type: String Parameter Sets: Multi -Aliases: user_id +Aliases: search_oppcontactname Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserName -Filter by the specified user name. +### -SearchOppCompanyName +Return tickets where the opportunity company name matches the search term. ```yaml Type: String Parameter Sets: Multi -Aliases: +Aliases: search_oppcompanyname Required: False Position: Named @@ -1056,27 +1056,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ViewID -The ID of the filter profile to use to filter results. +### -IncludeDetails +Include extra objects in the result. ```yaml -Type: Int32 -Parameter Sets: Multi -Aliases: view_id +Type: SwitchParameter +Parameter Sets: Single +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -WithAttachments -Return only tickets with attachments in the results. +### -IncludeLastAction +Include the last action in the result. ```yaml Type: SwitchParameter -Parameter Sets: Multi +Parameter Sets: Single Aliases: Required: False diff --git a/Docs/MarkDown/Get-HaloProject.md b/Docs/MarkDown/Get-HaloProject.md index ed1203f..5a7b359 100644 --- a/Docs/MarkDown/Get-HaloProject.md +++ b/Docs/MarkDown/Get-HaloProject.md @@ -50,43 +50,43 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -Agent -Filter by the specified array of agent IDs. +### -ProjectID +Project ID ```yaml -Type: Int32[] -Parameter Sets: Multi +Type: Int64 +Parameter Sets: Single Aliases: -Required: False +Required: True Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -AgentID -Filter by the specified agent. +### -Paginate +Paginate results ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: agent_id +Aliases: pageinate Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -AssetID -Filter by the specified asset. +### -PageSize +Number of results per page. ```yaml Type: Int32 Parameter Sets: Multi -Aliases: asset_id +Aliases: page_size Required: False Position: Named @@ -95,28 +95,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Category1 -Filter by the specified array of category 1 IDs. +### -PageNo +Which page to return. ```yaml -Type: Int32[] +Type: Int32 Parameter Sets: Multi -Aliases: category_1 +Aliases: page_no Required: False Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -Category2 -Filter by the specified array of category 2 IDs. +### -Order +Which field to order results based on. ```yaml -Type: Int32[] +Type: String Parameter Sets: Multi -Aliases: category_2 +Aliases: Required: False Position: Named @@ -125,43 +125,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Category3 -Filter by the specified array of category 3 IDs. +### -OrderDesc +Order results in descending order (respects the field choice in '-Order') ```yaml -Type: Int32[] +Type: SwitchParameter Parameter Sets: Multi -Aliases: category_3 +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Category4 -Filter by the specified array of category 4 IDs. +### -TicketIDOnly +Return only the 'ID' fields (Ticket ID, SLA ID, Status ID, Client ID, Client Name and Last Incoming Email date) ```yaml -Type: Int32[] -Parameter Sets: Multi -Aliases: category_4 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ClientID -Filter by the specified client. +### -ViewID +The ID of the filter profile to use to filter results. ```yaml Type: Int32 Parameter Sets: Multi -Aliases: client_id +Aliases: view_id Required: False Position: Named @@ -170,128 +170,128 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ClosedOnly -Return only closed tickets in the results. +### -ColumnsID +The ID of the column profile to use to control data returned in the results. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: closed_only +Aliases: columns_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -ColumnsID -The ID of the column profile to use to control data returned in the results. +### -IncludeColumns +Include column details in the the results. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: columns_id +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ContractID -Filter by the specified contract ID. +### -IncludeSLAActionDate +Include SLA action date in the results. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: contract_id +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -DateSearch -Which date field to search against. +### -IncludeSLATimer +Include SLA timer in the results. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -EndDate -End date for use with the '-datesearch' parameter. +### -IncludeTimeTaken +Include time taken in the results. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeThese -Exclude the specified array of ticket IDs. +### -IncludeSupplier +Include supplier details in the results. ```yaml -Type: Int32[] +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Flagged -Filter by the specified array of flagged ticket IDs. +### -IncludeRelease1 +Include release 1 details in the results. ```yaml -Type: Int32[] +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeAppointmentID -Include upcoming appointment ID in the response +### -IncludeRelease2 +Include release 2 details in the results. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeChildIDs -Include child ticket IDs in the results. +### -IncludeRelease3 +Include release 3 details in the results. ```yaml Type: SwitchParameter @@ -305,8 +305,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeColumns -Include column details in the the results. +### -IncludeChildIDs +Include child ticket IDs in the results. ```yaml Type: SwitchParameter @@ -320,12 +320,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDetails -Include extra objects in the result. +### -IncludeNextActivityDate +Include next activity date in the results. ```yaml Type: SwitchParameter -Parameter Sets: Single +Parameter Sets: Multi Aliases: Required: False @@ -335,163 +335,163 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeLastAction -Include the last action in the result. +### -ListID +Filter by the specified list. ```yaml -Type: SwitchParameter -Parameter Sets: Single -Aliases: +Type: Int32 +Parameter Sets: Multi +Aliases: list_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeNextActivityDate -Include next activity date in the results. +### -AgentID +Filter by the specified agent. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: agent_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeRelease1 -Include release 1 details in the results. +### -StatusID +Filter by the specified status. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: status_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeRelease2 -Include release 2 details in the results. +### -RequestTypeID +Filter by the specified request type. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: requesttype_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeRelease3 -Include release 3 details in the results. +### -SupplierID +Filter by the specified supplier. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: supplier_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeSLAActionDate -Include SLA action date in the results. +### -ClientID +Filter by the specified client. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: client_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeSLATimer -Include SLA timer in the results. +### -Site +Filter by the specified site. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeSupplier -Include supplier details in the results. +### -UserName +Filter by the specified user name. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeTimeTaken -Include time taken in the results. +### -UserID +Filter by the specified user ID. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: user_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -ITILRequestType -Filter by the specified array of ITIL request type IDs. +### -ReleaseID +Filter by the specified release. ```yaml -Type: Int32[] +Type: Int32 Parameter Sets: Multi -Aliases: itil_requesttype +Aliases: release_id Required: False Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -ITILRequestTypeID -Filter by the specified ITIL request type. +### -AssetID +Filter by the specified asset. ```yaml Type: Int32 Parameter Sets: Multi -Aliases: itil_requesttype_id +Aliases: asset_id Required: False Position: Named @@ -500,13 +500,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ListID -Filter by the specified list. +### -ITILRequestTypeID +Filter by the specified ITIL request type. ```yaml Type: Int32 Parameter Sets: Multi -Aliases: list_id +Aliases: itil_requesttype_id Required: False Position: Named @@ -530,28 +530,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Order -Which field to order results based on. +### -ClosedOnly +Return only closed tickets in the results. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi -Aliases: +Aliases: closed_only Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderDesc -Order results in descending order (respects the field choice in '-Order') +### -UnlinkedOnly +Return only unlinked tickets in the results. ```yaml Type: SwitchParameter Parameter Sets: Multi -Aliases: +Aliases: unlinked_only Required: False Position: Named @@ -560,13 +560,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PageNo -Which page to return. +### -ContractID +Filter by the specified contract ID. ```yaml Type: Int32 Parameter Sets: Multi -Aliases: page_no +Aliases: contract_id Required: False Position: Named @@ -575,38 +575,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PageSize -Number of results per page. +### -WithAttachments +Return only tickets with attachments in the results. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: page_size +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Paginate -Paginate results +### -Team +Filter by the specified array of team IDs. ```yaml -Type: SwitchParameter +Type: Int32[] Parameter Sets: Multi -Aliases: pageinate +Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Priority -Filter by the specified array of priority IDs. +### -Agent +Filter by the specified array of agent IDs. ```yaml Type: Int32[] @@ -620,8 +620,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Products -Filter by the specified array of product IDs. +### -Status +Filter by the specified array of status IDs. ```yaml Type: Int32[] @@ -635,43 +635,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProjectID -Project ID +### -RequestType +Filter by the specified array of request type IDs. ```yaml -Type: Int64 -Parameter Sets: Single +Type: Int32[] +Parameter Sets: Multi Aliases: -Required: True +Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ReleaseID -Filter by the specified release. +### -ITILRequestType +Filter by the specified array of ITIL request type IDs. ```yaml -Type: Int32 +Type: Int32[] Parameter Sets: Multi -Aliases: release_id +Aliases: itil_requesttype Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RequestType -Filter by the specified array of request type IDs. +### -Category1 +Filter by the specified array of category 1 IDs. ```yaml Type: Int32[] Parameter Sets: Multi -Aliases: +Aliases: category_1 Required: False Position: Named @@ -680,28 +680,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequestTypeID -Filter by the specified request type. +### -Category2 +Filter by the specified array of category 2 IDs. ```yaml -Type: Int32 +Type: Int32[] Parameter Sets: Multi -Aliases: requesttype_id +Aliases: category_2 Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Search -Return tickets matching the search term in the results. +### -Category3 +Filter by the specified array of category 3 IDs. ```yaml -Type: String +Type: Int32[] Parameter Sets: Multi -Aliases: +Aliases: category_3 Required: False Position: Named @@ -710,28 +710,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchActions -Include actions when searching. +### -Category4 +Filter by the specified array of category 4 IDs. ```yaml -Type: SwitchParameter +Type: Int32[] Parameter Sets: Multi -Aliases: +Aliases: category_4 Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchDetails -Return tickets where the details matches the search term. +### -SLA +Filter by the specified array of SLA IDs. ```yaml -Type: String +Type: Int32[] Parameter Sets: Multi -Aliases: search_details +Aliases: Required: False Position: Named @@ -740,13 +740,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchInventoryNumber -Return tickets where the asset tag matches the search term. +### -Priority +Filter by the specified array of priority IDs. ```yaml -Type: String +Type: Int32[] Parameter Sets: Multi -Aliases: search_invenotry_number +Aliases: Required: False Position: Named @@ -755,13 +755,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchOppCompanyName -Return tickets where the opportunity company name matches the search term. +### -Products +Filter by the specified array of product IDs. ```yaml -Type: String +Type: Int32[] Parameter Sets: Multi -Aliases: search_oppcompanyname +Aliases: Required: False Position: Named @@ -770,13 +770,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchOppContactName -Return tickets where the opportunity contact name matches the search term. +### -Flagged +Filter by the specified array of flagged ticket IDs. ```yaml -Type: String +Type: Int32[] Parameter Sets: Multi -Aliases: search_oppcontactname +Aliases: Required: False Position: Named @@ -785,13 +785,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchRelease1 -Return tickets where release 1 matches the search term. +### -ExcludeThese +Exclude the specified array of ticket IDs. ```yaml -Type: String +Type: Int32[] Parameter Sets: Multi -Aliases: search_release1 +Aliases: Required: False Position: Named @@ -800,13 +800,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchRelease2 -Return tickets where release 2 matches the search term. +### -Search +Return tickets matching the search term in the results. ```yaml Type: String Parameter Sets: Multi -Aliases: search_release2 +Aliases: Required: False Position: Named @@ -815,28 +815,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchRelease3 -Return tickets where release 3 matches the search term. +### -SearchActions +Include actions when searching. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi -Aliases: search_release3 +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchReleaseNote -Return tickets where the release note matches the search term. +### -DateSearch +Which date field to search against. ```yaml Type: String Parameter Sets: Multi -Aliases: search_releasenote +Aliases: Required: False Position: Named @@ -845,13 +845,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchReportedBy -Return tickets where the reported by matches the search term. +### -StartDate +Start date for use with the '-datesearch' parameter. ```yaml Type: String Parameter Sets: Multi -Aliases: search_reportedby +Aliases: Required: False Position: Named @@ -860,13 +860,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchSummary -Return tickets where the summary matches the search term. +### -EndDate +End date for use with the '-datesearch' parameter. ```yaml Type: String Parameter Sets: Multi -Aliases: search_summary +Aliases: Required: False Position: Named @@ -890,13 +890,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchVersion -Return tickets where the software version matches the search term. +### -SearchSummary +Return tickets where the summary matches the search term. ```yaml Type: String Parameter Sets: Multi -Aliases: search_version +Aliases: search_summary Required: False Position: Named @@ -905,28 +905,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Site -Filter by the specified site. +### -SearchDetails +Return tickets where the details matches the search term. ```yaml -Type: Int32 +Type: String Parameter Sets: Multi -Aliases: +Aliases: search_details Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SLA -Filter by the specified array of SLA IDs. +### -SearchReportedBy +Return tickets where the reported by matches the search term. ```yaml -Type: Int32[] +Type: String Parameter Sets: Multi -Aliases: +Aliases: search_reportedby Required: False Position: Named @@ -935,13 +935,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StartDate -Start date for use with the '-datesearch' parameter. +### -SearchVersion +Return tickets where the software version matches the search term. ```yaml Type: String Parameter Sets: Multi -Aliases: +Aliases: search_version Required: False Position: Named @@ -950,13 +950,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Status -Filter by the specified array of status IDs. +### -SearchRelease1 +Return tickets where release 1 matches the search term. ```yaml -Type: Int32[] +Type: String Parameter Sets: Multi -Aliases: +Aliases: search_release1 Required: False Position: Named @@ -965,43 +965,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StatusID -Filter by the specified status. +### -SearchRelease2 +Return tickets where release 2 matches the search term. ```yaml -Type: Int32 +Type: String Parameter Sets: Multi -Aliases: status_id +Aliases: search_release2 Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SupplierID -Filter by the specified supplier. +### -SearchRelease3 +Return tickets where release 3 matches the search term. ```yaml -Type: Int32 +Type: String Parameter Sets: Multi -Aliases: supplier_id +Aliases: search_release3 Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Team -Filter by the specified array of team IDs. +### -SearchReleaseNote +Return tickets where the release note matches the search term. ```yaml -Type: Int32[] +Type: String Parameter Sets: Multi -Aliases: +Aliases: search_releasenote Required: False Position: Named @@ -1010,53 +1010,53 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TicketIDOnly -Return only the 'ID' fields (Ticket ID, SLA ID, Status ID, Client ID, Client Name and Last Incoming Email date) +### -SearchInventoryNumber +Return tickets where the asset tag matches the search term. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: +Type: String +Parameter Sets: Multi +Aliases: search_invenotry_number Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UnlinkedOnly -Return only unlinked tickets in the results. +### -SearchOppContactName +Return tickets where the opportunity contact name matches the search term. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi -Aliases: unlinked_only +Aliases: search_oppcontactname Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserID -Filter by the specified user ID. +### -SearchOppCompanyName +Return tickets where the opportunity company name matches the search term. ```yaml -Type: Int32 +Type: String Parameter Sets: Multi -Aliases: user_id +Aliases: search_oppcompanyname Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserName -Filter by the specified user name. +### -IncludeAppointmentID +Include upcoming appointment ID in the response ```yaml Type: String @@ -1070,27 +1070,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ViewID -The ID of the filter profile to use to filter results. +### -IncludeDetails +Include extra objects in the result. ```yaml -Type: Int32 -Parameter Sets: Multi -Aliases: view_id +Type: SwitchParameter +Parameter Sets: Single +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -WithAttachments -Return only tickets with attachments in the results. +### -IncludeLastAction +Include the last action in the result. ```yaml Type: SwitchParameter -Parameter Sets: Multi +Parameter Sets: Single Aliases: Required: False diff --git a/Docs/MarkDown/Get-HaloPurchaseOrder.md b/Docs/MarkDown/Get-HaloPurchaseOrder.md index 59de311..981e3d0 100644 --- a/Docs/MarkDown/Get-HaloPurchaseOrder.md +++ b/Docs/MarkDown/Get-HaloPurchaseOrder.md @@ -38,58 +38,58 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -ClientID -Filters by the specified client +### -PurchaseOrderID +Purchase Order ID ```yaml Type: Int64 -Parameter Sets: Multi -Aliases: client_id +Parameter Sets: Single +Aliases: -Required: False +Required: True Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -Closed -Include closed purchase orders in the results. +### -Count +Number of records to return ```yaml -Type: SwitchParameter +Type: Int64 Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -Count -Number of records to return +### -Search +Filters response based on the search string ```yaml -Type: Int64 +Type: String Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeActive -Include active purchase orders in the results. +### -Paginate +Paginate results ```yaml Type: SwitchParameter Parameter Sets: Multi -Aliases: +Aliases: pageinate Required: False Position: Named @@ -98,38 +98,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeBillingInfo -Include billing details in the result. +### -PageSize +Number of results per page. ```yaml -Type: SwitchParameter -Parameter Sets: Single -Aliases: +Type: Int32 +Parameter Sets: Multi +Aliases: page_size Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDetails -Include extra objects in the result. +### -PageNo +Which page to return. ```yaml -Type: SwitchParameter -Parameter Sets: Single -Aliases: +Type: Int32 +Parameter Sets: Multi +Aliases: page_no Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeInactive -Include inactive purchase orders in the results. +### -Open +Include open purchase orders in the results. ```yaml Type: SwitchParameter @@ -143,8 +143,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Open -Include open purchase orders in the results. +### -Closed +Include closed purchase orders in the results. ```yaml Type: SwitchParameter @@ -158,23 +158,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Order -Which field to order results based on. +### -IncludeActive +Include active purchase orders in the results. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderDesc -Order results in descending order (respects the field choice in '-Order') +### -IncludeInactive +Include inactive purchase orders in the results. ```yaml Type: SwitchParameter @@ -188,92 +188,92 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PageNo -Which page to return. +### -Order +Which field to order results based on. ```yaml -Type: Int32 +Type: String Parameter Sets: Multi -Aliases: page_no +Aliases: Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PageSize -Number of results per page. +### -OrderDesc +Order results in descending order (respects the field choice in '-Order') ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: page_size +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Paginate -Paginate results +### -ClientID +Filters by the specified client ```yaml -Type: SwitchParameter +Type: Int64 Parameter Sets: Multi -Aliases: pageinate +Aliases: client_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -PurchaseOrderID -Purchase Order ID +### -SiteID +Filters by the specified site ```yaml Type: Int64 -Parameter Sets: Single -Aliases: +Parameter Sets: Multi +Aliases: site_id -Required: True +Required: False Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -Search -Filters response based on the search string +### -IncludeDetails +Include extra objects in the result. ```yaml -Type: String -Parameter Sets: Multi +Type: SwitchParameter +Parameter Sets: Single Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -SiteID -Filters by the specified site +### -IncludeBillingInfo +Include billing details in the result. ```yaml -Type: Int64 -Parameter Sets: Multi -Aliases: site_id +Type: SwitchParameter +Parameter Sets: Single +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloQuote.md b/Docs/MarkDown/Get-HaloQuote.md index f32cbbe..4c88c6d 100644 --- a/Docs/MarkDown/Get-HaloQuote.md +++ b/Docs/MarkDown/Get-HaloQuote.md @@ -39,15 +39,15 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -ClientID -Filters by the specified client +### -QuoteID +Quote ID ```yaml Type: Int64 -Parameter Sets: Multi -Aliases: client_id +Parameter Sets: Single +Aliases: -Required: False +Required: True Position: Named Default value: 0 Accept pipeline input: False @@ -69,68 +69,68 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDetails -Include extra objects in the result. +### -Search +Filters response based on the search string ```yaml -Type: SwitchParameter -Parameter Sets: Single +Type: String +Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderBy -The name of the first field to order by +### -Paginate +Paginate results ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi -Aliases: +Aliases: pageinate Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderBy2 -The name of the second field to order by +### -PageSize +Number of results per page. ```yaml -Type: String +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: page_size Required: False Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderBy3 -The name of the third field to order by +### -PageNo +Which page to return. ```yaml -Type: String +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: page_no Required: False Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderBy4 -The name of the fourth field to order by +### -OrderBy +The name of the first field to order by ```yaml Type: String @@ -144,32 +144,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderBy5 -The name of the fifth field to order by +### -OrderByDesc +Whether to order ascending or descending ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderByDesc -Whether to order ascending or descending +### -OrderBy2 +The name of the second field to order by ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -189,22 +189,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderByDesc3 -Whether to order ascending or descending +### -OrderBy3 +The name of the third field to order by ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderByDesc4 +### -OrderByDesc3 Whether to order ascending or descending ```yaml @@ -219,58 +219,58 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderByDesc5 -Whether to order ascending or descending +### -OrderBy4 +The name of the fourth field to order by ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PageNo -Which page to return. +### -OrderByDesc4 +Whether to order ascending or descending ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: page_no +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -PageSize -Number of results per page. +### -OrderBy5 +The name of the fifth field to order by ```yaml -Type: Int32 +Type: String Parameter Sets: Multi -Aliases: page_size +Aliases: Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Paginate -Paginate results +### -OrderByDesc5 +Whether to order ascending or descending ```yaml Type: SwitchParameter Parameter Sets: Multi -Aliases: pageinate +Aliases: Required: False Position: Named @@ -279,32 +279,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -QuoteID -Quote ID +### -TicketID +Filters by the specified ticket ```yaml Type: Int64 -Parameter Sets: Single -Aliases: +Parameter Sets: Multi +Aliases: ticket_id -Required: True +Required: False Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -Search -Filters response based on the search string +### -ClientID +Filters by the specified client ```yaml -Type: String +Type: Int64 Parameter Sets: Multi -Aliases: +Aliases: client_id Required: False Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` @@ -324,13 +324,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TicketID -Filters by the specified ticket +### -UserID +Filters by the specified user ```yaml Type: Int64 Parameter Sets: Multi -Aliases: ticket_id +Aliases: user_id Required: False Position: Named @@ -339,17 +339,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserID -Filters by the specified user +### -IncludeDetails +Include extra objects in the result. ```yaml -Type: Int64 -Parameter Sets: Multi -Aliases: user_id +Type: SwitchParameter +Parameter Sets: Single +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloRecurringInvoice.md b/Docs/MarkDown/Get-HaloRecurringInvoice.md index abc9b10..4998ca2 100644 --- a/Docs/MarkDown/Get-HaloRecurringInvoice.md +++ b/Docs/MarkDown/Get-HaloRecurringInvoice.md @@ -40,15 +40,15 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -ClientID -Filter by the specified client ID. +### -RecurringInvoiceID +Invoice ID ```yaml -Type: Int32 -Parameter Sets: Multi -Aliases: client_id +Type: Int64 +Parameter Sets: Single +Aliases: -Required: False +Required: True Position: Named Default value: 0 Accept pipeline input: False @@ -70,28 +70,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FullObjects -Parameter to return the complete objects. +### -Search +Return contracts matching the search term in the results. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -includecredits -Include credit notes +### -Paginate +Paginate results ```yaml Type: SwitchParameter Parameter Sets: Multi -Aliases: +Aliases: pageinate Required: False Position: Named @@ -100,53 +100,53 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -includeDetails -Include invoice Details +### -PageSize +Number of results per page. ```yaml -Type: SwitchParameter -Parameter Sets: Single -Aliases: +Type: Int32 +Parameter Sets: Multi +Aliases: page_size Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -includeinactive -Include inactive records +### -PageNo +Which page to return. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: page_no Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -includeinvoices -Include invoices +### -OrderBy +First field to order the results by. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -includeLines -Include invoice lines +### -OrderByDesc +Order results for the first field in descending order (respects the field choice in '-OrderBy') ```yaml Type: SwitchParameter @@ -160,8 +160,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderBy -First field to order the results by. +### -OrderBy2 +Second field to order the results by. ```yaml Type: String @@ -175,17 +175,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderBy2 -Second field to order the results by. +### -OrderByDesc2 +Order results for the second field in descending order (respects the field choice in '-OrderBy2') ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -205,23 +205,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderBy4 -Fourth field to order the results by. +### -OrderByDesc3 +Order results for the third field in descending order (respects the field choice in '-OrderBy3') ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderBy5 -Fifth field to order the results by. +### -OrderBy4 +Fourth field to order the results by. ```yaml Type: String @@ -235,8 +235,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderByDesc -Order results for the first field in descending order (respects the field choice in '-OrderBy') +### -OrderByDesc4 +Order results for the fourth field in descending order (respects the field choice in '-OrderBy4') ```yaml Type: SwitchParameter @@ -250,23 +250,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderByDesc2 -Order results for the second field in descending order (respects the field choice in '-OrderBy2') +### -OrderBy5 +Fifth field to order the results by. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderByDesc3 -Order results for the third field in descending order (respects the field choice in '-OrderBy3') +### -OrderByDesc5 +Order results for the fifth field in descending order (respects the field choice in '-OrderBy5') ```yaml Type: SwitchParameter @@ -280,8 +280,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderByDesc4 -Order results for the fourth field in descending order (respects the field choice in '-OrderBy4') +### -includeinactive +Include inactive records ```yaml Type: SwitchParameter @@ -295,8 +295,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderByDesc5 -Order results for the fifth field in descending order (respects the field choice in '-OrderBy5') +### -includeinvoices +Include invoices ```yaml Type: SwitchParameter @@ -310,43 +310,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PageNo -Which page to return. +### -includecredits +Include credit notes ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: page_no +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -PageSize -Number of results per page. +### -includeLines +Include invoice lines ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: page_size +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Paginate -Paginate results +### -includeDetails +Include invoice Details ```yaml Type: SwitchParameter -Parameter Sets: Multi -Aliases: pageinate +Parameter Sets: Single +Aliases: Required: False Position: Named @@ -355,32 +355,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RecurringInvoiceID -Invoice ID +### -TicketID +Filter by the specified ticket ID. ```yaml -Type: Int64 -Parameter Sets: Single -Aliases: +Type: Int32 +Parameter Sets: Multi +Aliases: ticket_id -Required: True +Required: False Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -Search -Return contracts matching the search term in the results. +### -ClientID +Filter by the specified client ID. ```yaml -Type: String +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: client_id Required: False Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` @@ -400,13 +400,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TicketID -Filter by the specified ticket ID. +### -UserID +Filter by the specified user ID. ```yaml Type: Int32 Parameter Sets: Multi -Aliases: ticket_id +Aliases: user_id Required: False Position: Named @@ -415,17 +415,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserID -Filter by the specified user ID. +### -FullObjects +Parameter to return the complete objects. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: user_id +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloRelease.md b/Docs/MarkDown/Get-HaloRelease.md index 6882a48..33ebebe 100644 --- a/Docs/MarkDown/Get-HaloRelease.md +++ b/Docs/MarkDown/Get-HaloRelease.md @@ -37,77 +37,77 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -Count -Number of records to return +### -ReleaseID +Software Release ID ```yaml Type: Int64 -Parameter Sets: Multi +Parameter Sets: Single Aliases: -Required: False +Required: True Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDetails -Include extra objects in the result. +### -Count +Number of records to return ```yaml -Type: SwitchParameter -Parameter Sets: Single +Type: Int64 +Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeNoteCount -Include release note count in the result. +### -Search +Filters response based on the search string ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Order -Which field to order results based on. +### -Paginate +Paginate results ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi -Aliases: +Aliases: pageinate Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderDesc -Order results in descending order (respects the field choice in '-Order') +### -PageSize +Number of results per page. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: page_size Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` @@ -127,28 +127,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PageSize -Number of results per page. +### -Order +Which field to order results based on. ```yaml -Type: Int32 +Type: String Parameter Sets: Multi -Aliases: page_size +Aliases: Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Paginate -Paginate results +### -OrderDesc +Order results in descending order (respects the field choice in '-Order') ```yaml Type: SwitchParameter Parameter Sets: Multi -Aliases: pageinate +Aliases: Required: False Position: Named @@ -157,47 +157,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProductID -Filter by specified product ID. +### -IncludeNoteCount +Include release note count in the result. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: product_id +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ReleaseID -Software Release ID +### -ProductID +Filter by specified product ID. ```yaml -Type: Int64 -Parameter Sets: Single -Aliases: +Type: Int32 +Parameter Sets: Multi +Aliases: product_id -Required: True +Required: False Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -Search -Filters response based on the search string +### -IncludeDetails +Include extra objects in the result. ```yaml -Type: String -Parameter Sets: Multi +Type: SwitchParameter +Parameter Sets: Single Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloReport.md b/Docs/MarkDown/Get-HaloReport.md index c514549..7f530ac 100644 --- a/Docs/MarkDown/Get-HaloReport.md +++ b/Docs/MarkDown/Get-HaloReport.md @@ -40,28 +40,28 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -ChartOnly -Whether to return only records for reports that include graphs +### -ReportID +Report ID ```yaml -Type: SwitchParameter -Parameter Sets: Multi +Type: Int64 +Parameter Sets: Single Aliases: -Required: False +Required: True Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -ClientID -Filters by the specified client +### -Count +Number of records to return ```yaml Type: Int64 Parameter Sets: Multi -Aliases: client_id +Aliases: Required: False Position: Named @@ -70,28 +70,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Count -Number of records to return +### -Search +Filters response based on the search string ```yaml -Type: Int64 +Type: String Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDetails -Include extra objects in the result. +### -Paginate +Paginate results ```yaml Type: SwitchParameter -Parameter Sets: Single -Aliases: +Parameter Sets: Multi +Aliases: pageinate Required: False Position: Named @@ -100,38 +100,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LoadReport -Whether to include the report data in the response +### -PageSize +Number of results per page. ```yaml -Type: SwitchParameter -Parameter Sets: Single -Aliases: +Type: Int32 +Parameter Sets: Multi +Aliases: page_size Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderBy -The name of the first field to order by +### -PageNo +Which page to return. ```yaml -Type: String +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: page_no Required: False Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderBy2 -The name of the second field to order by +### -OrderBy +The name of the first field to order by ```yaml Type: String @@ -145,23 +145,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderBy3 -The name of the third field to order by +### -OrderByDesc +Whether to order ascending or descending ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderBy4 -The name of the fourth field to order by +### -OrderBy2 +The name of the second field to order by ```yaml Type: String @@ -175,37 +175,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderBy5 -The name of the fifth field to order by +### -OrderByDesc2 +Whether to order ascending or descending ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderByDesc -Whether to order ascending or descending +### -OrderBy3 +The name of the third field to order by ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderByDesc2 +### -OrderByDesc3 Whether to order ascending or descending ```yaml @@ -220,17 +220,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderByDesc3 -Whether to order ascending or descending +### -OrderBy4 +The name of the fourth field to order by ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -250,43 +250,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderByDesc5 -Whether to order ascending or descending +### -OrderBy5 +The name of the fifth field to order by ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PageNo -Which page to return. +### -OrderByDesc5 +Whether to order ascending or descending ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: page_no +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -PageSize -Number of results per page. +### -TicketID +Filters by the specified ticket ```yaml -Type: Int32 +Type: Int64 Parameter Sets: Multi -Aliases: page_size +Aliases: ticket_id Required: False Position: Named @@ -295,28 +295,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Paginate -Paginate results +### -ClientID +Filters by the specified client ```yaml -Type: SwitchParameter +Type: Int64 Parameter Sets: Multi -Aliases: pageinate +Aliases: client_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -ReportGroupID -Filters by the specified report group +### -SiteID +Filters by the specified site ```yaml Type: Int64 Parameter Sets: Multi -Aliases: reportgroup_id +Aliases: site_id Required: False Position: Named @@ -325,77 +325,77 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReportID -Report ID +### -UserID +Filters by the specified user ```yaml Type: Int64 -Parameter Sets: Single -Aliases: +Parameter Sets: Multi +Aliases: user_id -Required: True +Required: False Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -Search -Filters response based on the search string +### -ReportGroupID +Filters by the specified report group ```yaml -Type: String +Type: Int64 Parameter Sets: Multi -Aliases: +Aliases: reportgroup_id Required: False Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -SiteID -Filters by the specified site +### -ChartOnly +Whether to return only records for reports that include graphs ```yaml -Type: Int64 +Type: SwitchParameter Parameter Sets: Multi -Aliases: site_id +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -TicketID -Filters by the specified ticket +### -IncludeDetails +Include extra objects in the result. ```yaml -Type: Int64 -Parameter Sets: Multi -Aliases: ticket_id +Type: SwitchParameter +Parameter Sets: Single +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -UserID -Filters by the specified user +### -LoadReport +Whether to include the report data in the response ```yaml -Type: Int64 -Parameter Sets: Multi -Aliases: user_id +Type: SwitchParameter +Parameter Sets: Single +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloSalesOrder.md b/Docs/MarkDown/Get-HaloSalesOrder.md index eed452e..b860074 100644 --- a/Docs/MarkDown/Get-HaloSalesOrder.md +++ b/Docs/MarkDown/Get-HaloSalesOrder.md @@ -38,58 +38,58 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -ClientID -Filters by the specified client +### -SalesOrderID +Sales Order ID ```yaml Type: Int64 -Parameter Sets: Multi -Aliases: client_id +Parameter Sets: Single +Aliases: -Required: False +Required: True Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -Closed -Include closed sales orders in the results. +### -Count +Number of records to return ```yaml -Type: SwitchParameter +Type: Int64 Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -Count -Number of records to return +### -Search +Filters response based on the search string ```yaml -Type: Int64 +Type: String Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeActive -Include active sales orders in the results. +### -Paginate +Paginate results ```yaml Type: SwitchParameter Parameter Sets: Multi -Aliases: +Aliases: pageinate Required: False Position: Named @@ -98,38 +98,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeBillingInfo -Include billing details in the result. +### -PageSize +Number of results per page. ```yaml -Type: SwitchParameter -Parameter Sets: Single -Aliases: +Type: Int32 +Parameter Sets: Multi +Aliases: page_size Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDetails -Include extra objects in the result. +### -PageNo +Which page to return. ```yaml -Type: SwitchParameter -Parameter Sets: Single -Aliases: +Type: Int32 +Parameter Sets: Multi +Aliases: page_no Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeInactive -Include inactive sales orders in the results. +### -Open +Include open sales orders in the results. ```yaml Type: SwitchParameter @@ -143,8 +143,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NeedsOrdering -Include sales orders which require ordering in the results. +### -Closed +Include closed sales orders in the results. ```yaml Type: SwitchParameter @@ -158,8 +158,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Open -Include open sales orders in the results. +### -NeedsOrdering +Include sales orders which require ordering in the results. ```yaml Type: SwitchParameter @@ -173,23 +173,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Order -Which field to order results based on. +### -IncludeActive +Include active sales orders in the results. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderDesc -Order results in descending order (respects the field choice in '-Order') +### -IncludeInactive +Include inactive sales orders in the results. ```yaml Type: SwitchParameter @@ -203,92 +203,92 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PageNo -Which page to return. +### -Order +Which field to order results based on. ```yaml -Type: Int32 +Type: String Parameter Sets: Multi -Aliases: page_no +Aliases: Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PageSize -Number of results per page. +### -OrderDesc +Order results in descending order (respects the field choice in '-Order') ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: page_size +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Paginate -Paginate results +### -ClientID +Filters by the specified client ```yaml -Type: SwitchParameter +Type: Int64 Parameter Sets: Multi -Aliases: pageinate +Aliases: client_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -SalesOrderID -Sales Order ID +### -SiteID +Filters by the specified site ```yaml Type: Int64 -Parameter Sets: Single -Aliases: +Parameter Sets: Multi +Aliases: site_id -Required: True +Required: False Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -Search -Filters response based on the search string +### -IncludeDetails +Include extra objects in the result. ```yaml -Type: String -Parameter Sets: Multi +Type: SwitchParameter +Parameter Sets: Single Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -SiteID -Filters by the specified site +### -IncludeBillingInfo +Include billing details in the result. ```yaml -Type: Int64 -Parameter Sets: Multi -Aliases: site_id +Type: SwitchParameter +Parameter Sets: Single +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloService.md b/Docs/MarkDown/Get-HaloService.md index 0e4ea9c..c237f3f 100644 --- a/Docs/MarkDown/Get-HaloService.md +++ b/Docs/MarkDown/Get-HaloService.md @@ -38,148 +38,148 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -Count -Number of records to return +### -ServiceID +Service ID ```yaml Type: Int64 -Parameter Sets: Multi +Parameter Sets: Single Aliases: -Required: False +Required: True Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDetails -Include extra objects in the result. +### -Count +Number of records to return ```yaml -Type: SwitchParameter -Parameter Sets: Single +Type: Int64 +Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeStatusInfo -Include service status information in the result. +### -Search +Filters response based on the search string ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ITILTicketType -Filters by the specified ITIL ticket type ID. +### -Paginate +Paginate results ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: itil_ticket_type +Aliases: pageinate Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Order -Which field to order results based on. +### -PageSize +Number of results per page. ```yaml -Type: String +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: page_size Required: False Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderDesc -Order results in descending order (respects the field choice in '-Order') +### -PageNo +Which page to return. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: page_no Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -PageNo -Which page to return. +### -Order +Which field to order results based on. ```yaml -Type: Int32 +Type: String Parameter Sets: Multi -Aliases: page_no +Aliases: Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PageSize -Number of results per page. +### -OrderDesc +Order results in descending order (respects the field choice in '-Order') ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: page_size +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Paginate -Paginate results +### -UserID +Filters by services accessible to the specified user. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: pageinate +Aliases: user_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -Search -Filters response based on the search string +### -ServiceStatusIDs +Filters by the specified array of operational status IDs. ```yaml -Type: String +Type: Int32[] Parameter Sets: Multi -Aliases: +Aliases: service_status_ids Required: False Position: Named @@ -218,47 +218,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ServiceID -Service ID +### -ITILTicketType +Filters by the specified ITIL ticket type ID. ```yaml -Type: Int64 -Parameter Sets: Single -Aliases: +Type: Int32 +Parameter Sets: Multi +Aliases: itil_ticket_type -Required: True +Required: False Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -ServiceStatusIDs -Filters by the specified array of operational status IDs. +### -IncludeStatusInfo +Include service status information in the result. ```yaml -Type: Int32[] +Type: SwitchParameter Parameter Sets: Multi -Aliases: service_status_ids +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -UserID -Filters by services accessible to the specified user. +### -IncludeDetails +Include extra objects in the result. ```yaml -Type: Int32 -Parameter Sets: Multi -Aliases: user_id +Type: SwitchParameter +Parameter Sets: Single +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloSite.md b/Docs/MarkDown/Get-HaloSite.md index 266e0c2..9f7cd11 100644 --- a/Docs/MarkDown/Get-HaloSite.md +++ b/Docs/MarkDown/Get-HaloSite.md @@ -38,43 +38,28 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -ClientID -Filter by the specified client ID. - -```yaml -Type: Int32 -Parameter Sets: Multi -Aliases: client_id - -Required: False -Position: Named -Default value: 0 -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Count -The number of sites to return if not using pagination. +### -SiteID +Site ID ```yaml -Type: Int32 -Parameter Sets: Multi +Type: Int64 +Parameter Sets: Single Aliases: -Required: False +Required: True Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -FullObjects -Parameter to return the complete objects. +### -Paginate +Paginate results ```yaml Type: SwitchParameter Parameter Sets: Multi -Aliases: +Aliases: pageinate Required: False Position: Named @@ -83,32 +68,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeActive -Include active sites in the results. +### -PageSize +Number of results per page. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: page_size Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeInactive -Include inactive sites in the results. +### -PageNo +Which page to return. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: page_no Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` @@ -143,13 +128,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PageNo -Which page to return. +### -Search +Return contracts matching the search term in the results. + +```yaml +Type: String +Parameter Sets: Multi +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TopLevelID +Filter by the specified top level ID. ```yaml Type: Int32 Parameter Sets: Multi -Aliases: page_no +Aliases: toplevel_id Required: False Position: Named @@ -158,13 +158,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PageSize -Number of results per page. +### -ClientID +Filter by the specified client ID. ```yaml Type: Int32 Parameter Sets: Multi -Aliases: page_size +Aliases: client_id Required: False Position: Named @@ -173,13 +173,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Paginate -Paginate results +### -IncludeInactive +Include inactive sites in the results. ```yaml Type: SwitchParameter Parameter Sets: Multi -Aliases: pageinate +Aliases: Required: False Position: Named @@ -188,47 +188,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Search -Return contracts matching the search term in the results. +### -IncludeActive +Include active sites in the results. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -SiteID -Site ID +### -Count +The number of sites to return if not using pagination. ```yaml -Type: Int64 -Parameter Sets: Single +Type: Int32 +Parameter Sets: Multi Aliases: -Required: True +Required: False Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -TopLevelID -Filter by the specified top level ID. +### -FullObjects +Parameter to return the complete objects. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: toplevel_id +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloSoftwareLicence.md b/Docs/MarkDown/Get-HaloSoftwareLicence.md new file mode 100644 index 0000000..51e9218 --- /dev/null +++ b/Docs/MarkDown/Get-HaloSoftwareLicence.md @@ -0,0 +1,197 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# Get-HaloSoftwareLicence + +## SYNOPSIS +Gets software Licences from the Halo API. + +## SYNTAX + +### Multi (Default) +``` +Get-HaloSoftwareLicence [-ClientID ] [-Count ] [-Paginate] [-PageSize ] [-PageNo ] + [-Order ] [-OrderDesc] [] +``` + +### Single +``` +Get-HaloSoftwareLicence -LicenceID -ClientID [-IncludeDetails] [] +``` + +## DESCRIPTION +Retrieves software Licences from the Halo API - supports a variety of filtering parameters. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -LicenceID +Item ID + +```yaml +Type: Int64 +Parameter Sets: Single +Aliases: + +Required: True +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientID +Item ID + +```yaml +Type: Int64 +Parameter Sets: Multi +Aliases: client_id + +Required: False +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +```yaml +Type: Int64 +Parameter Sets: Single +Aliases: client_id + +Required: True +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Count +Number of records to return + +```yaml +Type: Int64 +Parameter Sets: Multi +Aliases: + +Required: False +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Paginate +Paginate results + +```yaml +Type: SwitchParameter +Parameter Sets: Multi +Aliases: pageinate + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +Number of results per page. + +```yaml +Type: Int32 +Parameter Sets: Multi +Aliases: page_size + +Required: False +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageNo +Which page to return. + +```yaml +Type: Int32 +Parameter Sets: Multi +Aliases: page_no + +Required: False +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Order +The name of the first field to order by + +```yaml +Type: String +Parameter Sets: Multi +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrderDesc +Whether to order ascending or descending + +```yaml +Type: SwitchParameter +Parameter Sets: Multi +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDetails +Include extra objects in the result. + +```yaml +Type: SwitchParameter +Parameter Sets: Single +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### A powershell object containing the response. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/Get-HaloStatus.md b/Docs/MarkDown/Get-HaloStatus.md index 4401c52..fc8b57a 100644 --- a/Docs/MarkDown/Get-HaloStatus.md +++ b/Docs/MarkDown/Get-HaloStatus.md @@ -37,38 +37,39 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -Domain -Filter counts to a specific domain: reqs = tickets, opps = opportunities and prjs = projects. +### -StatusID +Status ID ```yaml -Type: String -Parameter Sets: Multi +Type: Int64 +Parameter Sets: Single Aliases: -Required: False +Required: True Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeClosed -Exclude the closed status from the response +### -Type +Filter by Status type e.g. +'ticket' returns all ticket statuses ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludePending -Exclude the pending closure status from the response +### -ShowCounts +Show the count of tickets in the results. ```yaml Type: SwitchParameter @@ -82,78 +83,77 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDetails -Include extra objects in the result. +### -Domain +Filter counts to a specific domain: reqs = tickets, opps = opportunities and prjs = projects. ```yaml -Type: SwitchParameter -Parameter Sets: Single +Type: String +Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowCounts -Show the count of tickets in the results. +### -ViewID +Filter counts to a specific view ID. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: view_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -StatusID -Status ID +### -ExcludePending +Exclude the pending closure status from the response ```yaml -Type: Int64 -Parameter Sets: Single +Type: SwitchParameter +Parameter Sets: Multi Aliases: -Required: True +Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -Filter by Status type e.g. -'ticket' returns all ticket statuses +### -ExcludeClosed +Exclude the closed status from the response ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ViewID -Filter counts to a specific view ID. +### -IncludeDetails +Include extra objects in the result. ```yaml -Type: Int32 -Parameter Sets: Multi -Aliases: view_id +Type: SwitchParameter +Parameter Sets: Single +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloSupplier.md b/Docs/MarkDown/Get-HaloSupplier.md index 0ac37fd..4b3afff 100644 --- a/Docs/MarkDown/Get-HaloSupplier.md +++ b/Docs/MarkDown/Get-HaloSupplier.md @@ -38,28 +38,28 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -Count -The number of suppliers to return if not using pagination. +### -SupplierID +Supplier ID ```yaml -Type: Int32 -Parameter Sets: Multi +Type: Int64 +Parameter Sets: Single Aliases: -Required: False +Required: True Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeActive -Include active suppliers in the results. +### -Paginate +Paginate results ```yaml Type: SwitchParameter Parameter Sets: Multi -Aliases: +Aliases: pageinate Required: False Position: Named @@ -68,32 +68,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDetails -Include extra objects in the result. +### -PageSize +Number of results per page. ```yaml -Type: SwitchParameter -Parameter Sets: Single -Aliases: +Type: Int32 +Parameter Sets: Multi +Aliases: page_size Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeInactive -Include inactive suppliers in the results. +### -PageNo +Which page to return. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: page_no Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` @@ -128,28 +128,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PageNo -Which page to return. +### -Search +Return suppliers matching the search term in the results. ```yaml -Type: Int32 +Type: String Parameter Sets: Multi -Aliases: page_no +Aliases: Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PageSize -Number of results per page. +### -Count +The number of suppliers to return if not using pagination. ```yaml Type: Int32 Parameter Sets: Multi -Aliases: page_size +Aliases: Required: False Position: Named @@ -158,62 +158,62 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Paginate -Paginate results +### -TopLevelID +Filter by the specified top level ID. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: pageinate +Aliases: toplevel_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -Search -Return suppliers matching the search term in the results. +### -IncludeActive +Include active suppliers in the results. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -SupplierID -Supplier ID +### -IncludeInactive +Include inactive suppliers in the results. ```yaml -Type: Int64 -Parameter Sets: Single +Type: SwitchParameter +Parameter Sets: Multi Aliases: -Required: True +Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -TopLevelID -Filter by the specified top level ID. +### -IncludeDetails +Include extra objects in the result. ```yaml -Type: Int32 -Parameter Sets: Multi -Aliases: toplevel_id +Type: SwitchParameter +Parameter Sets: Single +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloTeam.md b/Docs/MarkDown/Get-HaloTeam.md index 4dee170..683c31e 100644 --- a/Docs/MarkDown/Get-HaloTeam.md +++ b/Docs/MarkDown/Get-HaloTeam.md @@ -37,23 +37,23 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -DepartmentID -Filter by the specified department ID. +### -TeamID +Team ID ```yaml -Type: Int32 -Parameter Sets: Multi -Aliases: department_id +Type: Int64 +Parameter Sets: Single +Aliases: -Required: False +Required: True Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -Domain -Filter counts to a specific domain: reqs = tickets, opps = opportunities and prjs = projects. +### -Type +Filter teams to a specific type: reqs = tickets, opps = opportunities and prjs = projects. ```yaml Type: String @@ -83,12 +83,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDetails -Include extra objects in the result. +### -MemberOnly +Only include teams the current agent is a member of. ```yaml Type: SwitchParameter -Parameter Sets: Single +Parameter Sets: Multi Aliases: Required: False @@ -98,8 +98,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDisabled -Include disabled teams. +### -ShowCounts +Show the count of team tickets in the results. ```yaml Type: SwitchParameter @@ -113,38 +113,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeEnabled -Include enabled teams (defaults to $True). +### -Domain +Filter counts to a specific domain: reqs = tickets, opps = opportunities and prjs = projects. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MemberOnly -Only include teams the current agent is a member of. +### -ViewID +Filter counts to a specific view ID. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: view_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowCounts -Show the count of team tickets in the results. +### -IncludeEnabled +Include enabled teams (defaults to $True). ```yaml Type: SwitchParameter @@ -158,47 +158,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TeamID -Team ID +### -IncludeDisabled +Include disabled teams. ```yaml -Type: Int64 -Parameter Sets: Single +Type: SwitchParameter +Parameter Sets: Multi Aliases: -Required: True +Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -Filter teams to a specific type: reqs = tickets, opps = opportunities and prjs = projects. +### -DepartmentID +Filter by the specified department ID. ```yaml -Type: String +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: department_id Required: False Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -ViewID -Filter counts to a specific view ID. +### -IncludeDetails +Include extra objects in the result. ```yaml -Type: Int32 -Parameter Sets: Multi -Aliases: view_id +Type: SwitchParameter +Parameter Sets: Single +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloTicket.md b/Docs/MarkDown/Get-HaloTicket.md index dff11de..c3043bc 100644 --- a/Docs/MarkDown/Get-HaloTicket.md +++ b/Docs/MarkDown/Get-HaloTicket.md @@ -28,7 +28,7 @@ Get-HaloTicket [-Paginate] [-PageSize ] [-PageNo ] [-Order ] [-SearchDetails ] [-SearchReportedBy ] [-SearchVersion ] [-SearchRelease1 ] [-SearchRelease2 ] [-SearchRelease3 ] [-SearchReleaseNote ] [-SearchInventoryNumber ] [-SearchOppContactName ] [-SearchOppCompanyName ] - [-FullObjects] [] + [-FullObjects] [-Deleted] [] ``` ### Single @@ -50,43 +50,43 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -Agent -Filter by the specified array of agent IDs. +### -TicketID +Ticket ID ```yaml -Type: Int32[] -Parameter Sets: Multi +Type: Int64 +Parameter Sets: Single Aliases: -Required: False +Required: True Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -AgentID -Filter by the specified agent. +### -Paginate +Paginate results ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: agent_id +Aliases: pageinate Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -AssetID -Filter by the specified asset. +### -PageSize +Number of results per page. ```yaml Type: Int32 Parameter Sets: Multi -Aliases: asset_id +Aliases: page_size Required: False Position: Named @@ -95,28 +95,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Category1 -Filter by the specified array of category 1 IDs. +### -PageNo +Which page to return. ```yaml -Type: Int32[] +Type: Int32 Parameter Sets: Multi -Aliases: category_1 +Aliases: page_no Required: False Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -Category2 -Filter by the specified array of category 2 IDs. +### -Order +Which field to order results based on. ```yaml -Type: Int32[] +Type: String Parameter Sets: Multi -Aliases: category_2 +Aliases: Required: False Position: Named @@ -125,43 +125,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Category3 -Filter by the specified array of category 3 IDs. +### -OrderDesc +Order results in descending order (respects the field choice in '-Order') ```yaml -Type: Int32[] +Type: SwitchParameter Parameter Sets: Multi -Aliases: category_3 +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Category4 -Filter by the specified array of category 4 IDs. +### -TicketIDOnly +Return only the 'ID' fields (Ticket ID, SLA ID, Status ID, Client ID, Client Name and Last Incoming Email date) ```yaml -Type: Int32[] -Parameter Sets: Multi -Aliases: category_4 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ClientID -Filter by the specified client. +### -ViewID +The ID of the filter profile to use to filter results. ```yaml Type: Int32 Parameter Sets: Multi -Aliases: client_id +Aliases: view_id Required: False Position: Named @@ -170,21 +170,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ClosedOnly -Return only closed tickets in the results. - -```yaml -Type: SwitchParameter -Parameter Sets: Multi -Aliases: closed_only - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ColumnsID The ID of the column profile to use to control data returned in the results. @@ -200,83 +185,83 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ContractID -Filter by the specified contract ID. +### -IncludeColumns +Include column details in the the results. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: contract_id +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -DateSearch -Which date field to search against. +### -IncludeSLAActionDate +Include SLA action date in the results. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -EndDate -End date for use with the '-datesearch' parameter. +### -IncludeSLATimer +Include SLA timer in the results. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeThese -Exclude the specified array of ticket IDs. +### -IncludeTimeTaken +Include time taken in the results. ```yaml -Type: Int32[] +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Flagged -Filter by the specified array of flagged ticket IDs. +### -IncludeSupplier +Include supplier details in the results. ```yaml -Type: Int32[] +Type: SwitchParameter Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -FullObjects -Parameter to return the complete objects. +### -IncludeRelease1 +Include release 1 details in the results. ```yaml Type: SwitchParameter @@ -290,8 +275,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeChildIDs -Include child ticket IDs in the results. +### -IncludeRelease2 +Include release 2 details in the results. ```yaml Type: SwitchParameter @@ -305,8 +290,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeColumns -Include column details in the the results. +### -IncludeRelease3 +Include release 3 details in the results. ```yaml Type: SwitchParameter @@ -320,12 +305,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDetails -Include extra objects in the result. +### -IncludeChildIDs +Include child ticket IDs in the results. ```yaml Type: SwitchParameter -Parameter Sets: Single +Parameter Sets: Multi Aliases: Required: False @@ -335,12 +320,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeLastAction -Include the last action in the result. +### -IncludeNextActivityDate +Include next activity date in the results. ```yaml Type: SwitchParameter -Parameter Sets: Single +Parameter Sets: Multi Aliases: Required: False @@ -350,133 +335,133 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeNextActivityDate -Include next activity date in the results. +### -TicketAreaID +Filter by the specified ticket area. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeRelease1 -Include release 1 details in the results. +### -ListID +Filter by the specified list. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: list_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeRelease2 -Include release 2 details in the results. +### -AgentID +Filter by the specified agent. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: agent_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeRelease3 -Include release 3 details in the results. +### -StatusID +Filter by the specified status. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: status_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeSLAActionDate -Include SLA action date in the results. +### -RequestTypeID +Filter by the specified request type. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: requesttype_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeSLATimer -Include SLA timer in the results. +### -SupplierID +Filter by the specified supplier. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: supplier_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeSupplier -Include supplier details in the results. +### -ClientID +Filter by the specified client. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: client_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeTimeTaken -Include time taken in the results. +### -Site +Filter by the specified site. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -ITILRequestType -Filter by the specified array of ITIL request type IDs. +### -UserName +Filter by the specified user name. ```yaml -Type: Int32[] +Type: String Parameter Sets: Multi -Aliases: itil_requesttype +Aliases: Required: False Position: Named @@ -485,13 +470,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ITILRequestTypeID -Filter by the specified ITIL request type. +### -UserID +Filter by the specified user ID. ```yaml Type: Int32 Parameter Sets: Multi -Aliases: itil_requesttype_id +Aliases: user_id Required: False Position: Named @@ -500,13 +485,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ListID -Filter by the specified list. +### -ReleaseID +Filter by the specified release. ```yaml Type: Int32 Parameter Sets: Multi -Aliases: list_id +Aliases: release_id Required: False Position: Named @@ -515,43 +500,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OpenOnly -Return only open tickets in the results. +### -AssetID +Filter by the specified asset. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: open_only +Aliases: asset_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -Order -Which field to order results based on. +### -ITILRequestTypeID +Filter by the specified ITIL request type. ```yaml -Type: String +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: itil_requesttype_id Required: False Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderDesc -Order results in descending order (respects the field choice in '-Order') +### -OpenOnly +Return only open tickets in the results. ```yaml Type: SwitchParameter Parameter Sets: Multi -Aliases: +Aliases: open_only Required: False Position: Named @@ -560,28 +545,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PageNo -Which page to return. +### -ClosedOnly +Return only closed tickets in the results. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: page_no +Aliases: closed_only Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -PageSize -Number of results per page. +### -UnlinkedOnly +Return only unlinked tickets in the results. + +```yaml +Type: SwitchParameter +Parameter Sets: Multi +Aliases: unlinked_only + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContractID +Filter by the specified contract ID. ```yaml Type: Int32 Parameter Sets: Multi -Aliases: page_size +Aliases: contract_id Required: False Position: Named @@ -590,13 +590,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Paginate -Paginate results +### -WithAttachments +Return only tickets with attachments in the results. ```yaml Type: SwitchParameter Parameter Sets: Multi -Aliases: pageinate +Aliases: Required: False Position: Named @@ -605,8 +605,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Priority -Filter by the specified array of priority IDs. +### -Team +Filter by the specified array of team IDs. ```yaml Type: Int32[] @@ -620,8 +620,8 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Products -Filter by the specified array of product IDs. +### -Agent +Filter by the specified array of agent IDs. ```yaml Type: Int32[] @@ -635,17 +635,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReleaseID -Filter by the specified release. +### -Status +Filter by the specified array of status IDs. ```yaml -Type: Int32 +Type: Int32[] Parameter Sets: Multi -Aliases: release_id +Aliases: Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -665,28 +665,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequestTypeID -Filter by the specified request type. +### -ITILRequestType +Filter by the specified array of ITIL request type IDs. ```yaml -Type: Int32 +Type: Int32[] Parameter Sets: Multi -Aliases: requesttype_id +Aliases: itil_requesttype Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Search -Return tickets matching the search term in the results. +### -Category1 +Filter by the specified array of category 1 IDs. ```yaml -Type: String +Type: Int32[] Parameter Sets: Multi -Aliases: +Aliases: category_1 Required: False Position: Named @@ -695,28 +695,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchActions -Include actions when searching. +### -Category2 +Filter by the specified array of category 2 IDs. ```yaml -Type: SwitchParameter +Type: Int32[] Parameter Sets: Multi -Aliases: +Aliases: category_2 Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchDetails -Return tickets where the details matches the search term. +### -Category3 +Filter by the specified array of category 3 IDs. ```yaml -Type: String +Type: Int32[] Parameter Sets: Multi -Aliases: search_details +Aliases: category_3 Required: False Position: Named @@ -725,13 +725,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchInventoryNumber -Return tickets where the asset tag matches the search term. +### -Category4 +Filter by the specified array of category 4 IDs. ```yaml -Type: String +Type: Int32[] Parameter Sets: Multi -Aliases: search_invenotry_number +Aliases: category_4 Required: False Position: Named @@ -740,13 +740,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchOppCompanyName -Return tickets where the opportunity company name matches the search term. +### -SLA +Filter by the specified array of SLA IDs. ```yaml -Type: String +Type: Int32[] Parameter Sets: Multi -Aliases: search_oppcompanyname +Aliases: Required: False Position: Named @@ -755,13 +755,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchOppContactName -Return tickets where the opportunity contact name matches the search term. +### -Priority +Filter by the specified array of priority IDs. ```yaml -Type: String +Type: Int32[] Parameter Sets: Multi -Aliases: search_oppcontactname +Aliases: Required: False Position: Named @@ -770,13 +770,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchRelease1 -Return tickets where release 1 matches the search term. +### -Products +Filter by the specified array of product IDs. ```yaml -Type: String +Type: Int32[] Parameter Sets: Multi -Aliases: search_release1 +Aliases: Required: False Position: Named @@ -785,13 +785,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchRelease2 -Return tickets where release 2 matches the search term. +### -Flagged +Filter by the specified array of flagged ticket IDs. ```yaml -Type: String +Type: Int32[] Parameter Sets: Multi -Aliases: search_release2 +Aliases: Required: False Position: Named @@ -800,13 +800,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchRelease3 -Return tickets where release 3 matches the search term. +### -ExcludeThese +Exclude the specified array of ticket IDs. ```yaml -Type: String +Type: Int32[] Parameter Sets: Multi -Aliases: search_release3 +Aliases: Required: False Position: Named @@ -815,13 +815,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchReleaseNote -Return tickets where the release note matches the search term. +### -Search +Return tickets matching the search term in the results. ```yaml Type: String Parameter Sets: Multi -Aliases: search_releasenote +Aliases: Required: False Position: Named @@ -830,13 +830,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchReportedBy -Return tickets where the reported by matches the search term. +### -SearchActions +Include actions when searching. + +```yaml +Type: SwitchParameter +Parameter Sets: Multi +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DateSearch +Which date field to search against. ```yaml Type: String Parameter Sets: Multi -Aliases: search_reportedby +Aliases: Required: False Position: Named @@ -845,13 +860,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchSummary -Return tickets where the summary matches the search term. +### -StartDate +Start date for use with the '-datesearch' parameter. ```yaml Type: String Parameter Sets: Multi -Aliases: search_summary +Aliases: Required: False Position: Named @@ -860,13 +875,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchUserName -Return tickets where the user name matches the search term. +### -EndDate +End date for use with the '-datesearch' parameter. ```yaml Type: String Parameter Sets: Multi -Aliases: search_user_name +Aliases: Required: False Position: Named @@ -875,13 +890,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchVersion -Return tickets where the software version matches the search term. +### -SearchUserName +Return tickets where the user name matches the search term. ```yaml Type: String Parameter Sets: Multi -Aliases: search_version +Aliases: search_user_name Required: False Position: Named @@ -890,28 +905,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Site -Filter by the specified site. +### -SearchSummary +Return tickets where the summary matches the search term. ```yaml -Type: Int32 +Type: String Parameter Sets: Multi -Aliases: +Aliases: search_summary Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SLA -Filter by the specified array of SLA IDs. +### -SearchDetails +Return tickets where the details matches the search term. ```yaml -Type: Int32[] +Type: String Parameter Sets: Multi -Aliases: +Aliases: search_details Required: False Position: Named @@ -920,13 +935,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StartDate -Start date for use with the '-datesearch' parameter. +### -SearchReportedBy +Return tickets where the reported by matches the search term. ```yaml Type: String Parameter Sets: Multi -Aliases: +Aliases: search_reportedby Required: False Position: Named @@ -935,13 +950,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Status -Filter by the specified array of status IDs. +### -SearchVersion +Return tickets where the software version matches the search term. ```yaml -Type: Int32[] +Type: String Parameter Sets: Multi -Aliases: +Aliases: search_version Required: False Position: Named @@ -950,43 +965,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StatusID -Filter by the specified status. +### -SearchRelease1 +Return tickets where release 1 matches the search term. ```yaml -Type: Int32 +Type: String Parameter Sets: Multi -Aliases: status_id +Aliases: search_release1 Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SupplierID -Filter by the specified supplier. +### -SearchRelease2 +Return tickets where release 2 matches the search term. ```yaml -Type: Int32 +Type: String Parameter Sets: Multi -Aliases: supplier_id +Aliases: search_release2 Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Team -Filter by the specified array of team IDs. +### -SearchRelease3 +Return tickets where release 3 matches the search term. ```yaml -Type: Int32[] +Type: String Parameter Sets: Multi -Aliases: +Aliases: search_release3 Required: False Position: Named @@ -995,113 +1010,113 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TicketAreaID -Filter by the specified ticket area. +### -SearchReleaseNote +Return tickets where the release note matches the search term. ```yaml -Type: Int32 +Type: String Parameter Sets: Multi -Aliases: +Aliases: search_releasenote Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TicketID -Ticket ID +### -SearchInventoryNumber +Return tickets where the asset tag matches the search term. ```yaml -Type: Int64 -Parameter Sets: Single -Aliases: +Type: String +Parameter Sets: Multi +Aliases: search_invenotry_number -Required: True +Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TicketIDOnly -Return only the 'ID' fields (Ticket ID, SLA ID, Status ID, Client ID, Client Name and Last Incoming Email date) +### -SearchOppContactName +Return tickets where the opportunity contact name matches the search term. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: +Type: String +Parameter Sets: Multi +Aliases: search_oppcontactname Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UnlinkedOnly -Return only unlinked tickets in the results. +### -SearchOppCompanyName +Return tickets where the opportunity company name matches the search term. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi -Aliases: unlinked_only +Aliases: search_oppcompanyname Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserID -Filter by the specified user ID. +### -FullObjects +Parameter to return the complete objects. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: user_id +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -UserName -Filter by the specified user name. +### -IncludeDetails +Include extra objects in the result. ```yaml -Type: String -Parameter Sets: Multi +Type: SwitchParameter +Parameter Sets: Single Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ViewID -The ID of the filter profile to use to filter results. +### -IncludeLastAction +Include the last action in the result. ```yaml -Type: Int32 -Parameter Sets: Multi -Aliases: view_id +Type: SwitchParameter +Parameter Sets: Single +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -WithAttachments -Return only tickets with attachments in the results. +### -Deleted +Return deleted tickets only. ```yaml Type: SwitchParameter diff --git a/Docs/MarkDown/Get-HaloTicketRules.md b/Docs/MarkDown/Get-HaloTicketRules.md new file mode 100644 index 0000000..bc3c556 --- /dev/null +++ b/Docs/MarkDown/Get-HaloTicketRules.md @@ -0,0 +1,126 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# Get-HaloTicketRules + +## SYNOPSIS +Gets Halo Ticket Rules information from the Halo API. + +## SYNTAX + +### Multi (Default) +``` +Get-HaloTicketRules [-ExcludeWorkflow] [-ShowAll] [] +``` + +### Single +``` +Get-HaloTicketRules -RuleID [-IncludeDetails] [-IncludeCriteriaInfo] [] +``` + +## DESCRIPTION +Retrieves Ticket Rule from the Halo API. +By default it retrieves global rules AND workflow step rules. +Use "-ExcludeWorkflow" to limit the list to only Global Rules. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -RuleID +Rule ID + +```yaml +Type: Int64 +Parameter Sets: Single +Aliases: + +Required: True +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDetails +{{ Fill IncludeDetails Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Single +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeCriteriaInfo +{{ Fill IncludeCriteriaInfo Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: Single +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeWorkflow +Include Workflow Step Rules + +```yaml +Type: SwitchParameter +Parameter Sets: Multi +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowAll +ShowAll + +```yaml +Type: SwitchParameter +Parameter Sets: Multi +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### A powershell object containing the response. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/Get-HaloTicketType.md b/Docs/MarkDown/Get-HaloTicketType.md index 16b86dc..162315e 100644 --- a/Docs/MarkDown/Get-HaloTicketType.md +++ b/Docs/MarkDown/Get-HaloTicketType.md @@ -20,7 +20,7 @@ Get-HaloTicketType [-ShowCounts] [-Domain ] [-ViewID ] [-ShowInac ### Single ``` -Get-HaloTicketType -TicketTypeID [-IncludeDetails] [] +Get-HaloTicketType -TicketTypeID [-IncludeDetails] [-IncludeConfig] [] ``` ## DESCRIPTION @@ -37,17 +37,32 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -ClientID -Filter by a specific client id. +### -TicketTypeID +Ticket Type ID ```yaml -Type: Int32 +Type: Int64 +Parameter Sets: Single +Aliases: + +Required: True +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ShowCounts +Show the count of tickets in the results. + +```yaml +Type: SwitchParameter Parameter Sets: Multi -Aliases: client_id +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -67,23 +82,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDetails -Include extra objects in the result. +### -ViewID +Filter counts to a specific view ID. ```yaml -Type: SwitchParameter -Parameter Sets: Single -Aliases: +Type: Int32 +Parameter Sets: Multi +Aliases: view_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowCounts -Show the count of tickets in the results. +### -ShowInactive +Include inactive ticket types in the results. ```yaml Type: SwitchParameter @@ -97,47 +112,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowInactive -Include inactive ticket types in the results. +### -ClientID +Filter by a specific client id. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: client_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -TicketTypeID -Ticket Type ID +### -IncludeDetails +Include extra objects in the result. ```yaml -Type: Int64 +Type: SwitchParameter Parameter Sets: Single Aliases: -Required: True +Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ViewID -Filter counts to a specific view ID. +### -IncludeConfig +Include all related configuration in the result. ```yaml -Type: Int32 -Parameter Sets: Multi -Aliases: view_id +Type: SwitchParameter +Parameter Sets: Single +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloTimesheet.md b/Docs/MarkDown/Get-HaloTimesheet.md index 086b97a..6a08a50 100644 --- a/Docs/MarkDown/Get-HaloTimesheet.md +++ b/Docs/MarkDown/Get-HaloTimesheet.md @@ -32,23 +32,23 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -EndDate -Timesheet end date/time. +### -SelectedTeam +Return the timesheet for the specified team. ```yaml -Type: DateTime +Type: Int32 Parameter Sets: (All) -Aliases: end_date +Aliases: Required: False Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeTimesheetFields -Include all timesheet fields in the result. +### -ShowHolidays +Include holidays in the result. ```yaml Type: SwitchParameter @@ -77,53 +77,53 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SelectedTeam -Return the timesheet for the specified team. +### -SelectedTypes +Return the selected types. ```yaml -Type: Int32 +Type: Int32[] Parameter Sets: (All) Aliases: Required: False Position: Named -Default value: 0 +Default value: @(0, 1 , 2, 3) Accept pipeline input: False Accept wildcard characters: False ``` -### -SelectedTypes -Return the selected types. +### -StartDate +Timesheet start date/time. ```yaml -Type: Int32[] +Type: DateTime Parameter Sets: (All) -Aliases: +Aliases: start_date Required: False Position: Named -Default value: @(0, 1 , 2, 3) +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowAllDates -Include all days in the result. +### -EndDate +Timesheet end date/time. ```yaml -Type: SwitchParameter +Type: DateTime Parameter Sets: (All) -Aliases: +Aliases: end_date Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowHolidays -Include holidays in the result. +### -ShowAllDates +Include all days in the result. ```yaml Type: SwitchParameter @@ -137,17 +137,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StartDate -Timesheet start date/time. +### -IncludeTimesheetFields +Include all timesheet fields in the result. ```yaml -Type: DateTime +Type: SwitchParameter Parameter Sets: (All) -Aliases: start_date +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloUser.md b/Docs/MarkDown/Get-HaloUser.md index 53146cb..e3fbe48 100644 --- a/Docs/MarkDown/Get-HaloUser.md +++ b/Docs/MarkDown/Get-HaloUser.md @@ -39,43 +39,43 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -ApproversOnly -Include approvers only in the results. +### -UserID +User ID ```yaml -Type: SwitchParameter -Parameter Sets: Multi +Type: Int64 +Parameter Sets: Single Aliases: -Required: False +Required: True Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -AssetID -Filter by the specified asset ID. +### -Paginate +Paginate results ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: asset_id +Aliases: pageinate Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ClientID -Filter by the specified client ID. +### -PageSize +Number of results per page. ```yaml Type: Int32 Parameter Sets: Multi -Aliases: client_id +Aliases: page_size Required: False Position: Named @@ -84,13 +84,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Count -The number of users to return if not using pagination. +### -PageNo +Which page to return. ```yaml Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: page_no Required: False Position: Named @@ -99,23 +99,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DepartmentID -Filter by the specified department ID. +### -Order +Which field to order results based on. ```yaml -Type: Int32 +Type: String Parameter Sets: Multi -Aliases: department_id +Aliases: Required: False Position: Named -Default value: 0 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeAgents -Exclude users linked to agent accounts from the results. +### -OrderDesc +Order results in descending order (respects the field choice in '-Order') ```yaml Type: SwitchParameter @@ -129,28 +129,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FullObjects -Parameter to return the full objects. +### -Search +Return users matching the search term in the results. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeActive -Include active users in the results. +### -SearchPhoneNumbers +Search on phone numbers when searching. ```yaml Type: SwitchParameter Parameter Sets: Multi -Aliases: +Aliases: search_phonenumbers Required: False Position: Named @@ -159,148 +159,148 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeActivity -Include ticket activity in the result. +### -TopLevelID +Filter by the specified top level ID. ```yaml -Type: SwitchParameter -Parameter Sets: Single -Aliases: +Type: Int32 +Parameter Sets: Multi +Aliases: toplevel_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDetails -Include extra objects in the result. +### -ClientID +Filter by the specified client ID. ```yaml -Type: SwitchParameter -Parameter Sets: Single -Aliases: +Type: Int32 +Parameter Sets: Multi +Aliases: client_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeInactive -Include inactive users in the results. +### -SiteID +Filter by the specified site ID. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: site_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludePopups -Include customer popups in the result. +### -OrganisationID +Filter by the specified organisation ID. ```yaml -Type: SwitchParameter -Parameter Sets: Single -Aliases: +Type: Int32 +Parameter Sets: Multi +Aliases: organisation_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -Order -Which field to order results based on. +### -DepartmentID +Filter by the specified department ID. ```yaml -Type: String +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: department_id Required: False Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -OrderDesc -Order results in descending order (respects the field choice in '-Order') +### -AssetID +Filter by the specified asset ID. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: Multi -Aliases: +Aliases: asset_id Required: False Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -OrganisationID -Filter by the specified organisation ID. +### -IncludeActive +Include active users in the results. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: organisation_id +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -PageNo -Which page to return. +### -IncludeInactive +Include inactive users in the results. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: page_no +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -PageSize -Number of results per page. +### -ApproversOnly +Include approvers only in the results. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: Multi -Aliases: page_size +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Paginate -Paginate results +### -ExcludeAgents +Exclude users linked to agent accounts from the results. ```yaml Type: SwitchParameter Parameter Sets: Multi -Aliases: pageinate +Aliases: Required: False Position: Named @@ -309,28 +309,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Search -Return users matching the search term in the results. +### -Count +The number of users to return if not using pagination. ```yaml -Type: String +Type: Int32 Parameter Sets: Multi Aliases: Required: False Position: Named -Default value: None +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchPhoneNumbers -Search on phone numbers when searching. +### -FullObjects +Parameter to return the full objects. ```yaml Type: SwitchParameter Parameter Sets: Multi -Aliases: search_phonenumbers +Aliases: Required: False Position: Named @@ -339,47 +339,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SiteID -Filter by the specified site ID. +### -IncludeDetails +Include extra objects in the result. ```yaml -Type: Int32 -Parameter Sets: Multi -Aliases: site_id +Type: SwitchParameter +Parameter Sets: Single +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -TopLevelID -Filter by the specified top level ID. +### -IncludeActivity +Include ticket activity in the result. ```yaml -Type: Int32 -Parameter Sets: Multi -Aliases: toplevel_id +Type: SwitchParameter +Parameter Sets: Single +Aliases: Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -UserID -User ID +### -IncludePopups +Include customer popups in the result. ```yaml -Type: Int64 +Type: SwitchParameter Parameter Sets: Single Aliases: -Required: True +Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloWorkday.md b/Docs/MarkDown/Get-HaloWorkday.md index 23a4311..b5220fe 100644 --- a/Docs/MarkDown/Get-HaloWorkday.md +++ b/Docs/MarkDown/Get-HaloWorkday.md @@ -36,17 +36,17 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -IncludeDetails -Include extra objects in the result. +### -WorkdayID +Workday Item ID ```yaml -Type: SwitchParameter +Type: Int64 Parameter Sets: Single Aliases: -Required: False +Required: True Position: Named -Default value: False +Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` @@ -66,17 +66,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WorkdayID -Workday Item ID +### -IncludeDetails +Include extra objects in the result. ```yaml -Type: Int64 +Type: SwitchParameter Parameter Sets: Single Aliases: -Required: True +Required: False Position: Named -Default value: 0 +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/Get-HaloWorkflow.md b/Docs/MarkDown/Get-HaloWorkflow.md new file mode 100644 index 0000000..4e73620 --- /dev/null +++ b/Docs/MarkDown/Get-HaloWorkflow.md @@ -0,0 +1,170 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# Get-HaloWorkflow + +## SYNOPSIS +Gets Workflows from the Halo API. + +## SYNTAX + +### Multi (Default) +``` +Get-HaloWorkflow [-Count ] [-Paginate] [-PageSize ] [-PageNo ] [-Order ] + [-OrderDesc] [] +``` + +### Single +``` +Get-HaloWorkflow -WorkflowID [-IncludeDetails] [] +``` + +## DESCRIPTION +Retrieves Workflows from the Halo API - supports a variety of filtering parameters. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -WorkflowID +Item ID + +```yaml +Type: Int64 +Parameter Sets: Single +Aliases: + +Required: True +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Count +Number of records to return + +```yaml +Type: Int64 +Parameter Sets: Multi +Aliases: + +Required: False +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Paginate +Paginate results + +```yaml +Type: SwitchParameter +Parameter Sets: Multi +Aliases: pageinate + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageSize +Number of results per page. + +```yaml +Type: Int32 +Parameter Sets: Multi +Aliases: page_size + +Required: False +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PageNo +Which page to return. + +```yaml +Type: Int32 +Parameter Sets: Multi +Aliases: page_no + +Required: False +Position: Named +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Order +The name of the first field to order by + +```yaml +Type: String +Parameter Sets: Multi +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OrderDesc +Whether to order ascending or descending + +```yaml +Type: SwitchParameter +Parameter Sets: Multi +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDetails +Include extra objects in the result. + +```yaml +Type: SwitchParameter +Parameter Sets: Single +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### A powershell object containing the response. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/Get-TokenExpiry.md b/Docs/MarkDown/Get-TokenExpiry.md new file mode 100644 index 0000000..73e3145 --- /dev/null +++ b/Docs/MarkDown/Get-TokenExpiry.md @@ -0,0 +1,59 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# Get-TokenExpiry + +## SYNOPSIS +Calculates and returns the expiry date/time of a Halo token. + +## SYNTAX + +``` +Get-TokenExpiry [-ExpiresIn] [] +``` + +## DESCRIPTION +Takes the expires in time for an auth token and returns a PowerShell date/time object containing the expiry date/time of the token. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -ExpiresIn +Timestamp value for token expiry. +e.g 3600 + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### A powershell date/time object representing the token expiry. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/Invoke-HaloBatchProcessor.md b/Docs/MarkDown/Invoke-HaloBatchProcessor.md new file mode 100644 index 0000000..9d63970 --- /dev/null +++ b/Docs/MarkDown/Invoke-HaloBatchProcessor.md @@ -0,0 +1,134 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# Invoke-HaloBatchProcessor + +## SYNOPSIS +Handles batch processing Halo API requests using PowerShell parallel processing. + +## SYNTAX + +``` +Invoke-HaloBatchProcessor [-BatchInput] [-EntityType] [-Operation] + [[-Parameters] ] [[-Size] ] [[-Wait] ] [] +``` + +## DESCRIPTION +Utility function to batch process Halo API requests supports configurable batch sizes and delays. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -BatchInput +{{ Fill BatchInput Description }} + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EntityType +{{ Fill EntityType Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Operation +{{ Fill Operation Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameters +{{ Fill Parameters Description }} + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Size +{{ Fill Size Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 5 +Default value: 100 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait +{{ Fill Wait Description }} + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: 30 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the response(s) from the web request. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/Invoke-HaloRequest.md b/Docs/MarkDown/Invoke-HaloRequest.md index 8574999..de76386 100644 --- a/Docs/MarkDown/Invoke-HaloRequest.md +++ b/Docs/MarkDown/Invoke-HaloRequest.md @@ -30,33 +30,33 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -RawResult -Returns the Raw result. -Useful for file downloads. +### -WebRequestParams +Hashtable containing the web request parameters. ```yaml -Type: SwitchParameter +Type: Hashtable Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: False +Position: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WebRequestParams -Hashtable containing the web request parameters. +### -RawResult +Returns the Raw result. +Useful for file downloads. ```yaml -Type: Hashtable +Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False -Position: 1 -Default value: None +Position: Named +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/Docs/MarkDown/New-HaloAction.md b/Docs/MarkDown/New-HaloAction.md index 7154bc1..afd9d1d 100644 --- a/Docs/MarkDown/New-HaloAction.md +++ b/Docs/MarkDown/New-HaloAction.md @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/New-HaloActionBatch.md b/Docs/MarkDown/New-HaloActionBatch.md new file mode 100644 index 0000000..979f5a2 --- /dev/null +++ b/Docs/MarkDown/New-HaloActionBatch.md @@ -0,0 +1,122 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloActionBatch + +## SYNOPSIS +Creates multiple actions via the Halo API. + +## SYNTAX + +``` +New-HaloActionBatch [-Actions] [[-BatchSize] ] [[-BatchWait] ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Function to send a batch of action creation requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Actions +Array of objects containing properties and values used to create one or more new actions. + +```yaml +Type: Array[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +How many objects to process at once before delaying. +Default value is 100. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchWait +How long to wait between batch runs. +Default value is 1 second. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the responses from the web requests. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloAgent.md b/Docs/MarkDown/New-HaloAgent.md index 6265eb4..6166975 100644 --- a/Docs/MarkDown/New-HaloAgent.md +++ b/Docs/MarkDown/New-HaloAgent.md @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/New-HaloAgentBatch.md b/Docs/MarkDown/New-HaloAgentBatch.md new file mode 100644 index 0000000..766fc1c --- /dev/null +++ b/Docs/MarkDown/New-HaloAgentBatch.md @@ -0,0 +1,122 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloAgentBatch + +## SYNOPSIS +Creates multiple agents via the Halo API. + +## SYNTAX + +``` +New-HaloAgentBatch [-Agents] [[-BatchSize] ] [[-BatchWait] ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Function to send a batch of agent creation requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Agents +Array of objects containing properties and values used to create one or more new agents. + +```yaml +Type: Array[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +How many objects to process at once before delaying. +Default value is 100. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchWait +How long to wait between batch runs. +Default value is 1 second. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the responses from the web requests. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloAppointment.md b/Docs/MarkDown/New-HaloAppointment.md index c5df134..646a911 100644 --- a/Docs/MarkDown/New-HaloAppointment.md +++ b/Docs/MarkDown/New-HaloAppointment.md @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/New-HaloAppointmentBatch.md b/Docs/MarkDown/New-HaloAppointmentBatch.md new file mode 100644 index 0000000..1b084b0 --- /dev/null +++ b/Docs/MarkDown/New-HaloAppointmentBatch.md @@ -0,0 +1,122 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloAppointmentBatch + +## SYNOPSIS +Creates multiple appointments via the Halo API. + +## SYNTAX + +``` +New-HaloAppointmentBatch [-Appointments] [[-BatchSize] ] [[-BatchWait] ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +Function to send a batch of appointment creation requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Appointments +Array of objects containing properties and values used to create one or more new appointments. + +```yaml +Type: Array[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +How many objects to process at once before delaying. +Default value is 100. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchWait +How long to wait between batch runs. +Default value is 1 second. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the responses from the web requests. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloAsset.md b/Docs/MarkDown/New-HaloAsset.md index 4321206..d21f7d5 100644 --- a/Docs/MarkDown/New-HaloAsset.md +++ b/Docs/MarkDown/New-HaloAsset.md @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/New-HaloAssetBatch.md b/Docs/MarkDown/New-HaloAssetBatch.md new file mode 100644 index 0000000..0f87cd2 --- /dev/null +++ b/Docs/MarkDown/New-HaloAssetBatch.md @@ -0,0 +1,122 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloAssetBatch + +## SYNOPSIS +Creates multiple assets via the Halo API. + +## SYNTAX + +``` +New-HaloAssetBatch [-Assets] [[-BatchSize] ] [[-BatchWait] ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Function to send a batch of asset creation requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Assets +Array of objects containing properties and values used to create one or more new assets. + +```yaml +Type: Array[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +How many objects to process at once before delaying. +Default value is 100. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchWait +How long to wait between batch runs. +Default value is 1 second. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the responses from the web requests. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloAssetType.md b/Docs/MarkDown/New-HaloAssetType.md new file mode 100644 index 0000000..83db497 --- /dev/null +++ b/Docs/MarkDown/New-HaloAssetType.md @@ -0,0 +1,89 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloAssetType + +## SYNOPSIS +Creates an asset type via the Halo API. + +## SYNTAX + +``` +New-HaloAssetType [-AssetType] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Function to send an asset type creation request to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -AssetType +Object containing properties and values used to create a new asset. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the response from the web request. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloAttachment.md b/Docs/MarkDown/New-HaloAttachment.md index 239c385..c193bb8 100644 --- a/Docs/MarkDown/New-HaloAttachment.md +++ b/Docs/MarkDown/New-HaloAttachment.md @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/New-HaloAttachmentBatch.md b/Docs/MarkDown/New-HaloAttachmentBatch.md new file mode 100644 index 0000000..e98f264 --- /dev/null +++ b/Docs/MarkDown/New-HaloAttachmentBatch.md @@ -0,0 +1,122 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloAttachmentBatch + +## SYNOPSIS +Creates multiple attachments via the Halo API. + +## SYNTAX + +``` +New-HaloAttachmentBatch [-Attachments] [[-BatchSize] ] [[-BatchWait] ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +Function to send a batch of attachment creation requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Attachments +Array of objects containing properties and values used to create one or more new attachments. + +```yaml +Type: Array[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +How many objects to process at once before delaying. +Default value is 100. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchWait +How long to wait between batch runs. +Default value is 1 second. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the responses from the web requests. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloBillingTemplate.md b/Docs/MarkDown/New-HaloBillingTemplate.md index 90ee79a..f74e9e4 100644 --- a/Docs/MarkDown/New-HaloBillingTemplate.md +++ b/Docs/MarkDown/New-HaloBillingTemplate.md @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/New-HaloCRMNote.md b/Docs/MarkDown/New-HaloCRMNote.md index c09f31e..7e98bf1 100644 --- a/Docs/MarkDown/New-HaloCRMNote.md +++ b/Docs/MarkDown/New-HaloCRMNote.md @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/New-HaloCategory.md b/Docs/MarkDown/New-HaloCategory.md index 7bea7ed..cca5338 100644 --- a/Docs/MarkDown/New-HaloCategory.md +++ b/Docs/MarkDown/New-HaloCategory.md @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/New-HaloClient.md b/Docs/MarkDown/New-HaloClient.md index e6c6281..94af702 100644 --- a/Docs/MarkDown/New-HaloClient.md +++ b/Docs/MarkDown/New-HaloClient.md @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/New-HaloClientBatch.md b/Docs/MarkDown/New-HaloClientBatch.md new file mode 100644 index 0000000..355919e --- /dev/null +++ b/Docs/MarkDown/New-HaloClientBatch.md @@ -0,0 +1,122 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloClientBatch + +## SYNOPSIS +Creates multiple clients via the Halo API. + +## SYNTAX + +``` +New-HaloClientBatch [-Clients] [[-BatchSize] ] [[-BatchWait] ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Function to send a batch of client creation requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Clients +Array of objects containing properties and values used to create one or more new clients. + +```yaml +Type: Array[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +How many objects to process at once before delaying. +Default value is 100. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchWait +How long to wait between batch runs. +Default value is 1 second. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the responses from the web requests. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloContract.md b/Docs/MarkDown/New-HaloContract.md index 97c2838..5a8bc0c 100644 --- a/Docs/MarkDown/New-HaloContract.md +++ b/Docs/MarkDown/New-HaloContract.md @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/New-HaloContractBatch.md b/Docs/MarkDown/New-HaloContractBatch.md new file mode 100644 index 0000000..5393674 --- /dev/null +++ b/Docs/MarkDown/New-HaloContractBatch.md @@ -0,0 +1,122 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloContractBatch + +## SYNOPSIS +Creates multiple contracts via the Halo API. + +## SYNTAX + +``` +New-HaloContractBatch [-Contracts] [[-BatchSize] ] [[-BatchWait] ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Function to send a batch of contract creation requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Contracts +Array of objects containing properties and values used to create one or more new contracts. + +```yaml +Type: Array[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +How many objects to process at once before delaying. +Default value is 100. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchWait +How long to wait between batch runs. +Default value is 1 second. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the responses from the web requests. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloCustomButton.md b/Docs/MarkDown/New-HaloCustomButton.md index 77a8995..e0f1a23 100644 --- a/Docs/MarkDown/New-HaloCustomButton.md +++ b/Docs/MarkDown/New-HaloCustomButton.md @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/New-HaloCustomField.md b/Docs/MarkDown/New-HaloCustomField.md new file mode 100644 index 0000000..8d8b187 --- /dev/null +++ b/Docs/MarkDown/New-HaloCustomField.md @@ -0,0 +1,89 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloCustomField + +## SYNOPSIS +Creates one or more Custom Field(s) via the Halo API. + +## SYNTAX + +``` +New-HaloCustomField [-CustomField] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Function to send a Custom Field(s) creation request to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -CustomField +Object or array of objects containing properties and values used to create one or more new statuses. + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the response from the web request. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloCustomFieldBatch.md b/Docs/MarkDown/New-HaloCustomFieldBatch.md new file mode 100644 index 0000000..f590c14 --- /dev/null +++ b/Docs/MarkDown/New-HaloCustomFieldBatch.md @@ -0,0 +1,122 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloCustomFieldBatch + +## SYNOPSIS +Creates multiple custom fields via the Halo API. + +## SYNTAX + +``` +New-HaloCustomFieldBatch [-CustomFields] [[-BatchSize] ] [[-BatchWait] ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +Function to send a batch of custom field creation requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -CustomFields +Array of objects containing properties and values used to create one or more new custom fields. + +```yaml +Type: Array[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +How many objects to process at once before delaying. +Default value is 100. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchWait +How long to wait between batch runs. +Default value is 1 second. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the responses from the web requests. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloCustomTable.md b/Docs/MarkDown/New-HaloCustomTable.md new file mode 100644 index 0000000..33d159a --- /dev/null +++ b/Docs/MarkDown/New-HaloCustomTable.md @@ -0,0 +1,89 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloCustomTable + +## SYNOPSIS +Creates a custom table via the Halo API. + +## SYNTAX + +``` +New-HaloCustomTable [-CustomTable] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Function to send a custom table creation request to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -CustomTable +Object containing properties and values used to create a new custom table. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the response from the web request. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloDELETERequest.md b/Docs/MarkDown/New-HaloDELETERequest.md new file mode 100644 index 0000000..ad74f85 --- /dev/null +++ b/Docs/MarkDown/New-HaloDELETERequest.md @@ -0,0 +1,58 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloDELETERequest + +## SYNOPSIS +Sends a formatted web request to the Halo API. + +## SYNTAX + +``` +New-HaloDELETERequest [-Resource] [] +``` + +## DESCRIPTION +Wrapper function to send delete requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Resource +Endpoint for Delete Request + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the response from the web request. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloError.md b/Docs/MarkDown/New-HaloError.md new file mode 100644 index 0000000..ab4fda3 --- /dev/null +++ b/Docs/MarkDown/New-HaloError.md @@ -0,0 +1,96 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloError + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### ErrorRecord +``` +New-HaloError -ErrorRecord [-HasResponse] [] +``` + +### ModuleMessage +``` +New-HaloError -ModuleMessage [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -ErrorRecord +{{ Fill ErrorRecord Description }} + +```yaml +Type: ErrorRecord +Parameter Sets: ErrorRecord +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HasResponse +{{ Fill HasResponse Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: ErrorRecord +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ModuleMessage +{{ Fill ModuleMessage Description }} + +```yaml +Type: String +Parameter Sets: ModuleMessage +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloFAQList.md b/Docs/MarkDown/New-HaloFAQList.md index 67a68ae..55ba6d3 100644 --- a/Docs/MarkDown/New-HaloFAQList.md +++ b/Docs/MarkDown/New-HaloFAQList.md @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/New-HaloGETRequest.md b/Docs/MarkDown/New-HaloGETRequest.md new file mode 100644 index 0000000..f5aee86 --- /dev/null +++ b/Docs/MarkDown/New-HaloGETRequest.md @@ -0,0 +1,134 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloGETRequest + +## SYNOPSIS +Builds a request for the Halo API. + +## SYNTAX + +``` +New-HaloGETRequest [-Method] [-Resource] [-RawResult] [[-QSCollection] ] + [-AutoPaginateOff] [[-ResourceType] ] [] +``` + +## DESCRIPTION +Wrapper function to build web requests for the Halo API. + +## EXAMPLES + +### EXAMPLE 1 +``` +New-HaloGETRequest -Method "GET" -Resource "/api/Articles" +Gets all Knowledgebase Articles +``` + +## PARAMETERS + +### -Method +The HTTP request method. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Resource +The resource to send the request to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RawResult +Returns the Raw result. +Useful for file downloads + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QSCollection +A hashtable used to build the query string. + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AutoPaginateOff +Disables auto pagination. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ResourceType +The key for the results object. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the response from the web request. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloInvoice.md b/Docs/MarkDown/New-HaloInvoice.md index 363b3b0..5e08b9d 100644 --- a/Docs/MarkDown/New-HaloInvoice.md +++ b/Docs/MarkDown/New-HaloInvoice.md @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/New-HaloInvoiceBatch.md b/Docs/MarkDown/New-HaloInvoiceBatch.md new file mode 100644 index 0000000..5af0c06 --- /dev/null +++ b/Docs/MarkDown/New-HaloInvoiceBatch.md @@ -0,0 +1,122 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloInvoiceBatch + +## SYNOPSIS +Creates multiple invoices via the Halo API. + +## SYNTAX + +``` +New-HaloInvoiceBatch [-Invoices] [[-BatchSize] ] [[-BatchWait] ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Function to send a batch of invoice creation requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Invoices +Array of objects containing properties and values used to create one or more new invoices. + +```yaml +Type: Array[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +How many objects to process at once before delaying. +Default value is 100. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchWait +How long to wait between batch runs. +Default value is 1 second. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the responses from the web requests. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloItem.md b/Docs/MarkDown/New-HaloItem.md index 67ec24c..45481c4 100644 --- a/Docs/MarkDown/New-HaloItem.md +++ b/Docs/MarkDown/New-HaloItem.md @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/New-HaloItemBatch.md b/Docs/MarkDown/New-HaloItemBatch.md new file mode 100644 index 0000000..f99d327 --- /dev/null +++ b/Docs/MarkDown/New-HaloItemBatch.md @@ -0,0 +1,122 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloItemBatch + +## SYNOPSIS +Creates multiple items via the Halo API. + +## SYNTAX + +``` +New-HaloItemBatch [-Items] [[-BatchSize] ] [[-BatchWait] ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Function to send a batch of item creation requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Items +Array of objects containing properties and values used to create one or more new items. + +```yaml +Type: Array[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +How many objects to process at once before delaying. +Default value is 100. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchWait +How long to wait between batch runs. +Default value is 1 second. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the responses from the web requests. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloKBArticle.md b/Docs/MarkDown/New-HaloKBArticle.md index 7415a86..05500fc 100644 --- a/Docs/MarkDown/New-HaloKBArticle.md +++ b/Docs/MarkDown/New-HaloKBArticle.md @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/New-HaloKBArticleBatch.md b/Docs/MarkDown/New-HaloKBArticleBatch.md new file mode 100644 index 0000000..5ef866b --- /dev/null +++ b/Docs/MarkDown/New-HaloKBArticleBatch.md @@ -0,0 +1,122 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloKBArticleBatch + +## SYNOPSIS +Creates multiple knowledgebase articles via the Halo API. + +## SYNTAX + +``` +New-HaloKBArticleBatch [-KBArticles] [[-BatchSize] ] [[-BatchWait] ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +Function to send a batch of knowledgebase article creation requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -KBArticles +Array of objects containing properties and values used to create one or more new knowledgebase articles. + +```yaml +Type: Array[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +How many objects to process at once before delaying. +Default value is 100. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchWait +How long to wait between batch runs. +Default value is 1 second. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the responses from the web requests. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloOpportunity.md b/Docs/MarkDown/New-HaloOpportunity.md index e87c514..371125b 100644 --- a/Docs/MarkDown/New-HaloOpportunity.md +++ b/Docs/MarkDown/New-HaloOpportunity.md @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/New-HaloOpportunityBatch.md b/Docs/MarkDown/New-HaloOpportunityBatch.md new file mode 100644 index 0000000..1d125e8 --- /dev/null +++ b/Docs/MarkDown/New-HaloOpportunityBatch.md @@ -0,0 +1,122 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloOpportunityBatch + +## SYNOPSIS +Creates multiple opportunities via the Halo API. + +## SYNTAX + +``` +New-HaloOpportunityBatch [-Opportunitys] [[-BatchSize] ] [[-BatchWait] ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +Function to send a batch of opportunity creation requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Opportunitys +Array of objects containing properties and values used to create one or more new opportunities. + +```yaml +Type: Array[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +How many objects to process at once before delaying. +Default value is 100. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchWait +How long to wait between batch runs. +Default value is 1 second. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the responses from the web requests. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloPOSTRequest.md b/Docs/MarkDown/New-HaloPOSTRequest.md new file mode 100644 index 0000000..681a7c3 --- /dev/null +++ b/Docs/MarkDown/New-HaloPOSTRequest.md @@ -0,0 +1,89 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloPOSTRequest + +## SYNOPSIS +Sends a formatted web request to the Halo API. + +## SYNTAX + +``` +New-HaloPOSTRequest [-Object] [-Endpoint] [[-QSCollection] ] + [] +``` + +## DESCRIPTION +Wrapper function to send new or set requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Object +Object to Update / Create + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Endpoint +Endpoint to use + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -QSCollection +A hashtable used to build the query string. + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the response from the web request. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloProject.md b/Docs/MarkDown/New-HaloProject.md index 6b71e7e..5783dab 100644 --- a/Docs/MarkDown/New-HaloProject.md +++ b/Docs/MarkDown/New-HaloProject.md @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/New-HaloProjectBatch.md b/Docs/MarkDown/New-HaloProjectBatch.md new file mode 100644 index 0000000..eadb37c --- /dev/null +++ b/Docs/MarkDown/New-HaloProjectBatch.md @@ -0,0 +1,122 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloProjectBatch + +## SYNOPSIS +Creates multiple projects via the Halo API. + +## SYNTAX + +``` +New-HaloProjectBatch [-Projects] [[-BatchSize] ] [[-BatchWait] ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Function to send a batch of project creation requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Projects +Array of objects containing properties and values used to create one or more new projects. + +```yaml +Type: Array[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +How many objects to process at once before delaying. +Default value is 100. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchWait +How long to wait between batch runs. +Default value is 1 second. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the responses from the web requests. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloQuery.md b/Docs/MarkDown/New-HaloQuery.md new file mode 100644 index 0000000..c87588a --- /dev/null +++ b/Docs/MarkDown/New-HaloQuery.md @@ -0,0 +1,124 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloQuery + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-HaloQuery [-CommandName] [-Parameters] [-IsMulti] [-CommaSeparatedArrays] [-AsString] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -AsString +{{ Fill AsString Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommaSeparatedArrays +{{ Fill CommaSeparatedArrays Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CommandName +{{ Fill CommandName Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IsMulti +{{ Fill IsMulti Description }} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Parameters +{{ Fill Parameters Description }} + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.String + +### System.Collections.Hashtable + +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloQuote.md b/Docs/MarkDown/New-HaloQuote.md index e409013..3c9e86a 100644 --- a/Docs/MarkDown/New-HaloQuote.md +++ b/Docs/MarkDown/New-HaloQuote.md @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/New-HaloQuoteBatch.md b/Docs/MarkDown/New-HaloQuoteBatch.md new file mode 100644 index 0000000..784e7c8 --- /dev/null +++ b/Docs/MarkDown/New-HaloQuoteBatch.md @@ -0,0 +1,122 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloQuoteBatch + +## SYNOPSIS +Creates multiple quotes via the Halo API. + +## SYNTAX + +``` +New-HaloQuoteBatch [-Quotes] [[-BatchSize] ] [[-BatchWait] ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Function to send a batch of quote creation requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Quotes +Array of objects containing properties and values used to create one or more new quotes. + +```yaml +Type: Array[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +How many objects to process at once before delaying. +Default value is 100. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchWait +How long to wait between batch runs. +Default value is 1 second. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the responses from the web requests. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloRecurringInvoice.md b/Docs/MarkDown/New-HaloRecurringInvoice.md index cae04e4..28f6168 100644 --- a/Docs/MarkDown/New-HaloRecurringInvoice.md +++ b/Docs/MarkDown/New-HaloRecurringInvoice.md @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/New-HaloRecurringInvoiceBatch.md b/Docs/MarkDown/New-HaloRecurringInvoiceBatch.md new file mode 100644 index 0000000..76f725e --- /dev/null +++ b/Docs/MarkDown/New-HaloRecurringInvoiceBatch.md @@ -0,0 +1,122 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloRecurringInvoiceBatch + +## SYNOPSIS +Creates multiple recurring invoices via the Halo API. + +## SYNTAX + +``` +New-HaloRecurringInvoiceBatch [-RecurringInvoices] [[-BatchSize] ] [[-BatchWait] ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Function to send a batch of recurring invoice creation requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -RecurringInvoices +Array of objects containing properties and values used to create one or more new recurring invoices. + +```yaml +Type: Array[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +How many objects to process at once before delaying. +Default value is 100. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchWait +How long to wait between batch runs. +Default value is 1 second. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the responses from the web requests. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloReport.md b/Docs/MarkDown/New-HaloReport.md index cf9c949..b7dfc8d 100644 --- a/Docs/MarkDown/New-HaloReport.md +++ b/Docs/MarkDown/New-HaloReport.md @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/New-HaloReportBatch.md b/Docs/MarkDown/New-HaloReportBatch.md new file mode 100644 index 0000000..025e4b6 --- /dev/null +++ b/Docs/MarkDown/New-HaloReportBatch.md @@ -0,0 +1,122 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloReportBatch + +## SYNOPSIS +Creates multiple reports via the Halo API. + +## SYNTAX + +``` +New-HaloReportBatch [-Reports] [[-BatchSize] ] [[-BatchWait] ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Function to send a batch of report creation requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Reports +Array of objects containing properties and values used to create one or more new reports. + +```yaml +Type: Array[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +How many objects to process at once before delaying. +Default value is 100. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchWait +How long to wait between batch runs. +Default value is 1 second. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the responses from the web requests. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloService.md b/Docs/MarkDown/New-HaloService.md new file mode 100644 index 0000000..ac4425f --- /dev/null +++ b/Docs/MarkDown/New-HaloService.md @@ -0,0 +1,89 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloService + +## SYNOPSIS +Creates one or more Service(s) via the Halo API. + +## SYNTAX + +``` +New-HaloService [-Service] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Function to send a Service(s) creation request to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Service +Object or array of objects containing properties and values used to create one or more new statuses. + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the response from the web request. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloServiceBatch.md b/Docs/MarkDown/New-HaloServiceBatch.md new file mode 100644 index 0000000..4b977f4 --- /dev/null +++ b/Docs/MarkDown/New-HaloServiceBatch.md @@ -0,0 +1,122 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloServiceBatch + +## SYNOPSIS +Creates multiple services via the Halo API. + +## SYNTAX + +``` +New-HaloServiceBatch [-Services] [[-BatchSize] ] [[-BatchWait] ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Function to send a batch of service creation requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Services +Array of objects containing properties and values used to create one or more new services. + +```yaml +Type: Array[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +How many objects to process at once before delaying. +Default value is 100. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchWait +How long to wait between batch runs. +Default value is 1 second. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the responses from the web requests. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloSite.md b/Docs/MarkDown/New-HaloSite.md index fd066a9..cc0a794 100644 --- a/Docs/MarkDown/New-HaloSite.md +++ b/Docs/MarkDown/New-HaloSite.md @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/New-HaloSiteBatch.md b/Docs/MarkDown/New-HaloSiteBatch.md new file mode 100644 index 0000000..cfb07dc --- /dev/null +++ b/Docs/MarkDown/New-HaloSiteBatch.md @@ -0,0 +1,122 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloSiteBatch + +## SYNOPSIS +Creates multiple sites via the Halo API. + +## SYNTAX + +``` +New-HaloSiteBatch [-Sites] [[-BatchSize] ] [[-BatchWait] ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Function to send a batch of site creation requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Sites +Array of objects containing properties and values used to create one or more new sites. + +```yaml +Type: Array[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +How many objects to process at once before delaying. +Default value is 100. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchWait +How long to wait between batch runs. +Default value is 1 second. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the responses from the web requests. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloSoftwareLicence.md b/Docs/MarkDown/New-HaloSoftwareLicence.md new file mode 100644 index 0000000..fe3b546 --- /dev/null +++ b/Docs/MarkDown/New-HaloSoftwareLicence.md @@ -0,0 +1,89 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloSoftwareLicence + +## SYNOPSIS +Creates one or more Software Licences via the Halo API. + +## SYNTAX + +``` +New-HaloSoftwareLicence [-SoftwareLicence] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Function to send a Software Licence creation request to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -SoftwareLicence +Object or array of objects containing properties and values used to create one or more new statuses. + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the response from the web request. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloSoftwareLicenseBatch.md b/Docs/MarkDown/New-HaloSoftwareLicenseBatch.md new file mode 100644 index 0000000..960ebc8 --- /dev/null +++ b/Docs/MarkDown/New-HaloSoftwareLicenseBatch.md @@ -0,0 +1,122 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloSoftwareLicenseBatch + +## SYNOPSIS +Creates multiple software licenses via the Halo API. + +## SYNTAX + +``` +New-HaloSoftwareLicenseBatch [-SoftwareLicenses] [[-BatchSize] ] [[-BatchWait] ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Function to send a batch of software license creation requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -SoftwareLicenses +Array of objects containing properties and values used to create one or more new software licenses. + +```yaml +Type: Array[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +How many objects to process at once before delaying. +Default value is 100. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchWait +How long to wait between batch runs. +Default value is 1 second. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the responses from the web requests. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloStatus.md b/Docs/MarkDown/New-HaloStatus.md index 6b33f12..fe3a9fe 100644 --- a/Docs/MarkDown/New-HaloStatus.md +++ b/Docs/MarkDown/New-HaloStatus.md @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/New-HaloSupplier.md b/Docs/MarkDown/New-HaloSupplier.md index 45e1157..ba683bd 100644 --- a/Docs/MarkDown/New-HaloSupplier.md +++ b/Docs/MarkDown/New-HaloSupplier.md @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/New-HaloSupplierBatch.md b/Docs/MarkDown/New-HaloSupplierBatch.md new file mode 100644 index 0000000..f8e5ec9 --- /dev/null +++ b/Docs/MarkDown/New-HaloSupplierBatch.md @@ -0,0 +1,122 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloSupplierBatch + +## SYNOPSIS +Creates multiple suppliers via the Halo API. + +## SYNTAX + +``` +New-HaloSupplierBatch [-Suppliers] [[-BatchSize] ] [[-BatchWait] ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Function to send a batch of supplier creation requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Suppliers +Array of objects containing properties and values used to create one or more new suppliers. + +```yaml +Type: Array[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +How many objects to process at once before delaying. +Default value is 100. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchWait +How long to wait between batch runs. +Default value is 1 second. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the responses from the web requests. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloTab.md b/Docs/MarkDown/New-HaloTab.md new file mode 100644 index 0000000..7d7fb0f --- /dev/null +++ b/Docs/MarkDown/New-HaloTab.md @@ -0,0 +1,89 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloTab + +## SYNOPSIS +Creates one or more tabs via the Halo API. + +## SYNTAX + +``` +New-HaloTab [-Tab] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Function to send a tab creation request to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Tab +Object or array of objects containing properties and values used to create one or more new tabs. + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the response from the web request. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloTeam.md b/Docs/MarkDown/New-HaloTeam.md index 2122a5f..d4df930 100644 --- a/Docs/MarkDown/New-HaloTeam.md +++ b/Docs/MarkDown/New-HaloTeam.md @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/New-HaloTeamBatch.md b/Docs/MarkDown/New-HaloTeamBatch.md new file mode 100644 index 0000000..99b60bc --- /dev/null +++ b/Docs/MarkDown/New-HaloTeamBatch.md @@ -0,0 +1,122 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloTeamBatch + +## SYNOPSIS +Creates multiple teams via the Halo API. + +## SYNTAX + +``` +New-HaloTeamBatch [-Teams] [[-BatchSize] ] [[-BatchWait] ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Function to send a batch of team creation requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Teams +Array of objects containing properties and values used to create one or more new teams. + +```yaml +Type: Array[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +How many objects to process at once before delaying. +Default value is 100. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchWait +How long to wait between batch runs. +Default value is 1 second. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the responses from the web requests. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloTicket.md b/Docs/MarkDown/New-HaloTicket.md index 4657eaf..d24c121 100644 --- a/Docs/MarkDown/New-HaloTicket.md +++ b/Docs/MarkDown/New-HaloTicket.md @@ -30,21 +30,6 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -ReturnAll -Return all results when letting Halo batch process. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: False -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Ticket Object or array of objects containing properties and values used to create one or more new tickets. @@ -60,17 +45,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -ReturnAll +Return all results when letting Halo batch process. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -91,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/New-HaloTicketBatch.md b/Docs/MarkDown/New-HaloTicketBatch.md new file mode 100644 index 0000000..89aa1c4 --- /dev/null +++ b/Docs/MarkDown/New-HaloTicketBatch.md @@ -0,0 +1,122 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloTicketBatch + +## SYNOPSIS +Creates multiple tickets via the Halo API. + +## SYNTAX + +``` +New-HaloTicketBatch [-Tickets] [[-BatchSize] ] [[-BatchWait] ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Function to send a batch of ticket creation requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Tickets +Array of objects containing properties and values used to create one or more new tickets. + +```yaml +Type: Array[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +How many objects to process at once before delaying. +Default value is 100. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchWait +How long to wait between batch runs. +Default value is 1 second. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the responses from the web requests. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloTicketType.md b/Docs/MarkDown/New-HaloTicketType.md index be3b299..315c0f1 100644 --- a/Docs/MarkDown/New-HaloTicketType.md +++ b/Docs/MarkDown/New-HaloTicketType.md @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/New-HaloTicketTypeBatch.md b/Docs/MarkDown/New-HaloTicketTypeBatch.md new file mode 100644 index 0000000..d80abe3 --- /dev/null +++ b/Docs/MarkDown/New-HaloTicketTypeBatch.md @@ -0,0 +1,122 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloTicketTypeBatch + +## SYNOPSIS +Creates multiple ticket types via the Halo API. + +## SYNTAX + +``` +New-HaloTicketTypeBatch [-TicketTypes] [[-BatchSize] ] [[-BatchWait] ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +Function to send a batch of ticket type creation requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -TicketTypes +Array of objects containing properties and values used to create one or more new ticket types. + +```yaml +Type: Array[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +How many objects to process at once before delaying. +Default value is 100. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchWait +How long to wait between batch runs. +Default value is 1 second. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the responses from the web requests. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloUser.md b/Docs/MarkDown/New-HaloUser.md index 130daeb..fc441d4 100644 --- a/Docs/MarkDown/New-HaloUser.md +++ b/Docs/MarkDown/New-HaloUser.md @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/New-HaloUserBatch.md b/Docs/MarkDown/New-HaloUserBatch.md new file mode 100644 index 0000000..e3e9dc6 --- /dev/null +++ b/Docs/MarkDown/New-HaloUserBatch.md @@ -0,0 +1,122 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloUserBatch + +## SYNOPSIS +Creates multiple users via the Halo API. + +## SYNTAX + +``` +New-HaloUserBatch [-Users] [[-BatchSize] ] [[-BatchWait] ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Function to send a batch of user creation requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Users +Array of objects containing properties and values used to create one or more new users. + +```yaml +Type: Array[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +How many objects to process at once before delaying. +Default value is 100. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchWait +How long to wait between batch runs. +Default value is 1 second. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the responses from the web requests. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloWorkday.md b/Docs/MarkDown/New-HaloWorkday.md index 0217960..c02146e 100644 --- a/Docs/MarkDown/New-HaloWorkday.md +++ b/Docs/MarkDown/New-HaloWorkday.md @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/New-HaloWorkflow.md b/Docs/MarkDown/New-HaloWorkflow.md new file mode 100644 index 0000000..10fbc66 --- /dev/null +++ b/Docs/MarkDown/New-HaloWorkflow.md @@ -0,0 +1,89 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloWorkflow + +## SYNOPSIS +Creates one or more Workflow(s) via the Halo API. + +## SYNTAX + +``` +New-HaloWorkflow [-Workflow] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Function to send a Workflow(s) creation request to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Workflow +Object or array of objects containing properties and values used to create one or more new statuses. + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the response from the web request. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/New-HaloWorkflowBatch.md b/Docs/MarkDown/New-HaloWorkflowBatch.md new file mode 100644 index 0000000..5ea2040 --- /dev/null +++ b/Docs/MarkDown/New-HaloWorkflowBatch.md @@ -0,0 +1,122 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# New-HaloWorkflowBatch + +## SYNOPSIS +Creates multiple workflows via the Halo API. + +## SYNTAX + +``` +New-HaloWorkflowBatch [-Workflows] [[-BatchSize] ] [[-BatchWait] ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Function to send a batch of workflow creation requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Workflows +Array of objects containing properties and values used to create one or more new workflows. + +```yaml +Type: Array[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +How many objects to process at once before delaying. +Default value is 100. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchWait +How long to wait between batch runs. +Default value is 1 second. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the responses from the web requests. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/Remove-HaloAction.md b/Docs/MarkDown/Remove-HaloAction.md index 2672659..51fb719 100644 --- a/Docs/MarkDown/Remove-HaloAction.md +++ b/Docs/MarkDown/Remove-HaloAction.md @@ -12,8 +12,14 @@ Removes an action from the Halo API. ## SYNTAX +### Single ``` -Remove-HaloAction [-ActionID] [-TicketID] [-WhatIf] [-Confirm] [] +Remove-HaloAction -ActionID -TicketID [-WhatIf] [-Confirm] [] +``` + +### Batch +``` +Remove-HaloAction -Action [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -35,11 +41,11 @@ The Action ID ```yaml Type: Int64 -Parameter Sets: (All) +Parameter Sets: Single Aliases: Required: True -Position: 1 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False @@ -50,25 +56,25 @@ The Ticket ID ```yaml Type: Int64 -Parameter Sets: (All) +Parameter Sets: Single Aliases: Required: True -Position: 2 +Position: Named Default value: 0 Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Action +Object containing action id and ticket id for batch processing. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf +Type: Object +Parameter Sets: Batch +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -91,6 +97,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Remove-HaloActionBatch.md b/Docs/MarkDown/Remove-HaloActionBatch.md new file mode 100644 index 0000000..859c925 --- /dev/null +++ b/Docs/MarkDown/Remove-HaloActionBatch.md @@ -0,0 +1,123 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# Remove-HaloActionBatch + +## SYNOPSIS +Removes multiple actions via the Halo API. + +## SYNTAX + +``` +Remove-HaloActionBatch [-Actions] [[-BatchSize] ] [[-BatchWait] ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Function to send a batch of action removal requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Actions +Array of objects containing properties and values used to remove one or more actions. +This should be an array of objects containing an \`Id\` and \`TicketId\` property. + +```yaml +Type: Array[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +How many objects to process at once before delaying. +Default value is 100. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchWait +How long to wait between batch runs. +Default value is 1 second. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the responses from the web requests. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/Remove-HaloAgent.md b/Docs/MarkDown/Remove-HaloAgent.md new file mode 100644 index 0000000..92a09ca --- /dev/null +++ b/Docs/MarkDown/Remove-HaloAgent.md @@ -0,0 +1,89 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# Remove-HaloAgent + +## SYNOPSIS +Removes an agent from the Halo API. + +## SYNTAX + +``` +Remove-HaloAgent [-AgentId] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Deletes a specific agent from Halo. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -AgentId +The agent ID + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: Agent + +Required: True +Position: 1 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### A powershell object containing the response. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/Remove-HaloAgentBatch.md b/Docs/MarkDown/Remove-HaloAgentBatch.md new file mode 100644 index 0000000..d311021 --- /dev/null +++ b/Docs/MarkDown/Remove-HaloAgentBatch.md @@ -0,0 +1,123 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# Remove-HaloAgentBatch + +## SYNOPSIS +Removes multiple agents via the Halo API. + +## SYNTAX + +``` +Remove-HaloAgentBatch [-Agents] [[-BatchSize] ] [[-BatchWait] ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Function to send a batch of agent removal requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Agents +Array of objects containing properties and values used to remove one or more agents. +This should be an array of agent ids. + +```yaml +Type: Array[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +How many objects to process at once before delaying. +Default value is 100. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchWait +How long to wait between batch runs. +Default value is 1 second. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the responses from the web requests. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/Remove-HaloAssetType.md b/Docs/MarkDown/Remove-HaloAssetType.md new file mode 100644 index 0000000..fc3fb63 --- /dev/null +++ b/Docs/MarkDown/Remove-HaloAssetType.md @@ -0,0 +1,89 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# Remove-HaloAssetType + +## SYNOPSIS +Removes an Asset Type from the Halo API. + +## SYNTAX + +``` +Remove-HaloAssetType [-AssetTypeID] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Deletes a specific Asset Type from Halo. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -AssetTypeID +The AssetType ID + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### A powershell object containing the response. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/Remove-HaloCRMNote.md b/Docs/MarkDown/Remove-HaloCRMNote.md index 3e91f3d..cc42ce7 100644 --- a/Docs/MarkDown/Remove-HaloCRMNote.md +++ b/Docs/MarkDown/Remove-HaloCRMNote.md @@ -60,13 +60,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -75,14 +76,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/Remove-HaloCategory.md b/Docs/MarkDown/Remove-HaloCategory.md index 5a0c62a..eddaa57 100644 --- a/Docs/MarkDown/Remove-HaloCategory.md +++ b/Docs/MarkDown/Remove-HaloCategory.md @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/Remove-HaloClient.md b/Docs/MarkDown/Remove-HaloClient.md index 59a6ed3..6520e6b 100644 --- a/Docs/MarkDown/Remove-HaloClient.md +++ b/Docs/MarkDown/Remove-HaloClient.md @@ -36,7 +36,7 @@ The client ID ```yaml Type: Int64 Parameter Sets: (All) -Aliases: +Aliases: Client Required: True Position: 1 @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/Remove-HaloClientBatch.md b/Docs/MarkDown/Remove-HaloClientBatch.md new file mode 100644 index 0000000..74ea968 --- /dev/null +++ b/Docs/MarkDown/Remove-HaloClientBatch.md @@ -0,0 +1,123 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# Remove-HaloClientBatch + +## SYNOPSIS +Removes multiple clients via the Halo API. + +## SYNTAX + +``` +Remove-HaloClientBatch [-Clients] [[-BatchSize] ] [[-BatchWait] ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Function to send a batch of client removal requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Clients +Array of objects containing properties and values used to remove one or more clients. +This should be an array of client ids. + +```yaml +Type: Array[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +How many objects to process at once before delaying. +Default value is 100. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchWait +How long to wait between batch runs. +Default value is 1 second. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the responses from the web requests. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/Remove-HaloContract.md b/Docs/MarkDown/Remove-HaloContract.md new file mode 100644 index 0000000..2e51765 --- /dev/null +++ b/Docs/MarkDown/Remove-HaloContract.md @@ -0,0 +1,89 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# Remove-HaloContract + +## SYNOPSIS +Removes a Contract from the Halo API. + +## SYNTAX + +``` +Remove-HaloContract [-ContractID] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Deletes a specific contract from Halo. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -ContractID +The Contract ID + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### A powershell object containing the response. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/Remove-HaloItem.md b/Docs/MarkDown/Remove-HaloItem.md new file mode 100644 index 0000000..0735884 --- /dev/null +++ b/Docs/MarkDown/Remove-HaloItem.md @@ -0,0 +1,89 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# Remove-HaloItem + +## SYNOPSIS +Removes an item from the Halo API. + +## SYNTAX + +``` +Remove-HaloItem [-ItemId] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Deletes a specific item from Halo. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -ItemId +The item ID + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### A powershell object containing the response. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/Remove-HaloKBArticle.md b/Docs/MarkDown/Remove-HaloKBArticle.md new file mode 100644 index 0000000..091a618 --- /dev/null +++ b/Docs/MarkDown/Remove-HaloKBArticle.md @@ -0,0 +1,89 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# Remove-HaloKBArticle + +## SYNOPSIS +Removes a knowledgebase articles from the Halo API. + +## SYNTAX + +``` +Remove-HaloKBArticle [-KBArticleID] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Deletes a specific knowledgebase articles from Halo. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -KBArticleID +The KBArticle ID + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: KBArticle + +Required: True +Position: 1 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### A powershell object containing the response. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/Remove-HaloTicket.md b/Docs/MarkDown/Remove-HaloTicket.md index 44d5b7d..c6b92ab 100644 --- a/Docs/MarkDown/Remove-HaloTicket.md +++ b/Docs/MarkDown/Remove-HaloTicket.md @@ -36,7 +36,7 @@ The Ticket ID ```yaml Type: Int64 Parameter Sets: (All) -Aliases: +Aliases: Ticket Required: True Position: 1 @@ -45,13 +45,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/Remove-HaloTicketBatch.md b/Docs/MarkDown/Remove-HaloTicketBatch.md new file mode 100644 index 0000000..508f95d --- /dev/null +++ b/Docs/MarkDown/Remove-HaloTicketBatch.md @@ -0,0 +1,123 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# Remove-HaloTicketBatch + +## SYNOPSIS +Removes multiple tickets via the Halo API. + +## SYNTAX + +``` +Remove-HaloTicketBatch [-Tickets] [[-BatchSize] ] [[-BatchWait] ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Function to send a batch of ticket removal requests to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Tickets +Array of objects containing properties and values used to remove one or more tickets. +This should be an array of ticket ids. + +```yaml +Type: Array[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchSize +How many objects to process at once before delaying. +Default value is 100. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BatchWait +How long to wait between batch runs. +Default value is 1 second. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the responses from the web requests. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/Remove-HaloTicketRules.md b/Docs/MarkDown/Remove-HaloTicketRules.md new file mode 100644 index 0000000..d54a7e8 --- /dev/null +++ b/Docs/MarkDown/Remove-HaloTicketRules.md @@ -0,0 +1,89 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# Remove-HaloTicketRules + +## SYNOPSIS +Removes an Rule from the Halo API. + +## SYNTAX + +``` +Remove-HaloTicketRules [-RuleID] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Deletes a specific Rule from Halo. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -RuleID +The Rule ID + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: Rule_id + +Required: True +Position: 1 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### A powershell object containing the response. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/Remove-HaloUser.md b/Docs/MarkDown/Remove-HaloUser.md new file mode 100644 index 0000000..94a0621 --- /dev/null +++ b/Docs/MarkDown/Remove-HaloUser.md @@ -0,0 +1,89 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# Remove-HaloUser + +## SYNOPSIS +Removes a user from the Halo API. + +## SYNTAX + +``` +Remove-HaloUser [-UserId] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Deletes a specific user from Halo. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -UserId +The Ticket ID + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: User + +Required: True +Position: 1 +Default value: 0 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### A powershell object containing the response. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/Restore-HaloTicket.md b/Docs/MarkDown/Restore-HaloTicket.md new file mode 100644 index 0000000..91ddb6b --- /dev/null +++ b/Docs/MarkDown/Restore-HaloTicket.md @@ -0,0 +1,89 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# Restore-HaloTicket + +## SYNOPSIS +Restores a ticket using the Halo API. + +## SYNTAX + +``` +Restore-HaloTicket [-TicketId] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Restores a specific ticket or array of tickets from Halo. + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -TicketId +The Ticket id or array of ticket ids. + +```yaml +Type: Int64[] +Parameter Sets: (All) +Aliases: Ticket + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### A powershell object containing the response. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/Set-HaloAction.md b/Docs/MarkDown/Set-HaloAction.md index 100db2c..41581a4 100644 --- a/Docs/MarkDown/Set-HaloAction.md +++ b/Docs/MarkDown/Set-HaloAction.md @@ -13,7 +13,7 @@ Updates one or more actions via the Halo API. ## SYNTAX ``` -Set-HaloAction [-Action] [-WhatIf] [-Confirm] [] +Set-HaloAction [-Action] [-SkipValidation] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,17 +45,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -SkipValidation +Skip validation checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Set-HaloAgent.md b/Docs/MarkDown/Set-HaloAgent.md index cd54b06..2de3e21 100644 --- a/Docs/MarkDown/Set-HaloAgent.md +++ b/Docs/MarkDown/Set-HaloAgent.md @@ -13,7 +13,7 @@ Updates one or more agents via the Halo API. ## SYNTAX ``` -Set-HaloAgent [-Agent] [-WhatIf] [-Confirm] [] +Set-HaloAgent [-Agent] [-SkipValidation] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,17 +45,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -SkipValidation +Skip validation checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Set-HaloAppointment.md b/Docs/MarkDown/Set-HaloAppointment.md index d2011e6..9e9e08e 100644 --- a/Docs/MarkDown/Set-HaloAppointment.md +++ b/Docs/MarkDown/Set-HaloAppointment.md @@ -13,7 +13,7 @@ Updates one or more appointments via the Halo API. ## SYNTAX ``` -Set-HaloAppointment [-Appointment] [-WhatIf] [-Confirm] [] +Set-HaloAppointment [-Appointment] [-SkipValidation] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,17 +45,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -SkipValidation +Skip validation checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Set-HaloAsset.md b/Docs/MarkDown/Set-HaloAsset.md index ad16cbc..94f5357 100644 --- a/Docs/MarkDown/Set-HaloAsset.md +++ b/Docs/MarkDown/Set-HaloAsset.md @@ -13,7 +13,7 @@ Updates one or more assets via the Halo API. ## SYNTAX ``` -Set-HaloAsset [-Asset] [-WhatIf] [-Confirm] [] +Set-HaloAsset [-Asset] [-SkipValidation] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,17 +45,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -SkipValidation +Skip validation checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Set-HaloAssetType.md b/Docs/MarkDown/Set-HaloAssetType.md new file mode 100644 index 0000000..3d8daed --- /dev/null +++ b/Docs/MarkDown/Set-HaloAssetType.md @@ -0,0 +1,104 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# Set-HaloAssetType + +## SYNOPSIS +Updates an asset type via the Halo API. + +## SYNTAX + +``` +Set-HaloAssetType [-AssetType] [-SkipValidation] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Function to send an asset type update request to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -AssetType +Object containing properties and values used to update an existing asset type. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SkipValidation +Skip validation checks. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the response from the web request. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/Set-HaloAttachment.md b/Docs/MarkDown/Set-HaloAttachment.md index 448d376..a3bf5f6 100644 --- a/Docs/MarkDown/Set-HaloAttachment.md +++ b/Docs/MarkDown/Set-HaloAttachment.md @@ -13,7 +13,7 @@ Updates an attachment via the Halo API. ## SYNTAX ``` -Set-HaloAttachment [-Attachment] [-WhatIf] [-Confirm] [] +Set-HaloAttachment [-Attachment] [-SkipValidation] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,17 +45,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -SkipValidation +Skip validation checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Set-HaloBillingTemplate.md b/Docs/MarkDown/Set-HaloBillingTemplate.md index 4df314a..c5ffca7 100644 --- a/Docs/MarkDown/Set-HaloBillingTemplate.md +++ b/Docs/MarkDown/Set-HaloBillingTemplate.md @@ -13,7 +13,7 @@ Updates a billing template via the Halo API. ## SYNTAX ``` -Set-HaloBillingTemplate [-Template] [-WhatIf] [-Confirm] [] +Set-HaloBillingTemplate [-Template] [-SkipValidation] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,17 +45,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -SkipValidation +Skip validation checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Set-HaloCRMNote.md b/Docs/MarkDown/Set-HaloCRMNote.md index 09763ba..28437ec 100644 --- a/Docs/MarkDown/Set-HaloCRMNote.md +++ b/Docs/MarkDown/Set-HaloCRMNote.md @@ -13,7 +13,7 @@ Updates a CRM note via the Halo API. ## SYNTAX ``` -Set-HaloCRMNote [-CRMNote] [-WhatIf] [-Confirm] [] +Set-HaloCRMNote [-CRMNote] [-SkipValidation] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -34,7 +34,7 @@ PS C:\> {{ Add example code here }} Object containing properties and values used to update an existing CRM note. ```yaml -Type: PSObject +Type: Object Parameter Sets: (All) Aliases: @@ -45,17 +45,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -SkipValidation +Skip validation checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Set-HaloCategory.md b/Docs/MarkDown/Set-HaloCategory.md index e05f064..b9afd07 100644 --- a/Docs/MarkDown/Set-HaloCategory.md +++ b/Docs/MarkDown/Set-HaloCategory.md @@ -13,7 +13,7 @@ Updates a Category via the Halo API. ## SYNTAX ``` -Set-HaloCategory [-Category] [-WhatIf] [-Confirm] [] +Set-HaloCategory [-Category] [-SkipValidation] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,17 +45,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -SkipValidation +Skip validation checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Set-HaloClient.md b/Docs/MarkDown/Set-HaloClient.md index 3e8bbe7..904be38 100644 --- a/Docs/MarkDown/Set-HaloClient.md +++ b/Docs/MarkDown/Set-HaloClient.md @@ -13,7 +13,7 @@ Updates one or more clients via the Halo API. ## SYNTAX ``` -Set-HaloClient [-Client] [-WhatIf] [-Confirm] [] +Set-HaloClient [-Client] [-SkipValidation] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,17 +45,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -SkipValidation +Skip validation checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Set-HaloContract.md b/Docs/MarkDown/Set-HaloContract.md index 2bb0181..49a24cd 100644 --- a/Docs/MarkDown/Set-HaloContract.md +++ b/Docs/MarkDown/Set-HaloContract.md @@ -13,7 +13,7 @@ Updates one or more contracts via the Halo API. ## SYNTAX ``` -Set-HaloContract [-Contract] [-WhatIf] [-Confirm] [] +Set-HaloContract [-Contract] [-SkipValidation] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,17 +45,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -SkipValidation +Skip validation checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Set-HaloCustomButton.md b/Docs/MarkDown/Set-HaloCustomButton.md index 64aec12..48ee98b 100644 --- a/Docs/MarkDown/Set-HaloCustomButton.md +++ b/Docs/MarkDown/Set-HaloCustomButton.md @@ -13,7 +13,7 @@ Updates a custom button via the Halo API. ## SYNTAX ``` -Set-HaloCustomButton [-CustomButton] [-WhatIf] [-Confirm] [] +Set-HaloCustomButton [-CustomButton] [-SkipValidation] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,17 +45,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -SkipValidation +Skip validation checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Set-HaloFAQList.md b/Docs/MarkDown/Set-HaloFAQList.md index c0767bf..9f1d0cf 100644 --- a/Docs/MarkDown/Set-HaloFAQList.md +++ b/Docs/MarkDown/Set-HaloFAQList.md @@ -13,7 +13,7 @@ Updates a FAQ List via the Halo API. ## SYNTAX ``` -Set-HaloFAQList [-FAQList] [-WhatIf] [-Confirm] [] +Set-HaloFAQList [-FAQList] [-SkipValidation] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,17 +45,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -SkipValidation +Skip validation checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Set-HaloInvoice.md b/Docs/MarkDown/Set-HaloInvoice.md index 32852e7..fb36416 100644 --- a/Docs/MarkDown/Set-HaloInvoice.md +++ b/Docs/MarkDown/Set-HaloInvoice.md @@ -13,7 +13,7 @@ Updates one or more invoices via the Halo API. ## SYNTAX ``` -Set-HaloInvoice [-Invoice] [-WhatIf] [-Confirm] [] +Set-HaloInvoice [-Invoice] [-SkipValidation] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,17 +45,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -SkipValidation +Skip validation checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Set-HaloItem.md b/Docs/MarkDown/Set-HaloItem.md index 6a97c8f..b8406b5 100644 --- a/Docs/MarkDown/Set-HaloItem.md +++ b/Docs/MarkDown/Set-HaloItem.md @@ -13,7 +13,7 @@ Updates one or more items via the Halo API. ## SYNTAX ``` -Set-HaloItem [-Item] [-WhatIf] [-Confirm] [] +Set-HaloItem [-Item] [-SkipValidation] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,17 +45,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -SkipValidation +Skip validation checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Set-HaloKBArticle.md b/Docs/MarkDown/Set-HaloKBArticle.md index 6597646..255d3d9 100644 --- a/Docs/MarkDown/Set-HaloKBArticle.md +++ b/Docs/MarkDown/Set-HaloKBArticle.md @@ -13,7 +13,7 @@ Updates one or more knowledgebase articles via the Halo API. ## SYNTAX ``` -Set-HaloKBArticle [-KBArticle] [-WhatIf] [-Confirm] [] +Set-HaloKBArticle [-KBArticle] [-SkipValidation] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,17 +45,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -SkipValidation +Skip validation checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Set-HaloOpportunity.md b/Docs/MarkDown/Set-HaloOpportunity.md index b978dce..2d51cd3 100644 --- a/Docs/MarkDown/Set-HaloOpportunity.md +++ b/Docs/MarkDown/Set-HaloOpportunity.md @@ -13,7 +13,7 @@ Updates one or more opportunities via the Halo API. ## SYNTAX ``` -Set-HaloOpportunity [-Opportunity] [-WhatIf] [-Confirm] [] +Set-HaloOpportunity [-Opportunity] [-SkipValidation] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,17 +45,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -SkipValidation +Skip validation checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Set-HaloProject.md b/Docs/MarkDown/Set-HaloProject.md index 56f73a8..778c398 100644 --- a/Docs/MarkDown/Set-HaloProject.md +++ b/Docs/MarkDown/Set-HaloProject.md @@ -13,7 +13,7 @@ Updates one or more projects via the Halo API. ## SYNTAX ``` -Set-HaloProject [-Project] [-WhatIf] [-Confirm] [] +Set-HaloProject [-Project] [-SkipValidation] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,17 +45,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -SkipValidation +Skip validation checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Set-HaloQuote.md b/Docs/MarkDown/Set-HaloQuote.md index e7b5e98..2cf6612 100644 --- a/Docs/MarkDown/Set-HaloQuote.md +++ b/Docs/MarkDown/Set-HaloQuote.md @@ -13,7 +13,7 @@ Updates one or more quotes via the Halo API. ## SYNTAX ``` -Set-HaloQuote [-Quote] [-WhatIf] [-Confirm] [] +Set-HaloQuote [-Quote] [-SkipValidation] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,17 +45,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -SkipValidation +Skip validation checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Set-HaloRecurringInvoice.md b/Docs/MarkDown/Set-HaloRecurringInvoice.md index 7c3bd10..3f383fa 100644 --- a/Docs/MarkDown/Set-HaloRecurringInvoice.md +++ b/Docs/MarkDown/Set-HaloRecurringInvoice.md @@ -13,7 +13,8 @@ Updates a recurring invoice via the Halo API. ## SYNTAX ``` -Set-HaloRecurringInvoice [-RecurringInvoice] [-WhatIf] [-Confirm] [] +Set-HaloRecurringInvoice [-RecurringInvoice] [-SkipValidation] [-WhatIf] [-Confirm] + [] ``` ## DESCRIPTION @@ -45,17 +46,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -SkipValidation +Skip validation checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,6 +77,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Set-HaloRecurringTemplate.md b/Docs/MarkDown/Set-HaloRecurringTemplate.md index 147cf08..09073f3 100644 --- a/Docs/MarkDown/Set-HaloRecurringTemplate.md +++ b/Docs/MarkDown/Set-HaloRecurringTemplate.md @@ -45,13 +45,14 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: wi Required: False Position: Named @@ -60,14 +61,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Shows what would happen if the cmdlet runs. -The cmdlet is not run. +### -Confirm +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi +Aliases: cf Required: False Position: Named diff --git a/Docs/MarkDown/Set-HaloReport.md b/Docs/MarkDown/Set-HaloReport.md index 7936172..de48bce 100644 --- a/Docs/MarkDown/Set-HaloReport.md +++ b/Docs/MarkDown/Set-HaloReport.md @@ -13,7 +13,7 @@ Updates one or more reports via the Halo API. ## SYNTAX ``` -Set-HaloReport [-Report] [-WhatIf] [-Confirm] [] +Set-HaloReport [-Report] [-SkipValidation] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,17 +45,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -SkipValidation +Skip validation checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Set-HaloSite.md b/Docs/MarkDown/Set-HaloSite.md index 6d10369..98755ef 100644 --- a/Docs/MarkDown/Set-HaloSite.md +++ b/Docs/MarkDown/Set-HaloSite.md @@ -13,7 +13,7 @@ Updates one or more sites via the Halo API. ## SYNTAX ``` -Set-HaloSite [-Site] [-WhatIf] [-Confirm] [] +Set-HaloSite [-Site] [-SkipValidation] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,17 +45,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -SkipValidation +Skip validation checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Set-HaloSoftwareLicence.md b/Docs/MarkDown/Set-HaloSoftwareLicence.md new file mode 100644 index 0000000..5b5ed4b --- /dev/null +++ b/Docs/MarkDown/Set-HaloSoftwareLicence.md @@ -0,0 +1,105 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# Set-HaloSoftwareLicence + +## SYNOPSIS +Updates one or more software Licences via the Halo API. + +## SYNTAX + +``` +Set-HaloSoftwareLicence [-SoftwareLicence] [-SkipValidation] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +Function to send a software Licence update request to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -SoftwareLicence +Object or array of objects containing properties and values used to update one or more existing statuses. + +```yaml +Type: Object[] +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SkipValidation +Skip validation checks. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the response from the web request. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/Set-HaloStatus.md b/Docs/MarkDown/Set-HaloStatus.md index d8057d3..f3a21e7 100644 --- a/Docs/MarkDown/Set-HaloStatus.md +++ b/Docs/MarkDown/Set-HaloStatus.md @@ -13,7 +13,7 @@ Updates one or more statuses via the Halo API. ## SYNTAX ``` -Set-HaloStatus [-Status] [-WhatIf] [-Confirm] [] +Set-HaloStatus [-Status] [-SkipValidation] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,17 +45,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -SkipValidation +Skip validation checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Set-HaloSupplier.md b/Docs/MarkDown/Set-HaloSupplier.md index 1fa0986..5c1d2c7 100644 --- a/Docs/MarkDown/Set-HaloSupplier.md +++ b/Docs/MarkDown/Set-HaloSupplier.md @@ -13,7 +13,7 @@ Updates one or more suppliers via the Halo API. ## SYNTAX ``` -Set-HaloSupplier [-Supplier] [-WhatIf] [-Confirm] [] +Set-HaloSupplier [-Supplier] [-SkipValidation] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,17 +45,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -SkipValidation +Skip validation checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Set-HaloTeam.md b/Docs/MarkDown/Set-HaloTeam.md index 3337d43..c86453b 100644 --- a/Docs/MarkDown/Set-HaloTeam.md +++ b/Docs/MarkDown/Set-HaloTeam.md @@ -13,7 +13,7 @@ Updates one or more teams via the Halo API. ## SYNTAX ``` -Set-HaloTeam [-Team] [-WhatIf] [-Confirm] [] +Set-HaloTeam [-Team] [-SkipValidation] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,17 +45,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -SkipValidation +Skip validation checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Set-HaloTicket.md b/Docs/MarkDown/Set-HaloTicket.md index 2a0882b..c428e5f 100644 --- a/Docs/MarkDown/Set-HaloTicket.md +++ b/Docs/MarkDown/Set-HaloTicket.md @@ -13,7 +13,7 @@ Updates one or more tickets via the Halo API. ## SYNTAX ``` -Set-HaloTicket [-Ticket] [-WhatIf] [-Confirm] [] +Set-HaloTicket [-Ticket] [-SkipValidation] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,17 +45,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -SkipValidation +Skip validation checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Set-HaloTicketRules.md b/Docs/MarkDown/Set-HaloTicketRules.md new file mode 100644 index 0000000..6b6da6f --- /dev/null +++ b/Docs/MarkDown/Set-HaloTicketRules.md @@ -0,0 +1,104 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# Set-HaloTicketRules + +## SYNOPSIS +Updates a Rule via the Halo API. + +## SYNTAX + +``` +Set-HaloTicketRules [-Rule] [-SkipValidation] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +Function to send an Rule update request to the Halo API + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Rule +Object containing properties and values used to update an existing knowedgebase article. + +```yaml +Type: Object +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -SkipValidation +Skip validation checks. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +## OUTPUTS + +### Outputs an object containing the response from the web request. +## NOTES + +## RELATED LINKS diff --git a/Docs/MarkDown/Set-HaloTicketType.md b/Docs/MarkDown/Set-HaloTicketType.md index ac82f07..9f4aa5d 100644 --- a/Docs/MarkDown/Set-HaloTicketType.md +++ b/Docs/MarkDown/Set-HaloTicketType.md @@ -13,7 +13,7 @@ Updates one or more ticket types via the Halo API. ## SYNTAX ``` -Set-HaloTicketType [-TicketType] [-WhatIf] [-Confirm] [] +Set-HaloTicketType [-TicketType] [-SkipValidation] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,17 +45,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -SkipValidation +Skip validation checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Set-HaloUser.md b/Docs/MarkDown/Set-HaloUser.md index 7bf3f0c..45885c2 100644 --- a/Docs/MarkDown/Set-HaloUser.md +++ b/Docs/MarkDown/Set-HaloUser.md @@ -13,7 +13,7 @@ Updates one or more users via the Halo API. ## SYNTAX ``` -Set-HaloUser [-User] [-WhatIf] [-Confirm] [] +Set-HaloUser [-User] [-SkipValidation] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,17 +45,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -SkipValidation +Skip validation checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Set-HaloWorkday.md b/Docs/MarkDown/Set-HaloWorkday.md index 1fa9f43..2ce2233 100644 --- a/Docs/MarkDown/Set-HaloWorkday.md +++ b/Docs/MarkDown/Set-HaloWorkday.md @@ -13,7 +13,7 @@ Updates a workday via the Halo API. ## SYNTAX ``` -Set-HaloWorkday [-Workday] [-WhatIf] [-Confirm] [] +Set-HaloWorkday [-Workday] [-SkipValidation] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -45,17 +45,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -SkipValidation +Skip validation checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` @@ -76,6 +76,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### CommonParameters This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). diff --git a/Docs/MarkDown/Write-Success.md b/Docs/MarkDown/Write-Success.md new file mode 100644 index 0000000..4eaeb30 --- /dev/null +++ b/Docs/MarkDown/Write-Success.md @@ -0,0 +1,60 @@ +--- +external help file: HaloAPI-help.xml +Module Name: HaloAPI +online version: +schema: 2.0.0 +--- + +# Write-Success + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Write-Success [-Message] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Message +{{ Fill Message Description }} + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/Docs/en_GB/HaloAPI-help.xml b/Docs/en_GB/HaloAPI-help.xml index 4db494e..30d25c8 100644 --- a/Docs/en_GB/HaloAPI-help.xml +++ b/Docs/en_GB/HaloAPI-help.xml @@ -874,6 +874,50 @@ This logs into Halo using the Client Credentials authorisation flow. False + + ShowAll + + Show all agents, including those that have been deleted. + + + SwitchParameter + + + False + + + IncludeAPIAgents + + Include API agents in the response. + + + SwitchParameter + + + False + + + CanEditOnly + + Show only agents the API user has permissions to edit. + + + SwitchParameter + + + False + + + IncludeNamedCount + + Include counts of named license consumption in the response. + + + SwitchParameter + + + False + @@ -1033,6 +1077,54 @@ This logs into Halo using the Client Credentials authorisation flow. False + + ShowAll + + Show all agents, including those that have been deleted. + + SwitchParameter + + SwitchParameter + + + False + + + IncludeAPIAgents + + Include API agents in the response. + + SwitchParameter + + SwitchParameter + + + False + + + CanEditOnly + + Show only agents the API user has permissions to edit. + + SwitchParameter + + SwitchParameter + + + False + + + IncludeNamedCount + + Include counts of named license consumption in the response. + + SwitchParameter + + SwitchParameter + + + False + @@ -4109,6 +4201,28 @@ This logs into Halo using the Client Credentials authorisation flow. 0 + + PostedOnly + + Filter for posted invoices only. + + + SwitchParameter + + + False + + + NotPostedOnly + + Filter for non-posted invoices only. + + + SwitchParameter + + + False + @@ -4352,6 +4466,30 @@ This logs into Halo using the Client Credentials authorisation flow. 0 + + PostedOnly + + Filter for posted invoices only. + + SwitchParameter + + SwitchParameter + + + False + + + NotPostedOnly + + Filter for non-posted invoices only. + + SwitchParameter + + SwitchParameter + + + False + @@ -5307,76 +5445,6 @@ This logs into Halo using the Client Credentials authorisation flow. - - - Get-HaloNullObject - Get - HaloNullObject - - Nulls all values of an object - - - - Provides an null object for use in provisioning items in the Halo API - - - - Get-HaloNullObject - - NullObject - - {{ Fill NullObject Description }} - - PSObject - - PSObject - - - None - - - - - - NullObject - - {{ Fill NullObject Description }} - - PSObject - - PSObject - - - None - - - - - - - A powershell object containing the response. - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - Get-HaloObjectTemplate @@ -14389,6 +14457,17 @@ This logs into Halo using the Client Credentials authorisation flow. False + + Deleted + + Return deleted tickets only. + + + SwitchParameter + + + False + @@ -15244,6 +15323,18 @@ This logs into Halo using the Client Credentials authorisation flow. False + + Deleted + + Return deleted tickets only. + + SwitchParameter + + SwitchParameter + + + False + @@ -15310,6 +15401,17 @@ This logs into Halo using the Client Credentials authorisation flow. False + + IncludeConfig + + Include all related configuration in the result. + + + SwitchParameter + + + False + Get-HaloTicketType @@ -15458,6 +15560,18 @@ This logs into Halo using the Client Credentials authorisation flow. False + + IncludeConfig + + Include all related configuration in the result. + + SwitchParameter + + SwitchParameter + + + False + @@ -16456,126 +16570,56 @@ This logs into Halo using the Client Credentials authorisation flow. - Get-TokenExpiry - Get - TokenExpiry + Invoke-HaloRequest + Invoke + HaloRequest - Calculates and returns the expiry date/time of a Halo token. + Sends a request to the Halo API. - Takes the expires in time for an auth token and returns a PowerShell date/time object containing the expiry date/time of the token. + Wrapper function to send web requests to the Halo API. - Get-TokenExpiry - - ExpiresIn + Invoke-HaloRequest + + WebRequestParams + + Hashtable containing the web request parameters. + + Hashtable + + Hashtable + + + None + + + RawResult - Timestamp value for token expiry. e.g 3600 + Returns the Raw result. Useful for file downloads. - Int64 - Int64 + SwitchParameter - 0 + False - - ExpiresIn + + WebRequestParams - Timestamp value for token expiry. e.g 3600 + Hashtable containing the web request parameters. - Int64 + Hashtable - Int64 + Hashtable - 0 - - - - - - - A powershell date/time object representing the token expiry. - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - Invoke-HaloRequest - Invoke - HaloRequest - - Sends a request to the Halo API. - - - - Wrapper function to send web requests to the Halo API. - - - - Invoke-HaloRequest - - WebRequestParams - - Hashtable containing the web request parameters. - - Hashtable - - Hashtable - - - None - - - RawResult - - Returns the Raw result. Useful for file downloads. - - - SwitchParameter - - - False - - - - - - WebRequestParams - - Hashtable containing the web request parameters. - - Hashtable - - Hashtable - - - None + None RawResult @@ -17895,46 +17939,92 @@ This logs into Halo using the Client Credentials authorisation flow. - New-HaloDELETERequest + New-HaloFAQList New - HaloDELETERequest + HaloFAQList - Sends a formatted web request to the Halo API. + Creates a FAQ List article via the Halo API. - Wrapper function to send delete requests to the Halo API + Function to send a FAQ list creation request to the Halo API - New-HaloDELETERequest + New-HaloFAQList - Resource + FAQList - Endpoint for Delete Request + Object containing properties and values used to create a new knowledgebase article. - String + Object - String + Object None + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + - Resource + FAQList - Endpoint for Delete Request + Object containing properties and values used to create a new knowledgebase article. - String + Object - String + Object None + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + @@ -17965,35 +18055,46 @@ This logs into Halo using the Client Credentials authorisation flow. - New-HaloError + New-HaloInvoice New - HaloError + HaloInvoice - {{ Fill in the Synopsis }} + Creates one or more invoices via the Halo API. - {{ Fill in the Description }} + Function to send an invoice creation request to the Halo API - New-HaloError - - ErrorRecord + New-HaloInvoice + + Invoice - {{ Fill ErrorRecord Description }} + Object or array of objects containing properties and values used to create one or more new invoices. - ErrorRecord + Object[] - ErrorRecord + Object[] None - - HasResponse + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm - {{ Fill HasResponse Description }} + Prompts you for confirmation before running the cmdlet. SwitchParameter @@ -18004,22 +18105,22 @@ This logs into Halo using the Client Credentials authorisation flow. - - ErrorRecord + + Invoice - {{ Fill ErrorRecord Description }} + Object or array of objects containing properties and values used to create one or more new invoices. - ErrorRecord + Object[] - ErrorRecord + Object[] None - - HasResponse + + WhatIf - {{ Fill HasResponse Description }} + Shows what would happen if the cmdlet runs. The cmdlet is not run. SwitchParameter @@ -18028,21 +18129,24 @@ This logs into Halo using the Client Credentials authorisation flow. False - - - - - None - + + Confirm - + Prompts you for confirmation before running the cmdlet. - - + SwitchParameter + + SwitchParameter + + + False + + + - System.Object + Outputs an object containing the response from the web request. @@ -18067,27 +18171,27 @@ This logs into Halo using the Client Credentials authorisation flow. - New-HaloFAQList + New-HaloItem New - HaloFAQList + HaloItem - Creates a FAQ List article via the Halo API. + Creates one or more items via the Halo API. - Function to send a FAQ list creation request to the Halo API + Function to send an item creation request to the Halo API - New-HaloFAQList + New-HaloItem - FAQList + Item - Object containing properties and values used to create a new knowledgebase article. + Object or array of objects containing properties and values used to create one or more new items. - Object + Object[] - Object + Object[] None @@ -18118,13 +18222,13 @@ This logs into Halo using the Client Credentials authorisation flow. - FAQList + Item - Object containing properties and values used to create a new knowledgebase article. + Object or array of objects containing properties and values used to create one or more new items. - Object + Object[] - Object + Object[] None @@ -18183,473 +18287,52 @@ This logs into Halo using the Client Credentials authorisation flow. - New-HaloGETRequest + New-HaloKBArticle New - HaloGETRequest + HaloKBArticle - Builds a request for the Halo API. + Creates one or more knowledgebase articles via the Halo API. - Wrapper function to build web requests for the Halo API. + Function to send a knowledgebase article creation request to the Halo API - New-HaloGETRequest + New-HaloKBArticle - Method - - The HTTP request method. - - String - - String - - - None - - - Resource + KBArticle - The resource to send the request to. + Object or array of objects containing properties and values used to create one or more new knowledgebase articles. - String + Object[] - String + Object[] None - - QSCollection + + WhatIf - A hashtable used to build the query string. + Shows what would happen if the cmdlet runs. The cmdlet is not run. - Hashtable - Hashtable + SwitchParameter - None + False - - ResourceType + + Confirm - The key for the results object. + Prompts you for confirmation before running the cmdlet. - String - String + SwitchParameter - None - - - RawResult - - Returns the Raw result. Useful for file downloads - - - SwitchParameter - - - False - - - AutoPaginateOff - - Disables auto pagination. - - - SwitchParameter - - - False - - - - - - Method - - The HTTP request method. - - String - - String - - - None - - - Resource - - The resource to send the request to. - - String - - String - - - None - - - RawResult - - Returns the Raw result. Useful for file downloads - - SwitchParameter - - SwitchParameter - - - False - - - QSCollection - - A hashtable used to build the query string. - - Hashtable - - Hashtable - - - None - - - AutoPaginateOff - - Disables auto pagination. - - SwitchParameter - - SwitchParameter - - - False - - - ResourceType - - The key for the results object. - - String - - String - - - None - - - - - - - Outputs an object containing the response from the web request. - - - - - - - - - - - - - - -------------------------- EXAMPLE 1 -------------------------- - New-HaloGETRequest -Method "GET" -Resource "/api/Articles" -Gets all Knowledgebase Articles - - - - - - - - - - New-HaloInvoice - New - HaloInvoice - - Creates one or more invoices via the Halo API. - - - - Function to send an invoice creation request to the Halo API - - - - New-HaloInvoice - - Invoice - - Object or array of objects containing properties and values used to create one or more new invoices. - - Object[] - - Object[] - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - - - - Invoice - - Object or array of objects containing properties and values used to create one or more new invoices. - - Object[] - - Object[] - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - Outputs an object containing the response from the web request. - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - New-HaloItem - New - HaloItem - - Creates one or more items via the Halo API. - - - - Function to send an item creation request to the Halo API - - - - New-HaloItem - - Item - - Object or array of objects containing properties and values used to create one or more new items. - - Object[] - - Object[] - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - - - - Item - - Object or array of objects containing properties and values used to create one or more new items. - - Object[] - - Object[] - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - Outputs an object containing the response from the web request. - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - New-HaloKBArticle - New - HaloKBArticle - - Creates one or more knowledgebase articles via the Halo API. - - - - Function to send a knowledgebase article creation request to the Halo API - - - - New-HaloKBArticle - - KBArticle - - Object or array of objects containing properties and values used to create one or more new knowledgebase articles. - - Object[] - - Object[] - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False + False @@ -18834,270 +18517,37 @@ Gets all Knowledgebase Articles - - - New-HaloPOSTRequest - New - HaloPOSTRequest - - Sends a formatted web request to the Halo API. - - - - Wrapper function to send new or set requests to the Halo API - - - - New-HaloPOSTRequest - - Object - - Object to Update / Create - - Object[] - - Object[] - - - None - - - Endpoint - - Endpoint to use - - String - - String - - - None - - - - - - Object - - Object to Update / Create - - Object[] - - Object[] - - - None - - - Endpoint - - Endpoint to use - - String - - String - - - None - - - - - - - Outputs an object containing the response from the web request. - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - New-HaloProject New HaloProject - Creates one or more projects via the Halo API. - - - - Function to send a project creation request to the Halo API - - - - New-HaloProject - - Project - - Object or array of objects containing properties and values used to create one or more new projects. - - Object[] - - Object[] - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - - SwitchParameter - - - False - - - - - - Project - - Object or array of objects containing properties and values used to create one or more new projects. - - Object[] - - Object[] - - - None - - - WhatIf - - Shows what would happen if the cmdlet runs. The cmdlet is not run. - - SwitchParameter - - SwitchParameter - - - False - - - Confirm - - Prompts you for confirmation before running the cmdlet. - - SwitchParameter - - SwitchParameter - - - False - - - - - - - Outputs an object containing the response from the web request. - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - - - - New-HaloQuery - New - HaloQuery - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - New-HaloQuery - - CommandName - - {{ Fill CommandName Description }} - - String - - String - - - None - + Creates one or more projects via the Halo API. + + + + Function to send a project creation request to the Halo API + + + + New-HaloProject - Parameters + Project - {{ Fill Parameters Description }} + Object or array of objects containing properties and values used to create one or more new projects. - Hashtable + Object[] - Hashtable + Object[] None - - AsString - - {{ Fill AsString Description }} - - - SwitchParameter - - - False - - - CommaSeparatedArrays + + WhatIf - {{ Fill CommaSeparatedArrays Description }} + Shows what would happen if the cmdlet runs. The cmdlet is not run. SwitchParameter @@ -19105,10 +18555,10 @@ Gets all Knowledgebase Articles False - - IsMulti + + Confirm - {{ Fill IsMulti Description }} + Prompts you for confirmation before running the cmdlet. SwitchParameter @@ -19119,22 +18569,22 @@ Gets all Knowledgebase Articles - - AsString + + Project - {{ Fill AsString Description }} + Object or array of objects containing properties and values used to create one or more new projects. - SwitchParameter + Object[] - SwitchParameter + Object[] - False + None - - CommaSeparatedArrays + + WhatIf - {{ Fill CommaSeparatedArrays Description }} + Shows what would happen if the cmdlet runs. The cmdlet is not run. SwitchParameter @@ -19143,22 +18593,10 @@ Gets all Knowledgebase Articles False - - CommandName - - {{ Fill CommandName Description }} - - String - - String - - - None - - - IsMulti + + Confirm - {{ Fill IsMulti Description }} + Prompts you for confirmation before running the cmdlet. SwitchParameter @@ -19167,41 +18605,12 @@ Gets all Knowledgebase Articles False - - Parameters - - {{ Fill Parameters Description }} - - Hashtable - - Hashtable - - - None - - - - - None - - - - - - + - System.String - - - - - - - - System.Collections.Hashtable + Outputs an object containing the response from the web request. @@ -20063,6 +19472,17 @@ Gets all Knowledgebase Articles None + + ReturnAll + + Return all results when letting Halo batch process. + + + SwitchParameter + + + False + WhatIf @@ -20100,6 +19520,18 @@ Gets all Knowledgebase Articles None + + ReturnAll + + Return all results when letting Halo batch process. + + SwitchParameter + + SwitchParameter + + + False + WhatIf @@ -20515,7 +19947,7 @@ Gets all Knowledgebase Articles Remove-HaloAction - + ActionID The Action ID @@ -20527,7 +19959,7 @@ Gets all Knowledgebase Articles 0 - + TicketID The Ticket ID @@ -20562,9 +19994,46 @@ Gets all Knowledgebase Articles False + + Remove-HaloAction + + Action + + Object containing action id and ticket id for batch processing. + + Object + + Object + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + - + ActionID The Action ID @@ -20576,7 +20045,7 @@ Gets all Knowledgebase Articles 0 - + TicketID The Ticket ID @@ -20588,6 +20057,18 @@ Gets all Knowledgebase Articles 0 + + Action + + Object containing action id and ticket id for batch processing. + + Object + + Object + + + None + WhatIf @@ -20771,7 +20252,7 @@ Gets all Knowledgebase Articles Remove-HaloClient - + ClientID The client ID @@ -20808,7 +20289,7 @@ Gets all Knowledgebase Articles - + ClientID The client ID @@ -21027,7 +20508,7 @@ Gets all Knowledgebase Articles Remove-HaloTicket - + TicketID The Ticket ID @@ -21064,7 +20545,7 @@ Gets all Knowledgebase Articles - + TicketID The Ticket ID @@ -21155,6 +20636,17 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + + SwitchParameter + + + False + WhatIf @@ -21192,6 +20684,18 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + SwitchParameter + + SwitchParameter + + + False + WhatIf @@ -21271,6 +20775,17 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + + SwitchParameter + + + False + WhatIf @@ -21308,6 +20823,18 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + SwitchParameter + + SwitchParameter + + + False + WhatIf @@ -21387,6 +20914,17 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + + SwitchParameter + + + False + WhatIf @@ -21424,6 +20962,18 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + SwitchParameter + + SwitchParameter + + + False + WhatIf @@ -21503,6 +21053,17 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + + SwitchParameter + + + False + WhatIf @@ -21540,6 +21101,18 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + SwitchParameter + + SwitchParameter + + + False + WhatIf @@ -21619,6 +21192,17 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + + SwitchParameter + + + False + WhatIf @@ -21654,7 +21238,19 @@ Gets all Knowledgebase Articles PSObject - None + None + + + SkipValidation + + Skip validation checks. + + SwitchParameter + + SwitchParameter + + + False WhatIf @@ -21735,6 +21331,17 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + + SwitchParameter + + + False + WhatIf @@ -21772,6 +21379,18 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + SwitchParameter + + SwitchParameter + + + False + WhatIf @@ -21851,6 +21470,17 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + + SwitchParameter + + + False + WhatIf @@ -21888,6 +21518,18 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + SwitchParameter + + SwitchParameter + + + False + WhatIf @@ -21967,6 +21609,17 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + + SwitchParameter + + + False + WhatIf @@ -22004,6 +21657,18 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + SwitchParameter + + SwitchParameter + + + False + WhatIf @@ -22083,6 +21748,17 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + + SwitchParameter + + + False + WhatIf @@ -22120,6 +21796,18 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + SwitchParameter + + SwitchParameter + + + False + WhatIf @@ -22192,13 +21880,24 @@ Gets all Knowledgebase Articles Object containing properties and values used to update an existing CRM note. - PSObject + Object - PSObject + Object None + + SkipValidation + + Skip validation checks. + + + SwitchParameter + + + False + WhatIf @@ -22229,13 +21928,25 @@ Gets all Knowledgebase Articles Object containing properties and values used to update an existing CRM note. - PSObject + Object - PSObject + Object None + + SkipValidation + + Skip validation checks. + + SwitchParameter + + SwitchParameter + + + False + WhatIf @@ -22315,6 +22026,17 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + + SwitchParameter + + + False + WhatIf @@ -22352,6 +22074,18 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + SwitchParameter + + SwitchParameter + + + False + WhatIf @@ -22431,6 +22165,17 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + + SwitchParameter + + + False + WhatIf @@ -22468,6 +22213,18 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + SwitchParameter + + SwitchParameter + + + False + WhatIf @@ -22547,6 +22304,17 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + + SwitchParameter + + + False + WhatIf @@ -22584,6 +22352,18 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + SwitchParameter + + SwitchParameter + + + False + WhatIf @@ -22663,6 +22443,17 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + + SwitchParameter + + + False + WhatIf @@ -22700,6 +22491,18 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + SwitchParameter + + SwitchParameter + + + False + WhatIf @@ -22779,6 +22582,17 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + + SwitchParameter + + + False + WhatIf @@ -22816,6 +22630,18 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + SwitchParameter + + SwitchParameter + + + False + WhatIf @@ -22895,6 +22721,17 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + + SwitchParameter + + + False + WhatIf @@ -22932,6 +22769,18 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + SwitchParameter + + SwitchParameter + + + False + WhatIf @@ -23011,6 +22860,17 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + + SwitchParameter + + + False + WhatIf @@ -23048,6 +22908,18 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + SwitchParameter + + SwitchParameter + + + False + WhatIf @@ -23127,6 +22999,17 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + + SwitchParameter + + + False + WhatIf @@ -23159,10 +23042,22 @@ Gets all Knowledgebase Articles Object[] - Object[] + Object[] + + + None + + + SkipValidation + + Skip validation checks. + + SwitchParameter + + SwitchParameter - None + False WhatIf @@ -23243,6 +23138,17 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + + SwitchParameter + + + False + WhatIf @@ -23280,6 +23186,18 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + SwitchParameter + + SwitchParameter + + + False + WhatIf @@ -23475,6 +23393,17 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + + SwitchParameter + + + False + WhatIf @@ -23512,6 +23441,18 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + SwitchParameter + + SwitchParameter + + + False + WhatIf @@ -23591,6 +23532,17 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + + SwitchParameter + + + False + WhatIf @@ -23628,6 +23580,18 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + SwitchParameter + + SwitchParameter + + + False + WhatIf @@ -23707,6 +23671,17 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + + SwitchParameter + + + False + WhatIf @@ -23744,6 +23719,18 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + SwitchParameter + + SwitchParameter + + + False + WhatIf @@ -23823,6 +23810,17 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + + SwitchParameter + + + False + WhatIf @@ -23860,6 +23858,18 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + SwitchParameter + + SwitchParameter + + + False + WhatIf @@ -23939,6 +23949,17 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + + SwitchParameter + + + False + WhatIf @@ -23976,6 +23997,18 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + SwitchParameter + + SwitchParameter + + + False + WhatIf @@ -24055,6 +24088,17 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + + SwitchParameter + + + False + WhatIf @@ -24092,6 +24136,18 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + SwitchParameter + + SwitchParameter + + + False + WhatIf @@ -24171,6 +24227,17 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + + SwitchParameter + + + False + WhatIf @@ -24208,6 +24275,18 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + SwitchParameter + + SwitchParameter + + + False + WhatIf @@ -24287,6 +24366,17 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + + SwitchParameter + + + False + WhatIf @@ -24324,6 +24414,18 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + SwitchParameter + + SwitchParameter + + + False + WhatIf @@ -24403,6 +24505,17 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + + SwitchParameter + + + False + WhatIf @@ -24440,6 +24553,18 @@ Gets all Knowledgebase Articles None + + SkipValidation + + Skip validation checks. + + SwitchParameter + + SwitchParameter + + + False + WhatIf @@ -24492,83 +24617,4 @@ Gets all Knowledgebase Articles - - - Write-Success - Write - Success - - {{ Fill in the Synopsis }} - - - - {{ Fill in the Description }} - - - - Write-Success - - Message - - {{ Fill Message Description }} - - String - - String - - - None - - - - - - Message - - {{ Fill Message Description }} - - String - - String - - - None - - - - - - None - - - - - - - - - - System.Object - - - - - - - - - - - - - - -------------------------- Example 1 -------------------------- - PS C:\> {{ Add example code here }} - - {{ Add example description here }} - - - - - \ No newline at end of file diff --git a/HaloAPI.build.ps1 b/HaloAPI.build.ps1 index a472ca8..8beca0b 100644 --- a/HaloAPI.build.ps1 +++ b/HaloAPI.build.ps1 @@ -2,11 +2,14 @@ .SYNOPSIS Homotechsual portable module build script. #> +[CmdletBinding()] Param ( [String]$Configuration = 'Development', [String[]]$Remotes = @('origin', 'homotechsual'), [Switch]$Push, [Switch]$UpdateHelp, + [System.IO.DirectoryInfo]$DocusaurusPath, + [Switch]$ForceUpdateCategoryFiles, [Switch]$CopyModuleFiles, [Switch]$Test, [Switch]$UpdateManifest, @@ -16,6 +19,12 @@ Param ( $ModuleName = 'HaloAPI' +# Install required modules +if (-Not(Get-Module -Name 'Install-RequiredModule')) { + Install-Script -Name 'Install-RequiredModule' -Force -Scope CurrentUser +} +Install-RequiredModule -RequiredModulesFile ('{0}\RequiredModules.psd1' -f $PSScriptRoot) -Scope CurrentUser -TrustRegisteredRepositories -Import -Quiet + # Use strict mode when building. Set-StrictMode -Version Latest @@ -28,12 +37,141 @@ if ($Push) { } # Update the PowerShell Module Help Files. -# Pre-requisites: PowerShell Module PlatyPS. +## Requires PlatyPS, Pester, PSScriptAnalyzer and Alt3.Docusaurus.PowerShell installed. if ($UpdateHelp) { - Import-Module -Name $ModuleName -Force - Update-MarkdownHelp -Path "$($PSScriptRoot)\Docs\Markdown" - New-ExternalHelp -Path "$($PSScriptRoot)\Docs\Markdown" -OutputPath "$($PSScriptRoot)\Docs\en_GB" -Force + if (-Not($DocusaurusPath)) { + throw 'DocusaurusPath parameter is required when updating help' + } elseif (-Not(Resolve-Path -Path $DocusaurusPath)) { + throw 'DocusaurusPath does not resolve to a valid path' + } + $ExcludeFiles = Get-ChildItem -Path "$($PSScriptRoot)\Private" -Filter '*.ps1' -Recurse | ForEach-Object { [System.IO.Path]::GetFileNameWithoutExtension($_.FullName) } + $NewDocusaurusHelpParams = @{ + Module = ('.\{0}.psm1' -f $ModuleName) + DocsFolder = Join-Path -Path $DocusaurusPath -ChildPath 'docs' -AdditionalChildPath $ModuleName + Exclude = $ExcludeFiles + Sidebar = 'commandlets' + # MetaDescription = 'Generated cmdlet help for the %1 commandlet.' + GroupByVerb = $true + UseDescriptionFromHelp = $true + } + New-DocusaurusHelp @NewDocusaurusHelpParams | Out-Null + $CommandletDocsFolder = Join-Path -Path $DocusaurusPath -ChildPath 'docs' -AdditionalChildPath @($ModuleName, 'commandlets') + $VerbFolders = Get-ChildItem -Path $CommandletDocsFolder -Directory + $CategoryFileBase = @{ + position = 1 + collapsible = $true + collapsed = $true + link = @{ + type = 'generated-index' + } + customProps = @{ + description = '' + } + } + foreach ($VerbFolder in $VerbFolders) { + $HasCategoryFile = Get-ChildItem -Path $VerbFolder.FullName -Filter '_category_.*' -File -ErrorAction SilentlyContinue + $CategoryFilePath = Join-Path -Path $VerbFolder.FullName -ChildPath '_category_.json' + switch ($VerbFolder.Name) { + 'Connect' { + $CategoryFile = $CategoryFileBase + $CategoryFile.label = 'Connect to Services' + $CategoryFile.position = 0.1 + $CategoryFile.className = 'category-connect' + $CategoryFile.link.title = 'Connect to Services' + $CategoryFile.customProps.description = 'This category contains commands for connecting to services, retrieving and storing credentials and managing connections.' + } + 'Find' { + $CategoryFile = $CategoryFileBase + $CategoryFile.label = 'Find Information' + $CategoryFile.position = 0.2 + $CategoryFile.className = 'category-find' + $CategoryFile.link.title = 'Find Information' + $CategoryFile.customProps.description = 'This category contains commands for finding information from services, this may include data, objects, settings and more.' + } + 'Get' { + $CategoryFile = $CategoryFileBase + $CategoryFile.label = 'Retrieve Information' + $CategoryFile.position = 0.3 + $CategoryFile.className = 'category-get' + $CategoryFile.link.title = 'Retrieve Information' + $CategoryFile.customProps.description = 'This category contains commands for retrieving information from services, this may include data, objects, settings and more.' + } + 'Invoke' { + $CategoryFile = $CategoryFileBase + $CategoryFile.label = 'Invoke Actions' + $CategoryFile.position = 0.4 + $CategoryFile.className = 'category-invoke' + $CategoryFile.link.title = 'Invoke Actions' + $CategoryFile.customProps.description = 'This category contains commands for invoking actions, this may include running scripts, executing commands and more. For API modules, this category will contain commands for sending arbitrary requests to the API - that is requests not covered by existing commands.' + } + 'New' { + $CategoryFile = $CategoryFileBase + $CategoryFile.label = 'Create Data' + $CategoryFile.position = 0.5 + $CategoryFile.className = 'category-new' + $CategoryFile.link.title = 'Create Data' + $CategoryFile.customProps.description = 'This category contains commands for creating data, objects, settings and more.' + } + 'Remove' { + $CategoryFile = $CategoryFileBase + $CategoryFile.label = 'Remove Data' + $CategoryFile.position = 0.6 + $CategoryFile.className = 'category-remove' + $CategoryFile.link.title = 'Remove Data' + $CategoryFile.customProps.description = 'This category contains commands for removing data, objects, settings and more.' + } + 'Reset' { + $CategoryFile = $CategoryFileBase + $CategoryFile.label = 'Reset State' + $CategoryFile.position = 0.6 + $CategoryFile.className = 'category-reset' + $CategoryFile.link.title = 'Reset State' + $CategoryFile.customProps.description = 'This category contains commands for resetting state, this may include resetting settings, connections and more.' + } + 'Restart' { + $CategoryFile = $CategoryFileBase + $CategoryFile.label = 'Restart Services' + $CategoryFile.position = 0.6 + $CategoryFile.className = 'category-restart' + $CategoryFile.link.title = 'Restart Services' + $CategoryFile.customProps.description = 'This category contains commands for restarting services, this may include restarting services, processes and more.' + } + 'Restore' { + $CategoryFile = $CategoryFileBase + $CategoryFile.label = 'Restore Data' + $CategoryFile.position = 0.6 + $CategoryFile.className = 'category-restore' + $CategoryFile.link.title = 'Restore Data' + $CategoryFile.customProps.description = 'This category contains commands for restoring data, objects, settings and more. These commands will primarily be used for restoring data to a previous state.' + } + 'Set' { + $CategoryFile = $CategoryFileBase + $CategoryFile.label = 'Update Data (Set)' + $CategoryFile.position = 0.4 + $CategoryFile.className = 'category-set' + $CategoryFile.link.title = 'Update Data (Set)' + $CategoryFile.customProps.description = 'This category contains commands for updating data, objects, settings and more. This category will overlap with the Update category.' + } + 'Update' { + $CategoryFile = $CategoryFileBase + $CategoryFile.label = 'Update Data (Update)' + $CategoryFile.position = 0.4 + $CategoryFile.className = 'category-update' + $CategoryFile.link.title = 'Update Data (Update)' + $CategoryFile.customProps.description = 'This category contains commands for updating data, objects, settings and more. This category will overlap with the Set category.' + } + } + if (-Not($HasCategoryFile)) { + $CategoryFile | ConvertTo-Json | Out-File -FilePath $CategoryFilePath -Force + } else { + if (-Not($ForceUpdateCategoryFiles)) { + Write-Warning -Message ('Category file already exists in "{0}" verb folder. Use the ForceUpdateCategoryFiles switch to overwrite existing category files.' -f $VerbFolder.Name) + } else { + Set-Content -Path $CategoryFilePath -Value ($CategoryFile | ConvertTo-Json) -Force + } + } + } } # Copy PowerShell Module files to output folder for release on PSGallery diff --git a/RequiredModules.psd1 b/RequiredModules.psd1 index 6dbf975..196f4e8 100644 --- a/RequiredModules.psd1 +++ b/RequiredModules.psd1 @@ -1,5 +1,6 @@ -@( - @{ ModuleName = 'Pester'; RequiredVersion = '5.3.3' } - @{ ModuleName = 'PlatyPS'; RequiredVersion = '0.14.2' } - @{ ModuleName = 'PSScriptAnalyzer'; RequiredVersion = '1.21.0' } -) \ No newline at end of file +@{ + 'Pester' = '5.5.0' + 'PlatyPS' = '0.14.2' + 'PSScriptAnalyzer' = '1.21.0' + 'Alt3.Docusaurus.PowerShell' = '1.0.34' +} \ No newline at end of file