Name

Get-JS7InventoryFolder

SYNOPSIS

Returns the configuration of JOC Cockpit inventory items from a folder, e.g. a workflow

SYNTAX

Get-JS7InventoryFolder [[-Folder] <String>] [-Recursive] [[-Type] <String[]>] [-Valid] [<CommonParameters>]

DESCRIPTION

Any inventory objects are returned in their native JSON reperesentation.

The following REST Web Service API resources are used:

* /inventory/folder

PARAMETERS

Folder

-Folder <String>
Specifies the folder for which workflows should be returned.

Required?false
Position?1
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 workflows.

Required?false
Position?named
Default valueFalse
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

Type

-Type <String[]>
Specifies the object type which is one of:

* Any Object Type
** FOLDER
* Deployable Object Types
** WORKFLOW
** FILEORDERSOURCE
** JOBRESOURCE
** NOTICEBOARD
** LOCK
* Releasable Object Types
** INCLUDESCRIPT
** JOBTEMPLATE
** WORKINGDAYSCALENDAR
** NONWORKINGDAYSCALENDAR
** SCHEDULE
** REPORT

Required?false
Position?2
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

Valid

-Valid <SwitchParameter>

Required?false
Position?named
Default valueFalse
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

about_JS7

EXAMPLES

-------------------------- EXAMPLE 1 --------------------------

PS > $fos = Get-JS7InventoryFolder -Folder /JS7Demo/08_FileWatching -Type FILEORDERSOURCE

Returns the inventory objects for file order sources from the given folder.

  • No labels