Custom Field

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 = @{
    active = $false
    scriptPermission = "NONE"
    type = "DROPDOWN"
    defaultValue = "string"
    content = @{
        values = @(
            @{
                id = "00000000-0000-0000-0000-000000000000"
                system = $false
                active = $false
                name = "string"
            }
        )
        footerText = "string"
        required = $false
        tooltipText = "string"
        advancedSettings = @{
            complexityRules = @{
                greaterOrEqualThanSixCharacters = $false
                mustContainOneUppercaseLetter = $false
                mustContainOneInteger = $false
                mustContainOneLowercaseLetter = $false
            }
            monetary = @{
                currency = "USD"
            }
            ipAddressType = "ALL"
            fileMaxSize = 0
            fileExtensions = @(
                "string"
            )
            templates = @(
                0
            )
            org = @(
                0
            )
            dateFilters = @{
                selected = @(
                    "string"
                )
                type = "NONE"
            }
            identifier = @{
                nextSequenceNumber = 0
                automaticGenerationEnabled = $false
                prefix = "string"
                suffix = "string"
                scope = "NONE"
                type = "CUSTOM"
                assignTo = "NEW_ASSETS_ONLY"
            }
            numericRange = @{
                min = 0
                max = 0
            }
            maxCharacters = 0
            nodeClass = @(
                "WINDOWS_SERVER"
            )
            expandLargeValueOnRender = $false
        }
    }
    groupId = 0
    description = "string"
    scope = "NODE_GLOBAL"
    definitionScope = @(
        "NODE"
    )
    technicianPermission = "NONE"
    fieldName = "string"
    apiPermission = "NONE"
    label = "string"
}
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