Skip to content

Latest commit

 

History

History
197 lines (153 loc) · 3.62 KB

Get-CWMContactType.md

File metadata and controls

197 lines (153 loc) · 3.62 KB
external help file Module Name online version schema
ConnectWiseManageAPI-help.xml
ConnectWiseManageAPI
2.0.0

Get-CWMContactType

SYNOPSIS

Get contact types

SYNTAX

Get-CWMContactType [[-id] <Int32>] [[-conditions] <String>] [[-orderBy] <String>] [[-childConditions] <String>]
 [[-customFieldConditions] <String>] [[-page] <Int32>] [[-pageSize] <Int32>] [[-pageId] <Int32>]
 [[-fields] <String[]>] [-all] [<CommonParameters>]

DESCRIPTION

Get information on contact types

EXAMPLES

EXAMPLE 1

PS C:\> Get-CWMContactType -id 1

Get information about contact type 1

PARAMETERS

-all

Return all results

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
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

-conditions

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

-customFieldConditions

Allows searching custom fields.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
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: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-id

The contact type id

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
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: None
Accept pipeline input: False
Accept wildcard characters: False

-pageId

The pageId is the record in which you would like to begin with for paging.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: None
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: 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

None

OUTPUTS

System.Object

NOTES

RELATED LINKS