Organisation Document

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 organisation document using the NinjaOne API.

SYNTAX

New-NinjaOneOrganisationDocument [-organisationId] <String> [-documentTemplateId] <String>
 [-organisationDocument] <Object> [-show] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Create a single organisation document using the NinjaOne v2 API.

EXAMPLES

EXAMPLE 1

# FULL REQUEST EXAMPLE (AUTO-GENERATED) - BEGIN
PS> $body = @{
    documentName = "string"
    fields = @{
        additionalProp1 = @{
        }
    }
    documentDescription = "string"
}
PS> New-NinjaOneOrganisationDocument -documentTemplateId 1 -organisationDocument $body
# FULL REQUEST EXAMPLE (AUTO-GENERATED) - END

Full request example (auto-generated).

PARAMETERS

-organisationId

The Id of the organisation to create the document for.

Type: String
Parameter Sets: (All)
Aliases: organizationId, id

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

-documentTemplateId

The Id of the document template to use.

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

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

-organisationDocument

An object containing an array of organisation documents to create.

Type: Object
Parameter Sets: (All)
Aliases: organizationDocuments, organisationDocuments, organizationDocument, body

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

-show

Show the organisation document 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/New/organisationdocument