Skip to content

Latest commit

 

History

History
100 lines (94 loc) · 5.87 KB

Get-CWMBoardStatus.md

File metadata and controls

100 lines (94 loc) · 5.87 KB

Get-CWMBoardStatus

SYNOPSIS

This function will list the statuses of a service board based on conditions.

SYNTAX

Get-CWMBoardStatus [-ServiceBoardID] <Int32> [[-Condition] <String>] [[-orderBy] <Object>] [[-childconditions] <String>] [[-customfieldconditions] <String>] [[-page] <Int32>] [[-pageSize] <Int32>] [-all] [<CommonParameters>]

PARAMETERS

-ServiceBoardID <Int32>

The ID of the service board you want to retrieve stateses for.

Required                    true
Position                    1
Default value                0
Accept pipeline input       false
Accept wildcard characters  false

-Condition <String>

This is your search condition to return the results you desire.

Example:

(contact/name like "Fred%" and closedFlag = false) and dateEntered > [2015-12-23T05:53:27Z] or summary contains "test" AND summary != "Some Summary"

Required                    false
Position                    2
Default value
Accept pipeline input       false
Accept wildcard characters  false

-orderBy <Object>

Choose which field to sort the results by

Required                    false
Position                    3
Default value
Accept pipeline input       false
Accept wildcard characters  false

-childconditions <String>

Allows searching arrays on endpoints that list childConditions under parameters

Required                    false
Position                    4
Default value
Accept pipeline input       false
Accept wildcard characters  false

-customfieldconditions <String>

Allows searching custom fields when customFieldConditions is listed in the parameters

Required                    false
Position                    5
Default value
Accept pipeline input       false
Accept wildcard characters  false

-page <Int32>

Used in pagination to cycle through results

Required                    false
Position                    6
Default value                0
Accept pipeline input       false
Accept wildcard characters  false

-pageSize <Int32>

Number of results returned per page (Defaults to 25)

Required                    false
Position                    7
Default value                0
Accept pipeline input       false
Accept wildcard characters  false

-all <SwitchParameter>

Return all results

Required                    false
Position                    named
Default value                False
Accept pipeline input       false
Accept wildcard characters  false

EXAMPLES

EXAMPLE 1

PS C:\>Get-CWMBoardStatus -ServiceBoardID -Condition "status/id IN (1,42,43,57)" -all

Will return all <SOMETHING> that match the condition

NOTES

Author: Chris Taylor

Date: 10/22/2018

LINKS

http://labtechconsulting.com

https://developer.connectwise.com/products/manage/rest?a=Service&e=BoardStatuses&o=GET