JS7 JobScheduler

Space shortcuts

Page tree

Name

Get-JS7Workflow

SYNOPSIS

Returns workflows from the JOC Cockpit inventory

SYNTAX

Get-JS7Workflow [[-WorkflowPath] <String>] [[-WorkflowVersionId] <String>] [[-Folder] <String>] [-Recursive] [[-RegularExpression] <String>] [-Compact] [<CommonParameters>]

DESCRIPTION

Workflows are returned from JOC Cockpit - independently of their deployment status with specific Controller instances.
Workflows can be selected either by the folder of the workflow location including sub-folders or by an individual workflow path.

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

The following REST Web Service API resources are used:

* /workflows

PARAMETERS

WorkflowPath

-WorkflowPath <String>
Optionally specifies the path and name of a workflow that should be returned.

One of the parameters -Folder, -WorkflowPath or -RegularExpression has to be specified.

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

WorkflowVersionId

-WorkflowVersionId <String>
Deployed workflows are assigned a version identifier. This parameter allows selection of
a workflow that is assigned the specified version identifier.

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

Folder

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

One of the parameters -Folder, -WorkflowPath or -RegularExpression has to be specified.

Required?false
Position?3
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

RegularExpression

-RegularExpression <String>
Limits results to workflow paths that correspond to the given regular expression.

One of the parameters -Folder, -WorkflowPath or -RegularExpression has to be specified.

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

Compact

-Compact <SwitchParameter>
Specifies that fewer attributes of a workflow are returned.

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

about_JS7

EXAMPLES

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

PS > $workflows = Get-JS7Workflow

Returns all workflows.

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

PS > $workflows = Get-JS7Workflow -Folder /some_folder -Recursive

Returns all workflows that are configured with the specified folder including any sub-folders.

-------------------------- EXAMPLE 3 --------------------------

PS > $workflows = Get-JS7Workflow -WorkflowPath /test/globals/workflow1

Returns the workflow "workflow1" from the folder "/test/globals".

  • No labels