Invoke-vRORestMethod
SYNOPSIS
Wrapper for Invoke-RestMethod with vRO specifics
SYNTAX
Invoke-vRORestMethod [-Method] <String> [-URI] <String> [[-Body] <Object>] [-WebRequest]
[[-Headers] <IDictionary>] [[-OutFile] <String>] [<CommonParameters>]
DESCRIPTION
Wrapper for Invoke-RestMethod with vRO specifics
EXAMPLES
EXAMPLE 1
Invoke-vRORestMethod -Method GET -URI '/vco/api/workflows'
EXAMPLE 2
$URI = "/vco/api/workflows/$($ID)/executions/"
$JSON = @"
{"parameters":
[
{
"value": {"string":{ "value": "Apple"}},
"type": "string",
"name": "a",
"scope": "local"
},
{
"value": {"number":{ "value": 20}},
"type": "number",
"name": "b",
"scope": "local"
}
]
}
"@
$InvokeRequest = Invoke-vRORestMethod -Method POST -URI $URI -Body $Body -WebRequest
PARAMETERS
-Method
REST Method: GET, POST, PUT or DELETE
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-URI
API URI, e.g. /vco/api/workflows
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Body
REST Body in JSON format
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WebRequest
Use Invoke-WebRequest instead of Invoke-RestMethod
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Headers
Optionally supply custom headers
Type: IDictionary
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-OutFile
Saves the response body in the specified output file
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
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.