Skip to content

Get-CWMTicket.md

Latest commit

 

History

History
219 lines (168 loc) · 8.64 KB

Get-CWMTicket.md

File metadata and controls

219 lines (168 loc) · 8.64 KB

external help file: ConnectWiseManageAPI-help.xml Module Name: ConnectWiseManageAPI online version: schema: 2.0.0

Get-CWMTicket

SYNOPSIS

This function list tickets that match your condition.

SYNTAX

Get-CWMTicket [-id <Int32>] [-count] [[-condition] <String>] [[-orderBy] <String>]
 [[-childConditions] <String>] [[-customFieldConditions] <String>] [[-page] <Int32>] [[-pageSize] <Int32>]
 [-fields <String[]>] [-all] [<CommonParameters>]

DESCRIPTION

{{ Fill in the Description }}

EXAMPLES

EXAMPLE 1

Get-CWMTicket -TicketID 1

We are using TicketID an alias for id to get ticket #1.

EXAMPLE 2

Get-CWMTicket -all

By default only 25 results are returned, this returns all tickets.

EXAMPLE 3

Get-CWMTicket -condition 'summary="test"'

Returns the first 25 tickets with the summary of test

EXAMPLE 4

Get-CWMTicket -condition 'subType/id = 2014'

Returns the first 25 tickets with subType 2014

PARAMETERS

-all

Return all results

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-childConditions

Allows searching arrays on endpoints that list childConditions under parameters

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-customFieldConditions

Allows searching custom fields when customFieldConditions is listed in the parameters

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-orderBy

Choose which field to sort the results by, 'field/sub desc' or 'field/sub asc'

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-page

Used in pagination to cycle through results

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-pageSize

Number of results returned per page (Defaults to 25)

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-condition

This is your search condition to return the results you desire. Example: (contact/name like "Fred%" and closedFlag = false) and dateEntered \> \[2015-12-23T05:53:27Z\] or summary contains "test" AND summary != "Some Summary"

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-id

{{ Fill id Description }}

Type: Int32
Parameter Sets: (All)
Aliases: ticketId

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-fields

Allows you to return a partial response with just the fields listed.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-count

Will return the number of objects.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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.

INPUTS

OUTPUTS

NOTES

Author: Chris Taylor Date: 10/10/2018

RELATED LINKS

https://developer.connectwise.com/products/manage/rest?a=Service&e=Tickets&o=GETBYID