JS7 JobScheduler

Space shortcuts

Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Name

Get-JS7NoticeBoard

SYNOPSIS

Returns a number of Notice Boards

SYNTAX

Get-JS7NoticeBoard [[-NoticeBoardPath] <String>] [[-Folder] <String>] [-Recursive] [[-ControllerId] <String>] [[-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 valueFalse
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?3
Default value
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?4
Default value10000
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

about_JS7

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.

  • No labels