Custom Fields

Generated Cmdlet Help

This page has been generated from the NinjaOne PowerShell module source. To make changes please edit the appropriate PowerShell source file.

SYNOPSIS

Updates a custom field by field name.

SYNTAX

Set-NinjaOneCustomField [-FieldName] <String> [-CustomField] <Object> [-ProgressAction <ActionPreference>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Updates an existing custom field identified by its unique field name via the NinjaOne v2 API.

EXAMPLES

EXAMPLE 1

Set-NinjaOneCustomField -FieldName 'department' -CustomField @{ description = 'Department of the user' }

Updates the custom field named 'department' with new description.

EXAMPLE 2

# FULL REQUEST EXAMPLE (AUTO-GENERATED) - BEGIN
 PS> $body = @{
	label = "string"
	fieldName = "string"
	description = "string"
	type = "DROPDOWN"
	technicianPermission = "NONE"
	scriptPermission = "NONE"
	apiPermission = "NONE"
	defaultValue = "string"
	content = @{
		values = @(
			@{
				id = "00000000-0000-0000-0000-000000000000"
				name = "string"
				active = $false
				system = $false
			}
		)
		required = $false
		footerText = "string"
		tooltipText = "string"
		advancedSettings = @{
			fileMaxSize = 0
			fileExtensions = @(
				"string"
			)
			dateFilters = @{
				type = "NONE"
				selected = @(
					"string"
				)
			}
			maxCharacters = 0
			complexityRules = @{
				mustContainOneInteger = $false
				mustContainOneLowercaseLetter = $false
				mustContainOneUppercaseLetter = $false
				greaterOrEqualThanSixCharacters = $false
			}
			numericRange = @{
				min = 0
				max = 0
			}
			org = @(
				0
			)
			nodeClass = @(
				"WINDOWS_SERVER"
			)
			ipAddressType = "ALL"
			expandLargeValueOnRender = $false
			identifier = @{
				automaticGenerationEnabled = $false
				scope = "NONE"
				assignTo = "NEW_ASSETS_ONLY"
				type = "CUSTOM"
				nextSequenceNumber = 0
				prefix = "string"
				suffix = "string"
			}
			monetary = @{
				currency = "USD"
			}
			templates = @(
				0
			)
		}
	}
	active = $false
	scope = "NODE_GLOBAL"
	definitionScope = @(
		"NODE"
	)
	groupId = 0
}
PS> Set-NinjaOneCustomField -FieldName string -CustomField $body
# FULL REQUEST EXAMPLE (AUTO-GENERATED) - END

Full request example (auto-generated).

PARAMETERS

-FieldName

The field name of the custom field to update

Type: String
Parameter Sets: (All)
Aliases: name

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-CustomField

Custom field update payload per API schema

Type: Object
Parameter Sets: (All)
Aliases: body

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

INPUTS

OUTPUTS

A PowerShell object containing the updated custom field.

NOTES

RELATED LINKS

https://docs.homotechsual.dev/modules/ninjaone/commandlets/Set/customfield