SnipeitPS/docs/Get-SnipeitCustomField.md
2021-06-08 20:20:03 +03:00

1.5 KiB

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

Get-SnipeItCustomField

SYNOPSIS

Returns specific Snipe-IT custom field or a list of all custom field

SYNTAX

Get-SnipeItCustomField [[-id] <Int32>] [-url] <String> [-apiKey] <String> [<CommonParameters>]

DESCRIPTION

{{ Fill in the Description }}

EXAMPLES

EXAMPLE 1

Get-SnipeItCustomField -url "https://assets.example.com" -token "token..."

PARAMETERS

-apiKey

Users API Key for Snipeit, can be set using Set-SnipeItInfo command

Type: String
Parameter Sets: (All)
Aliases:

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

-id

A id of specific field

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: 0
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: 2
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