dips/SnipeitPS
1
0
Fork 0
mirror of https://github.com/snazy2000/SnipeitPS.git synced 2025-12-13 18:02:30 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
SnipeitPS/docs/Get-SnipeitCustomField.md
Petri Asikainen 69faba1856 updates docs
2021-08-23 18:50:13 +03:00

1.6 KiB
Raw Blame History

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
Get all custom fields

EXAMPLE 2

Get-SnipeitCustomField -id 1
Get custom field with ID 1

PARAMETERS

-apiKey

Deprecated parameter, please use Connect-SnipeitPS instead. Users API Key for Snipeit.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
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

Deprecated parameter, please use Connect-SnipeitPS instead. URL of Snipeit system.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
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

RELATED LINKS