4.5 KiB
| external help file | Module Name | online version | schema |
|---|---|---|---|
| SnipeitPS-help.xml | SnipeitPS | 2.0.0 |
Get-SnipeitConsumable
SYNOPSIS
Gets a list of Snipe-it consumables
SYNTAX
Search (Default)
Get-SnipeitConsumable [-search <String>] [-category_id <Int32>] [-company_id <Int32>]
[-manufacturer_id <Int32>] [-location_id <Int32>] [-order <String>] [-sort <String>] [-expand]
[-limit <Int32>] [-offset <Int32>] [-all] -url <String> -apiKey <String> [<CommonParameters>]
Get with ID
Get-SnipeitConsumable [-id <Int32[]>] -url <String> -apiKey <String> [<CommonParameters>]
DESCRIPTION
{{ Fill in the Description }}
EXAMPLES
EXAMPLE 1
Get-SnipeitConsumable -all
Returns all consumables
EXAMPLE 2
Get-SnipeitConsumable -search paper
Returns search results containeing string display
EXAMPLE 3
Get-Snipeitconsumable -id
Returns specific consumable
PARAMETERS
-all
A return all results
Type: SwitchParameter
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-apiKey
Users API Key for Snipeit, can be set using Set-SnipeitInfo command
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-category_id
Id number of category
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-company_id
Id number of company
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-expand
Whether to include detailed information on categories, etc (true) or just the text name (false)
Type: SwitchParameter
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-id
A id of specific consumable
Type: Int32[]
Parameter Sets: Get with ID
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-limit
Specify the number of results you wish to return. Defaults to 50. Defines batch size for -all
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 50
Accept pipeline input: False
Accept wildcard characters: False
-location_id
{{ Fill location_id Description }}
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-manufacturer_id
Id number of manufacturer
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-offset
Offset to use
Type: Int32
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-order
Specify the order (asc or desc) you wish to order by on your sort column
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: Desc
Accept pipeline input: False
Accept wildcard characters: False
-search
A text string to search the consumables
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-sort
Sort results by column
Type: String
Parameter Sets: Search
Aliases:
Required: False
Position: Named
Default value: Created_at
Accept pipeline input: False
Accept wildcard characters: False
-url
URL of Snipeit system,can be set using Set-SnipeitInfo command
Type: String
Parameter Sets: (All)
Aliases:
Required: True
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.