SnipeitPS/docs/Get-SnipeItCompany.md

171 lines
2.7 KiB
Markdown
Raw Normal View History

---
2018-04-29 08:58:34 +01:00
external help file: SnipeItPS-help.xml
2021-05-18 05:57:40 +03:00
Module Name: SnipeitPS
online version:
2018-04-29 08:58:34 +01:00
schema: 2.0.0
---
# Get-SnipeItCompany
2018-04-29 08:58:34 +01:00
## SYNOPSIS
2021-05-19 15:51:49 +03:00
Gets a list of Snipe-it Companies
2018-04-29 08:58:34 +01:00
## SYNTAX
```
Get-SnipeItCompany [[-search] <String>] [[-id] <Int32>] [[-order] <String>] [[-limit] <Int32>]
[[-offset] <Int32>] [-all] [-url] <String> [-apiKey] <String> [<CommonParameters>]
2018-04-29 08:58:34 +01:00
```
## DESCRIPTION
2021-05-18 05:57:40 +03:00
{{ Fill in the Description }}
2018-04-29 08:58:34 +01:00
## EXAMPLES
2021-05-18 05:57:40 +03:00
### EXAMPLE 1
2018-04-29 08:58:34 +01:00
```
2021-05-23 23:22:23 +03:00
Get-SnipeItCompany
2021-05-19 15:51:49 +03:00
Gets all companies
2021-06-05 08:10:45 +03:00
```
2021-05-19 15:51:49 +03:00
2021-05-18 05:57:40 +03:00
### EXAMPLE 2
2018-04-29 08:58:34 +01:00
```
2021-05-23 23:22:23 +03:00
Get-SnipeItCompany -id 1
2021-05-19 15:51:49 +03:00
Gets specific company
2021-06-05 08:10:45 +03:00
```
2021-05-19 15:51:49 +03:00
2018-04-29 08:58:34 +01:00
## PARAMETERS
2021-05-23 23:24:44 +03:00
### -all
A return all results, works with -offset and other parameters
2018-04-29 08:58:34 +01:00
```yaml
2021-05-23 23:24:44 +03:00
Type: SwitchParameter
2018-04-29 08:58:34 +01:00
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2018-04-29 08:58:34 +01:00
Required: False
2021-05-23 23:24:44 +03:00
Position: Named
Default value: False
2018-04-29 08:58:34 +01:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -apiKey
Users API Key for Snipeit, can be set using Set-SnipeItInfo command
2018-04-29 08:58:34 +01:00
```yaml
2021-05-23 23:24:44 +03:00
Type: String
2018-04-29 08:58:34 +01:00
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2018-04-29 08:58:34 +01:00
2021-05-23 23:24:44 +03:00
Required: True
Position: 7
Default value: None
2021-05-18 05:57:40 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -id
A id of specific Company
2021-05-18 05:57:40 +03:00
```yaml
2021-05-23 23:24:44 +03:00
Type: Int32
2021-05-18 05:57:40 +03:00
Parameter Sets: (All)
Aliases:
Required: False
2021-05-23 23:24:44 +03:00
Position: 2
Default value: 0
2018-04-29 08:58:34 +01:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-18 05:57:40 +03:00
### -limit
Specify the number of results you wish to return.
Defaults to 50.
Defines batch size for -all
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: 50
Accept pipeline input: False
Accept wildcard characters: False
```
### -offset
Offset to use
```yaml
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -order
{{ Fill order Description }}
2018-04-29 08:58:34 +01:00
```yaml
2021-05-23 23:24:44 +03:00
Type: String
2018-04-29 08:58:34 +01:00
Parameter Sets: (All)
2021-05-18 05:57:40 +03:00
Aliases:
2018-04-29 08:58:34 +01:00
2021-05-18 05:57:40 +03:00
Required: False
2021-05-23 23:24:44 +03:00
Position: 3
Default value: Desc
2021-05-18 05:57:40 +03:00
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -search
A text string to search the Companies data
2021-05-18 05:57:40 +03:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
2021-05-23 23:24:44 +03:00
Required: False
Position: 1
2018-04-29 08:58:34 +01:00
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
2021-05-23 23:24:44 +03:00
### -url
URL of Snipeit system, can be set using Set-SnipeItInfo command
2021-05-18 05:57:40 +03:00
```yaml
Type: String
Parameter Sets: (All)
Aliases:
Required: True
2021-05-23 23:24:44 +03:00
Position: 6
2021-05-18 05:57:40 +03:00
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).
2018-04-29 08:58:34 +01:00
## INPUTS
## OUTPUTS
## NOTES
## RELATED LINKS