Skip to content

Get-CWMDocument.md

Latest commit

 

History

History
236 lines (184 loc) · 9.61 KB

Get-CWMDocument.md

File metadata and controls

236 lines (184 loc) · 9.61 KB

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

Get-CWMDocument

SYNOPSIS

This function will list documents associated with a record.

SYNTAX

ID

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

Record

Get-CWMDocument -recordId <Int32> -recordType <String> [-count] [-condition <String>] [-orderBy <String>]
 [-childConditions <String>] [-customFieldConditions <String>] [[-page] <Int32>] [[-pageSize] <Int32>]
 [-fields <String[]>] [-all] [<CommonParameters>]

DESCRIPTION

Gets a document associated with a record.

EXAMPLES

EXAMPLE 1

Get-CWMDocuments -recordType Ticket -recordId 1836414

Will return documents associated with a the ticket 1936414

PARAMETERS

-page

Used in pagination to cycle through results

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
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: 3
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

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

-id

The ID of the document you want to retrieve.

Type: Int32
Parameter Sets: ID
Aliases: documentId

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

-recordId

The ID of the record that holds the document you are looking for.

Type: Int32
Parameter Sets: Record
Aliases:

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

-recordType

The type of record you are looking to retrieve.

Type: String
Parameter Sets: Record
Aliases:

Required: True
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: 8/22/2018

RELATED LINKS

https://developer.connectwise.com/manage/rest?a=System&e=Documents&o=GET