Name

Get-JS7InventoryDependencies

SYNOPSIS

Returns dependencies from the JOC Cockpit inventory

SYNTAX

Get-JS7InventoryDependencies [[-Name] <String>] [[-Type] <String>] [[-Configuration] <PSObject[]>] [[-Folder] <String>] [[-OperationType] <String>] [-NoReferencing] [-NoReferences] [<CommonParameters>]

DESCRIPTION

Dependencies are returned from the JOC Cockpit inventory per scheduling object
that is specified by its name and type.

The cmdlet returns the list of inventory objects that

* are referencing the requested scheduling object
* are referenced by the requested scheduling object

Resulting objects can be forwarded to other cmdlets for pipelined bulk operations.

The following REST Web Service API resources are used:

* /inventory/dependencies

PARAMETERS

Name

-Name <String>
Specifies the name of the scheduling object for which dependencies should be returned.

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

Type

-Type <String>
Specifies the type of the scheduling object for which dependencies should be returned.
The object type is one of:

* WORKFLOW
* JOBRESOURCE
* LOCK
* NOTICEBOARD
* FILEORDERSOURCE
* WORKINGDAYSCALENDAR
* NONWORKINGDAYSCALENDAR
* SCHEDULE
* JOBTEMPLATE

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

Configuration

-Configuration <PSObject[]>

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

Folder

-Folder <String>

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

OperationType

-OperationType <String>
Specifies the purpose of the list of objects that will be returned.
The operation type is one of:

* DEPLOY
* RELEASE
* REVOKE
* RECALL
* REMOVE
* EXPORT
* GIT

Required?false
Position?5
Default valueDEPLOY
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

NoReferencing

-NoReferencing <SwitchParameter>

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

NoReferences

-NoReferences <SwitchParameter>

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

about_JS7

EXAMPLES

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

PS > $dependencies = Get-JS7InventoryDependencies -Name myWorkflow -Type WORKFLOW

Returns dependencies of the indicated workflow from the JOC Cockpit inventory.

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

PS > $configuration = New-Object PSObject
Add-Member -Membertype NoteProperty -Name 'name' -value 'MyWorkflow' -InputObject $configuration
Add-Member -Membertype NoteProperty -Name 'type' -value 'WORKFLOW' -InputObject $configuration
$configurations = @( $configuration )
$dependencies = Get-JS7InventoryDependencies -Configuration $configurations

Creates an array of configuration objects that hold the 'name' and 'type' property. The object is passed to the cmdlet that will return dependencies for the indicated scheduling objects.

  • No labels