mirror of
https://github.com/snazy2000/SnipeitPS.git
synced 2025-12-13 18:02:30 +00:00
176 lines
2.9 KiB
Markdown
176 lines
2.9 KiB
Markdown
---
|
|
external help file: SnipeitPS-help.xml
|
|
Module Name: SnipeitPS
|
|
online version:
|
|
schema: 2.0.0
|
|
---
|
|
|
|
# Get-SnipeitCompany
|
|
|
|
## SYNOPSIS
|
|
Gets a list of Snipe-it Companies
|
|
|
|
## SYNTAX
|
|
|
|
### Search
|
|
```
|
|
Get-SnipeitCompany [-search <String>] [-order <String>] [-limit <Int32>] [-offset <Int32>] [-all] -url <String>
|
|
-apiKey <String> [<CommonParameters>]
|
|
```
|
|
|
|
### Get with ID
|
|
```
|
|
Get-SnipeitCompany [-id <Int32>] -url <String> -apiKey <String> [<CommonParameters>]
|
|
```
|
|
|
|
## DESCRIPTION
|
|
{{ Fill in the Description }}
|
|
|
|
## EXAMPLES
|
|
|
|
### EXAMPLE 1
|
|
```
|
|
Get-SnipeitCompany
|
|
Gets all companies
|
|
```
|
|
|
|
### EXAMPLE 2
|
|
```
|
|
Get-SnipeitCompany -id 1
|
|
Gets specific company
|
|
```
|
|
|
|
## PARAMETERS
|
|
|
|
### -all
|
|
A return all results, works with -offset and other parameters
|
|
|
|
```yaml
|
|
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
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: (All)
|
|
Aliases:
|
|
|
|
Required: True
|
|
Position: Named
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -id
|
|
A id of specific Company
|
|
|
|
```yaml
|
|
Type: Int32
|
|
Parameter Sets: Get with ID
|
|
Aliases:
|
|
|
|
Required: False
|
|
Position: Named
|
|
Default value: 0
|
|
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
|
|
|
|
```yaml
|
|
Type: Int32
|
|
Parameter Sets: Search
|
|
Aliases:
|
|
|
|
Required: False
|
|
Position: Named
|
|
Default value: 50
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -offset
|
|
Offset to use
|
|
|
|
```yaml
|
|
Type: Int32
|
|
Parameter Sets: Search
|
|
Aliases:
|
|
|
|
Required: False
|
|
Position: Named
|
|
Default value: 0
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -order
|
|
{{ Fill order Description }}
|
|
|
|
```yaml
|
|
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 Companies data
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: Search
|
|
Aliases:
|
|
|
|
Required: False
|
|
Position: Named
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: False
|
|
```
|
|
|
|
### -url
|
|
URL of Snipeit system, can be set using Set-SnipeitInfo command
|
|
|
|
```yaml
|
|
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](http://go.microsoft.com/fwlink/?LinkID=113216).
|
|
|
|
## INPUTS
|
|
|
|
## OUTPUTS
|
|
|
|
## NOTES
|
|
|
|
## RELATED LINKS
|