Skip to content

Write-PodeJsonResponse

SYNOPSIS

Writes JSON data to the Response.

SYNTAX

Value (Default)

Write-PodeJsonResponse -Value <Object> [-Depth <Int32>] [-StatusCode <Int32>] [<CommonParameters>]

File

Write-PodeJsonResponse -Path <String> [-Depth <Int32>] [-StatusCode <Int32>] [<CommonParameters>]

DESCRIPTION

Writes JSON data to the Response, setting the content type accordingly.

EXAMPLES

EXAMPLE 1

Write-PodeJsonResponse -Value '{"name": "Rick"}'

EXAMPLE 2

Write-PodeJsonResponse -Value @{ Name = 'Rick' } -StatusCode 201

EXAMPLE 3

Write-PodeJsonResponse -Path 'E:/Files/Names.json'

PARAMETERS

-Depth

The Depth to generate the JSON document - the larger this value the worse performance gets.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 10
Accept pipeline input: False
Accept wildcard characters: False

-Path

The path to a JSON file.

Type: String
Parameter Sets: File
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-StatusCode

The status code to set against the response.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 200
Accept pipeline input: False
Accept wildcard characters: False

-Value

A String, PSObject, or HashTable value. For non-string values, they will be converted to JSON.

Type: Object
Parameter Sets: Value
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
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

NOTES