Get Documents

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

Gets documents from the NinjaOne API.

SYNTAX

Get-NinjaOneOrganisationDocuments [[-organisationId] <Int32>] [[-documentName] <String>] [[-groupBy] <String>]
 [[-organisationIds] <String>] [[-templateIds] <String>] [[-templateName] <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Retrieves documents from the NinjaOne v2 API.

EXAMPLES

EXAMPLE 1

Get-NinjaOneOrganisationDocuments -organisationId 1

Gets documents for the organisation with id 1.

PARAMETERS

-organisationId

Filter by organisation id.

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

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

-documentName

Filter by document name.

Type: String
Parameter Sets: (All)
Aliases:

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

-groupBy

Group by template or organisation.

Type: String
Parameter Sets: (All)
Aliases:

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

-organisationIds

Filter by organisation ids. TODO: Describe the format.

Type: String
Parameter Sets: (All)
Aliases:

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

-templateIds

Filter by template ids. TODO: Describe the format.

Type: String
Parameter Sets: (All)
Aliases:

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

-templateName

Filter by template name.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
Accept pipeline input: True (ByPropertyName)
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/Get/documents