Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

SYNOPSIS

Returns releasable configuration scheduling objects such as schedules from the JOC Cockpit inventory.

SYNTAX

Get-JS7ReleasableItem [[-Path] <String>] [[-Type] <String[]>] [[-Folder] <String>] [-Recursive] [-Valid] [-NoDraft] [-NoReleased] [<CommonParameters>]

DESCRIPTION

This cmdlet returns releasable configuration scheduling objects from the JOC Cockpit inventory.
Such objects are not deployed to Controllers and Agents but are used by JOC Cockpit services
for example to automatically create orders for the daily plan.

The following REST Web Service API resources are used:

* /inventory/releasable
* /inventory/releasables

PARAMETERS

Path

-Path <String>
Specifies the folder, sub-folder and name of the object, e.g. a schedule path.

...

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

* INCLUDESCRIPT
* SCHEDULE
* WORKINGDAYSCALENDAR
* NONWORKINGDAYSCALENDAR

...

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

...

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

Valid

-Valid <SwitchParameter>
Limits the scope to valid schedudling objects only.

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

NoDraft

-NoDraft <SwitchParameter>
Specifies that no draft objects should be returned. This boils down to the fact that only previously released objects will be returned.

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

NoReleased

-NoReleased <SwitchParameter>
Specifies that no previously released objects should be returned.

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

about_JS7

EXAMPLES

...

PS > Get-JS7ReleasableItem -Folder /TestCases -Recursive -Type 'FOLDER'

Returns releasable objects from a folder and any sub-folders.