Skip to content

RGSAActionStatusApi.md

Latest commit

 

History

History
230 lines (161 loc) · 8.62 KB

RGSAActionStatusApi.md

File metadata and controls

230 lines (161 loc) · 8.62 KB

RealGreenSaPS.RealGreenSaPS\Api.RGSAActionStatusApi

All URIs are relative to https://saapi.realgreen.com

Method HTTP request Description
Invoke-RGSAActionStatusDefaultStatusDefstatGet GET /ActionStatus/DefaultStatus/{defstat} Returns a list of action statuses that are/are not default statuses based on the provided defstat value.
Invoke-RGSAActionStatusGet GET /ActionStatus Returns all action statuses in the database.
Invoke-RGSAActionStatusHandheldHandheldGet GET /ActionStatus/Handheld/{handheld} Returns a list of action statuses that are/are not available on handheld devices based on the provided handheld value.
Invoke-RGSAActionStatusResolvedResolvedGet GET /ActionStatus/Resolved/{resolved} Returns a list of action statuses that correspond to the provided resolved value.
Invoke-RGSAActionStatusStatusStatusGet GET /ActionStatus/Status/{status} Returns a single action status record that corresponds to the status provided.

Invoke-RGSAActionStatusDefaultStatusDefstatGet

ActionStatus[] Invoke-RGSAActionStatusDefaultStatusDefstatGet
        [-Defstat]
        [-ApiKey]

Returns a list of action statuses that are/are not default statuses based on the provided defstat value.

Example

$Defstat = $true # Boolean | 
$ApiKey = "MyApiKey" # String | API Key

# Returns a list of action statuses that are/are not default statuses based on the provided defstat value.
try {
    $Result = Invoke-RGSAActionStatusDefaultStatusDefstatGet -Defstat $Defstat -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAActionStatusDefaultStatusDefstatGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Defstat Boolean
ApiKey String API Key

Return type

ActionStatus[] (PSCustomObject)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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

Invoke-RGSAActionStatusGet

ActionStatus[] Invoke-RGSAActionStatusGet
        [-ApiKey]

Returns all action statuses in the database.

Example

$ApiKey = "MyApiKey" # String | API Key

# Returns all action statuses in the database.
try {
    $Result = Invoke-RGSAActionStatusGet -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAActionStatusGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
ApiKey String API Key

Return type

ActionStatus[] (PSCustomObject)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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

Invoke-RGSAActionStatusHandheldHandheldGet

ActionStatus[] Invoke-RGSAActionStatusHandheldHandheldGet
        [-Handheld]
        [-ApiKey]

Returns a list of action statuses that are/are not available on handheld devices based on the provided handheld value.

Example

$Handheld = $true # Boolean | 
$ApiKey = "MyApiKey" # String | API Key

# Returns a list of action statuses that are/are not available on handheld devices based on the provided handheld value.
try {
    $Result = Invoke-RGSAActionStatusHandheldHandheldGet -Handheld $Handheld -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAActionStatusHandheldHandheldGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Handheld Boolean
ApiKey String API Key

Return type

ActionStatus[] (PSCustomObject)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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

Invoke-RGSAActionStatusResolvedResolvedGet

ActionStatus[] Invoke-RGSAActionStatusResolvedResolvedGet
        [-Resolved]
        [-ApiKey]

Returns a list of action statuses that correspond to the provided resolved value.

Example

$Resolved = $true # Boolean | 
$ApiKey = "MyApiKey" # String | API Key

# Returns a list of action statuses that correspond to the provided resolved value.
try {
    $Result = Invoke-RGSAActionStatusResolvedResolvedGet -Resolved $Resolved -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAActionStatusResolvedResolvedGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Resolved Boolean
ApiKey String API Key

Return type

ActionStatus[] (PSCustomObject)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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

Invoke-RGSAActionStatusStatusStatusGet

ActionStatus Invoke-RGSAActionStatusStatusStatusGet
        [-Status]
        [-ApiKey]

Returns a single action status record that corresponds to the status provided.

Example

$Status = "MyStatus" # String | 
$ApiKey = "MyApiKey" # String | API Key

# Returns a single action status record that corresponds to the status provided.
try {
    $Result = Invoke-RGSAActionStatusStatusStatusGet -Status $Status -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSAActionStatusStatusStatusGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Status String
ApiKey String API Key

Return type

ActionStatus (PSCustomObject)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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