Skip to main content

Document Template

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​

Creates a new document template using the NinjaOne API.

SYNTAX​

New-NinjaOneDocumentTemplate [-name] <String> [[-description] <String>] [-allowMultiple] [-mandatory]
 [-fields] <Object[]> [-availableToAllTechnicians] [[-allowedTechnicianRoles] <Int32[]>] [-show]
 [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION​

Create a new document template using the NinjaOne v2 API.

EXAMPLES​

EXAMPLE 1​

# FULL REQUEST EXAMPLE (AUTO-GENERATED) - BEGIN
 PS> $body = @{
	name = "string"
	description = "string"
	allowMultiple = $false
	mandatory = $false
	fields = @(
		@{
			fieldLabel = "string"
			fieldName = "string"
			fieldDescription = "string"
			fieldType = "DROPDOWN"
			fieldTechnicianPermission = "NONE"
			fieldScriptPermission = "NONE"
			fieldApiPermission = "NONE"
			fieldDefaultValue = "string"
			fieldContent = @{
				values = @(
					@{
						name = "string"
					}
				)
				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
					)
				}
			}
			uiElementName = "string"
			uiElementType = "TITLE"
			uiElementValue = "string"
		}
	)
	availableToAllTechnicians = $false
	allowedTechnicianRoles = @(
		0
	)
}
PS> New-NinjaOneDocumentTemplate -name $body
# FULL REQUEST EXAMPLE (AUTO-GENERATED) - END

Full request example (auto-generated).

PARAMETERS​

-name​

The name of the document template.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
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: 2
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: 3
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: 4
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: 5
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​

https://docs.homotechsual.dev/modules/ninjaone/commandlets/New/documenttemplate

Last updated on by Mikey O'Toole