Document Template
This page has been generated from the NinjaOne PowerShell module source. To make changes please edit the appropriate PowerShell source file.
SYNOPSIS
Sets a document template.
SYNTAX
Set-NinjaOneDocumentTemplate [-documentTemplateId] <Int32> [[-name] <String>] [[-description] <String>]
[-allowMultiple] [-mandatory] [-fields] <Object[]> [-availableToAllTechnicians]
[[-allowedTechnicianRoles] <Int32[]>] [-show] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Updates a document template using the NinjaOne v2 API.
EXAMPLES
EXAMPLE 1
# FULL REQUEST EXAMPLE (AUTO-GENERATED) - BEGIN
PS> $body = @{
fields = @(
@{
fieldDescription = "string"
uiElementType = "TITLE"
fieldName = "string"
fieldApiPermission = "NONE"
fieldScriptPermission = "NONE"
fieldType = "DROPDOWN"
fieldLabel = "string"
fieldDefaultValue = "string"
fieldContent = @{
values = @(
@{
id = "00000000-0000-0000-0000-000000000000"
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
}
}
fieldId = 0
uiElementValue = "string"
uiElementUid = "00000000-0000-0000-0000-000000000000"
fieldTechnicianPermission = "NONE"
uiElementName = "string"
}
)
description = "string"
mandatory = $false
allowedTechnicianRoles = @(
0
)
availableToAllTechnicians = $false
name = "string"
}
PS> Set-NinjaOneDocumentTemplate -documentTemplateId 1 -documentTemplateId $body
# FULL REQUEST EXAMPLE (AUTO-GENERATED) - END
Full request example (auto-generated).
EXAMPLE 2
Set-NinjaOneDocumentTemplate -Identity 123 -Property 'Value'
Updates the specified resource.
PARAMETERS
-documentTemplateId
The document template id to update.
Type: Int32
Parameter Sets: (All)
Aliases: id
Required: True
Position: 1
Default value: 0
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-name
The name of the document template.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-description
The description of the document template.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-allowMultiple
Allow multiple instances of this document template to be used per organisation.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-mandatory
Is this document template mandatory for all organisations.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-fields
The document template fields.
Type: Object[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 6
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-availableToAllTechnicians
Make this template available to all technicians.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-allowedTechnicianRoles
Set the technician roles that can access this template.
Type: Int32[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-show
Show the document template that was created.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
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 response.
NOTES
RELATED LINKS
https://docs.homotechsual.dev/modules/ninjaone/commandlets/Set/documenttemplate