Public/Company/CompanyStates/Get-CWMCompanyState.ps1
|
<#
.SYNOPSIS Gets states. .DESCRIPTION Retrieves the states from ConnectWise Manage, or a single state by id. Calls GET /company/states; -id adds /{id} and -count adds /count. .PARAMETER id The id of a single state to retrieve. .PARAMETER count Return only the number of matching states instead of the records. .PARAMETER condition Filter in ConnectWise Manage condition syntax, for example "name contains 'Support'". .PARAMETER orderBy Sort order as 'field asc' or 'field desc', for example 'id desc'. .PARAMETER childConditions Filter on child (list) fields, in condition syntax. .PARAMETER customFieldConditions Filter on custom field values, in condition syntax. .PARAMETER page The page number to return. Use with -pageSize. .PARAMETER pageSize The number of records per page. Without it the API's default page size applies. .PARAMETER fields Only return these fields, for example @('id', 'name'). .PARAMETER all Retrieve every matching record, handling pagination automatically. .EXAMPLE Get-CWMCompanyState -condition "name contains 'Support'" -all Retrieves the states that match the condition. .EXAMPLE Get-CWMCompanyState -id 5 Retrieves state 5. .LINK https://developer.connectwise.com/manage/rest #> function Get-CWMCompanyState { [CmdletBinding()] param( [int]$id, [switch]$count, [string]$condition, [ValidatePattern('\S* (desc|asc)')] [string]$orderBy, [string]$childConditions, [string]$customFieldConditions, [int]$page, [int]$pageSize, [string[]]$fields, [switch]$all ) $Endpoint = '/company/states' Invoke-CWMGetMaster -Arguments $PsBoundParameters -Endpoint $Endpoint } |