e Get-TdSupplierContact | Welcome to TOPdeskPS

Main | Command Reference | Quick Start

Welcome to TOPdeskPS

PowerShell module to interact with the TOPdesk REST Api

Get-TdSupplierContact

SYNOPSIS

Gets list of supplier contacts

SYNTAX

Get-TdSupplierContact [[-SupplierId] <Object>] [[-PageSize] <Int32>] [[-Start] <Int32>] [-Archived]
 [[-Name] <String>] [<CommonParameters>]

DESCRIPTION

Returns list of supplier contacts

EXAMPLES

EXAMPLE 1

Get-TdSuppliercontact

Returns list of supplier contacts

EXAMPLE 2

Get-TdSupplier -Name 'Sample Supplier' | Get-TdSupplierContact

Returns list of Supplier contracts from supplier ‘Sample Supplier’

TODO figure out what’s going on here

PARAMETERS

-SupplierId

ID of the Supplier. See Get-TdSupplier

Type: Object
Parameter Sets: (All)
Aliases: Id

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-PageSize

The amount of suppliers to be returned per request. Must be between 1 and 10000, default is 1000.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Start

This is the offset at which you want to start listing suppliers at. The default value is 0.

Type: Int32
Parameter Sets: (All)
Aliases:

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

-Archived

Whether to retrieve archived incidents.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Name

retrieve only suppliers with names starting with this string

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
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 (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES