external help file | Module Name | online version | schema |
---|---|---|---|
ConnectWiseManageAPI-help.xml |
ConnectWiseManageAPI |
2.0.0 |
This function will list company notes based on conditions.
Get-CWMCompanyNote [-id <Int32>] [-count] [-CompanyID] <Int32> [[-condition] <String>] [[-orderBy] <String>]
[[-childConditions] <String>] [[-customFieldConditions] <String>] [[-page] <Int32>] [[-pageSize] <Int32>]
[-fields <String[]>] [-all] [<CommonParameters>]
{{ Fill in the Description }}
Get-CWMCompanyNotes -CompanyID 1 -all
Will return all notes for company 1
The ID of the company you need to retrieve notes from.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
Return all results
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
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
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
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
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
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
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
{{ Fill id Description }}
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
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
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Author: Chris Taylor Date: <GET-DATE>12/11/2018
https://developer.connectwise.com/products/manage/rest?a=Company&e=CompanyNotes&o=GET