Skip to content

Set-PodeOARequest

SYNOPSIS

Sets the definition of a request for a route.

SYNTAX

Set-PodeOARequest [-Route] <Hashtable[]> [[-Parameters] <Hashtable[]>] [[-RequestBody] <Hashtable>] [-PassThru]
 [<CommonParameters>]

DESCRIPTION

Sets the definition of a request for a route.

EXAMPLES

EXAMPLE 1

Add-PodeRoute -PassThru | Set-PodeOARequest -RequestBody (New-PodeOARequestBody -Reference 'UserIdBody')

PARAMETERS

-Parameters

The Parameter definitions the request uses (from ConvertTo-PodeOAParameter).

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

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

-PassThru

If supplied, the route passed in will be returned for further chaining.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-RequestBody

The Request Body definition the request uses (from New-PodeOARequestBody).

Type: Hashtable
Parameter Sets: (All)
Aliases:

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

-Route

The route to set a request definition, usually from -PassThru on Add-PodeRoute.

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

Required: True
Position: 1
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