openapi-generator/samples/client/echo_api/powershell/docs/FormApi.md

PSOpenAPITools.PSOpenAPITools\Api.FormApi

All URIs are relative to http://localhost:3000

Method	HTTP request	Description
Test-FormIntegerBooleanString	POST /form/integer/boolean/string	Test form parameter(s)
Test-FormObjectMultipart	POST /form/object/multipart	Test form parameter(s) for multipart schema
Test-FormOneof	POST /form/oneof	Test form parameter(s) for oneOf schema

Test-FormIntegerBooleanString

String Test-FormIntegerBooleanString
        [-IntegerForm] <System.Nullable[Int32]>
        [-BooleanForm] <System.Nullable[Boolean]>
        [-StringForm]

Test form parameter(s)

Test form parameter(s)

Example

$IntegerForm = 56 # Int32 |  (optional)
$BooleanForm = $true # Boolean |  (optional)
$StringForm = "MyStringForm" # String |  (optional)

# Test form parameter(s)
try {
    $Result = Test-FormIntegerBooleanString -IntegerForm $IntegerForm -BooleanForm $BooleanForm -StringForm $StringForm
} catch {
    Write-Host ("Exception occurred when calling Test-FormIntegerBooleanString: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
IntegerForm	Int32		[optional]
BooleanForm	Boolean		[optional]
StringForm	String		[optional]

Return type

String

Authorization

No authorization required

HTTP request headers

• Content-Type: application/x-www-form-urlencoded
• Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Test-FormObjectMultipart

String Test-FormObjectMultipart
        [-Marker]

Test form parameter(s) for multipart schema

Test form parameter(s) for multipart schema

Example

$TestFormObjectMultipartRequestMarker = Initialize-TestFormObjectMultipartRequestMarker -Name "MyName" # TestFormObjectMultipartRequestMarker | 

# Test form parameter(s) for multipart schema
try {
    $Result = Test-FormObjectMultipart -Marker $Marker
} catch {
    Write-Host ("Exception occurred when calling Test-FormObjectMultipart: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
Marker	TestFormObjectMultipartRequestMarker

Return type

String

Authorization

No authorization required

HTTP request headers

• Content-Type: multipart/form-data
• Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Test-FormOneof

String Test-FormOneof
        [-Form1]
        [-Form2] <System.Nullable[Int32]>
        [-Form3]
        [-Form4] <System.Nullable[Boolean]>
        [-Id] <System.Nullable[Int64]>
        [-Name]

Test form parameter(s) for oneOf schema

Test form parameter(s) for oneOf schema

Example

$Form1 = "MyForm1" # String |  (optional)
$Form2 = 56 # Int32 |  (optional)
$Form3 = "MyForm3" # String |  (optional)
$Form4 = $true # Boolean |  (optional)
$Id = 789 # Int64 |  (optional)
$Name = "MyName" # String |  (optional)

# Test form parameter(s) for oneOf schema
try {
    $Result = Test-FormOneof -Form1 $Form1 -Form2 $Form2 -Form3 $Form3 -Form4 $Form4 -Id $Id -Name $Name
} catch {
    Write-Host ("Exception occurred when calling Test-FormOneof: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name	Type	Description	Notes
Form1	String		[optional]
Form2	Int32		[optional]
Form3	String		[optional]
Form4	Boolean		[optional]
Id	Int64		[optional]
Name	String		[optional]

Return type

String

Authorization

No authorization required

HTTP request headers

• Content-Type: application/x-www-form-urlencoded
• Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]