Name
Get-JS7NoticeBoard
SYNOPSIS
Returns a number of Notice Boards
SYNTAX
Get-JS7NoticeBoard [[-NoticeBoardPath] <String>] [[-Folder] <String>] [-Recursive] [[-PlanSchemaId] <String[]>] [[-PlanKey] <String[]>] [[-ControllerId] <String>] [-Compact] [[-Limit] <Int32>] [<CommonParameters>]
DESCRIPTION
This cmdlet returns a number of Notices Boards including Notices.
The following REST Web Service API resources are used:
* /notice/boards
PARAMETERS
NoticeBoardPath
-NoticeBoardPath <String>
Specifies the path to a Notice Board.
The path includes folder and sub-folders and the name of the Notice Board.
| Required? | false |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Folder
-Folder <String>
Specifies the folder and optionally sub-folders from which Notices are returned.
| Required? | false |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Recursive
-Recursive <SwitchParameter>
When used with the -Folder parameter specifies that any sub-folders should be looked up.
By default no sub-folders will be searched for Notice Boards.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
PlanSchemaId
-PlanSchemaId <String[]>
Specifies the Schema ID of the Plan to which notices are assigned.
One of the following can be specified:
* Global
* DailyPlan
| Required? | false |
| Position? | 3 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
PlanKey
-PlanKey <String[]>
For plannable Notice Boards specified from the -PlanSchemaId argument with the value 'DailyPlan'
the key of the plan instance is a date in ISO format: yyyy-mm-dd.
The argument is ignored if the -PlanSchemaId argument is used with a value 'global'.
| Required? | false |
| Position? | 4 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
ControllerId
-ControllerId <String>
Optionally specifies the identification of the Controller from which to read Notices.
| Required? | false |
| Position? | 5 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Compact
-Compact <SwitchParameter>
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Limit
-Limit <Int32>
Specifies the number of Notice Boards for which notices are returned.
* Default: 10000
* Umlimited: -1
| Required? | false |
| Position? | 6 |
| Default value | 10000 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > $boards = Get-JS7NoticeBoards
Returns all Notice Boards.
-------------------------- EXAMPLE 2 --------------------------
PS > $boards = Get-JS7NoticeBoards -Path /ProductDemo/Sequencing/pdSequenceSynchroneously
Returns the indicated Notice Board.
-------------------------- EXAMPLE 3 --------------------------
PS > $boards = Get-JS7NoticeBoards -Folder /ProductDemo -Recursive
Returns Notice Boards and Notices from the indicated folder and any sub-folders.
Overview
Content Tools