Skip to content

RGSADocumentCategoryApi.md

Latest commit

 

History

History
323 lines (228 loc) · 12.8 KB

RGSADocumentCategoryApi.md

File metadata and controls

323 lines (228 loc) · 12.8 KB

RealGreenSaPS.RealGreenSaPS\Api.RGSADocumentCategoryApi

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

Method HTTP request Description
Invoke-RGSADocumentCategoryAvailableOnMobileHandheldGet GET /DocumentCategory/AvailableOnMobile/{handheld} Retrieve a list of document categories that are (webavail=true) or are not (webavail=false) available on Mobile.
Invoke-RGSADocumentCategoryAvailableOnWebWebavailGet GET /DocumentCategory/AvailableOnWeb/{webavail} Retrieve a list of document categories that are (webavail=true) or are not (webavail=false) available on CAW.
Invoke-RGSADocumentCategoryGet GET /DocumentCategory Retreive all document categories in the database.
Invoke-RGSADocumentCategoryIdGet GET /DocumentCategory/{id} Return a single document category record that correseponds to the provided ID
Invoke-RGSADocumentCategoryIdPatch PATCH /DocumentCategory/{id} Update a portion of a document category without sending the entire category object.
Invoke-RGSADocumentCategoryPost POST /DocumentCategory Insert a new document category.
Invoke-RGSADocumentCategoryPut PUT /DocumentCategory Update an entire existing document category.

Invoke-RGSADocumentCategoryAvailableOnMobileHandheldGet

DocumentCategory[] Invoke-RGSADocumentCategoryAvailableOnMobileHandheldGet
        [-Handheld]
        [-ApiKey]

Retrieve a list of document categories that are (webavail=true) or are not (webavail=false) available on Mobile.

Example

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

# Retrieve a list of document categories that are (webavail=true) or are not (webavail=false) available on Mobile.
try {
    $Result = Invoke-RGSADocumentCategoryAvailableOnMobileHandheldGet -Handheld $Handheld -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSADocumentCategoryAvailableOnMobileHandheldGet: {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

DocumentCategory[] (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-RGSADocumentCategoryAvailableOnWebWebavailGet

DocumentCategory[] Invoke-RGSADocumentCategoryAvailableOnWebWebavailGet
        [-Webavail]
        [-ApiKey]

Retrieve a list of document categories that are (webavail=true) or are not (webavail=false) available on CAW.

Example

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

# Retrieve a list of document categories that are (webavail=true) or are not (webavail=false) available on CAW.
try {
    $Result = Invoke-RGSADocumentCategoryAvailableOnWebWebavailGet -Webavail $Webavail -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSADocumentCategoryAvailableOnWebWebavailGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Webavail Boolean
ApiKey String API Key

Return type

DocumentCategory[] (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-RGSADocumentCategoryGet

DocumentCategory[] Invoke-RGSADocumentCategoryGet
        [-ApiKey]

Retreive all document categories in the database.

Example

$ApiKey = "MyApiKey" # String | API Key

# Retreive all document categories in the database.
try {
    $Result = Invoke-RGSADocumentCategoryGet -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSADocumentCategoryGet: {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

DocumentCategory[] (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-RGSADocumentCategoryIdGet

DocumentCategory Invoke-RGSADocumentCategoryIdGet
        [-Id]
        [-ApiKey]

Return a single document category record that correseponds to the provided ID

Example

$Id = 56 # Int32 | 
$ApiKey = "MyApiKey" # String | API Key

# Return a single document category record that correseponds to the provided ID
try {
    $Result = Invoke-RGSADocumentCategoryIdGet -Id $Id -ApiKey $ApiKey
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSADocumentCategoryIdGet: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Id Int32
ApiKey String API Key

Return type

DocumentCategory (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-RGSADocumentCategoryIdPatch

Customer Invoke-RGSADocumentCategoryIdPatch
        [-Id]
        [-ApiKey]
        [-Operation] <PSCustomObject[]>

Update a portion of a document category without sending the entire category object.

Example

$Id = 56 # Int32 | 
$ApiKey = "MyApiKey" # String | API Key
$Operation = Initialize-Operation -OperationType "Add" -Path "MyPath" -Op "MyOp" -VarFrom "MyVarFrom" -Value # Operation[] |  (optional)

# Update a portion of a document category without sending the entire category object.
try {
    $Result = Invoke-RGSADocumentCategoryIdPatch -Id $Id -ApiKey $ApiKey -Operation $Operation
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSADocumentCategoryIdPatch: {0}" -f ($_.ErrorDetails | ConvertFrom-Json))
    Write-Host ("Response headers: {0}" -f ($_.Exception.Response.Headers | ConvertTo-Json))
}

Parameters

Name Type Description Notes
Id Int32
ApiKey String API Key
Operation Operation[] [optional]

Return type

Customer (PSCustomObject)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json

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

Invoke-RGSADocumentCategoryPost

DocumentCategory[] Invoke-RGSADocumentCategoryPost
        [-ApiKey]
        [-DocumentCategory]

Insert a new document category.

Example

$ApiKey = "MyApiKey" # String | API Key
$DocumentCategory = Initialize-DocumentCategory -Id 0 -Description "MyDescription" -DescriptionFrench "MyDescriptionFrench" -DescriptionSpanish "MyDescriptionSpanish" -AvailableOnWeb $false -AvailableOnMobile $false # DocumentCategory |  (optional)

# Insert a new document category.
try {
    $Result = Invoke-RGSADocumentCategoryPost -ApiKey $ApiKey -DocumentCategory $DocumentCategory
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSADocumentCategoryPost: {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
DocumentCategory DocumentCategory [optional]

Return type

DocumentCategory[] (PSCustomObject)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json

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

Invoke-RGSADocumentCategoryPut

DocumentCategory[] Invoke-RGSADocumentCategoryPut
        [-ApiKey]
        [-DocumentCategory]

Update an entire existing document category.

Example

$ApiKey = "MyApiKey" # String | API Key
$DocumentCategory = Initialize-DocumentCategory -Id 0 -Description "MyDescription" -DescriptionFrench "MyDescriptionFrench" -DescriptionSpanish "MyDescriptionSpanish" -AvailableOnWeb $false -AvailableOnMobile $false # DocumentCategory |  (optional)

# Update an entire existing document category.
try {
    $Result = Invoke-RGSADocumentCategoryPut -ApiKey $ApiKey -DocumentCategory $DocumentCategory
} catch {
    Write-Host ("Exception occurred when calling Invoke-RGSADocumentCategoryPut: {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
DocumentCategory DocumentCategory [optional]

Return type

DocumentCategory[] (PSCustomObject)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/*+json
  • Accept: text/plain, application/json, text/json

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