Knowledge Base Articles Upload

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

Uploads knowledge base articles.

SYNTAX

New-NinjaOneKnowledgeBaseArticlesUpload [-OrganizationId] <Int32> [[-FolderId] <Int32>]
 [[-FolderPath] <String>] [-FilePath] <String[]> [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Uploads one or more knowledge base articles via the NinjaOne v2 API.

EXAMPLES

EXAMPLE 1

New-NinjaOneKnowledgeBaseArticlesUpload -OrganizationId 1 -FilePath 'C:\articles.zip'

Uploads knowledge base articles from a file to the specified organization.

EXAMPLE 2

$organizationId = 0
PS> $json = $organizationId | ConvertTo-Json -Depth 10
PS> $stringContent = [System.Net.Http.StringContent]::new($json, [System.Text.Encoding]::UTF8, "application/json")
PS> $multipart.Add($stringContent, "organizationId")
PS> $folderId = 0
PS> $json = $folderId | ConvertTo-Json -Depth 10
PS> $stringContent = [System.Net.Http.StringContent]::new($json, [System.Text.Encoding]::UTF8, "application/json")
PS> $multipart.Add($stringContent, "folderId")
PS> $folderPath = "string"
PS> $json = $folderPath | ConvertTo-Json -Depth 10
PS> $stringContent = [System.Net.Http.StringContent]::new($json, [System.Text.Encoding]::UTF8, "application/json")
PS> $multipart.Add($stringContent, "folderPath")
PS> $filePath = "C:\Temp\example.txt"
PS> $fileStream = [System.IO.FileStream]::new($filePath, [System.IO.FileMode]::Open, [System.IO.FileAccess]::Read)
PS> $fileContent = [System.Net.Http.StreamContent]::new($fileStream)
PS> $fileContent.Headers.ContentType = [System.Net.Http.Headers.MediaTypeHeaderValue]::Parse("application/octet-stream")
PS> $multipart.Add($fileContent, "files", [System.IO.Path]::GetFileName($filePath))
PS> $body = $multipart
PS> New-NinjaOneKnowledgeBaseArticlesUpload -OrganizationId $body
# FULL REQUEST EXAMPLE (AUTO-GENERATED) - END

Full request example (auto-generated).

PARAMETERS

-OrganizationId

Organization ID

Type: Int32
Parameter Sets: (All)
Aliases:

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

-FolderId

Folder ID

Type: Int32
Parameter Sets: (All)
Aliases:

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

-FolderPath

Folder Path

Type: String
Parameter Sets: (All)
Aliases:

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

-FilePath

File path(s) to upload

Type: String[]
Parameter Sets: (All)
Aliases:

Required: True
Position: 4
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 created articles or job result.

NOTES

RELATED LINKS

https://docs.homotechsual.dev/modules/ninjaone/commandlets/New/knowledgebase-articles-upload