| external help file | ConnectWiseManageAPI-help.xml |
|---|---|
| Module Name | ConnectWiseManageAPI |
| online version | https://developer.connectwise.com/manage/rest?a=Company&e=Configurations&o=GET |
| schema | 2.0.0 |
This function will list a contacts notes.
Get-CWMCompanyContactNote [-parentId] <Int32> [[-id] <Int32>] [-count] [[-condition] <String>]
[[-orderBy] <String>] [[-childConditions] <String>] [[-customFieldConditions] <String>] [[-page] <Int32>]
[[-pageSize] <Int32>] [[-fields] <String[]>] [-all] [-ProgressAction <ActionPreference>] [<CommonParameters>]
Used to return a company contacts notes via ID or conditions.
PS C:\> Get-CWMCompanyContactNote -parentId $Contact.idWill return all notes for the given contact.
Return all results
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseAllows searching arrays on endpoints that list childConditions under parameters
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseAllows searching custom fields.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseAllows 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: FalseThe ID of the note you want returned.
Type: Int32
Parameter Sets: (All)
Aliases: noteId
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseChoose which field to sort the results by, 'field/sub desc' or 'field/sub asc'
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseUsed in pagination to cycle through results.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseNumber of results returned per page (Defaults to 25)
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe ID of the contact you want to return the notes of.
Type: Int32
Parameter Sets: (All)
Aliases: contactId
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis 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: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseWill 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{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.