JS7 JobScheduler

Space shortcuts

Page tree

Name

Get-JS7ReleasableItem

SYNOPSIS

Returns releasable 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 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.

Required?false
Position?1
Default value
Accept pipeline input?true (ByValue, ByPropertyName)
Accept wildcard characters?false

Type

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

* INCLUDESCRIPT
* JOBTEMPLATE
* SCHEDULE
* WORKINGDAYSCALENDAR
* NONWORKINGDAYSCALENDAR
* REPORT

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

Folder

-Folder <String>
Optionally specifies the folder for which included inventory objects should be returned.
This parameter is used alternatively to the -Path parameter that specifies to return an individual inventory object.

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

Recursive

-Recursive <SwitchParameter>
Specifies that all sub-folders should be looked up. By default no sub-folders will be considered.

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

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

PS > Get-JS7ReleasableItem -Path /TestCases/sampleSchedule001 -Type 'SCHEDULE'

Returns the specified schedule with the indicated path.

-------------------------- EXAMPLE 2 --------------------------

PS > Get-JS7ReleasableItem -Folder /TestCases -Recursive

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

  • No labels