Name
Get-JS7DeployableItem
SYNOPSIS
Returns deployable scheduling objects such as workflows from the JOC Cockpit inventory
SYNTAX
Get-JS7DeployableItem [[-Path] <String>] [[-Type] <String[]>] [[-Folder] <String>] [-Recursive] [-Valid] [-NoDraft] [-NoDeployed] [-Latest] [<CommonParameters>]
DESCRIPTION
This cmdlet returns deployable scheduling objects from the JOC Cockpit inventory.
The following REST Web Service API resources are used:
* /inventory/deployable
* /inventory/deployables
PARAMETERS
Path
-Path <String>
Specifies the folder, sub-folder and name of the object, e.g. a workflow 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:
* WORKFLOW
* FILEORDERSOURCE
* JOBRESOURCE
* NOTICEBOARD
* LOCK
| 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 any deployable inventory object from a folder.
| 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 value | False |
| 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 value | False |
| 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 deployed objects will be returned.
Possible use cases include to deploy to a different Controller or to redeploy to the same Controller.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
NoDeployed
-NoDeployed <SwitchParameter>
Specifies that no previously deployed objects should be returned. This is usefule to prevent redeployment of objects.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Latest
-Latest <SwitchParameter>
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Get-JS7DeployableItem -Path /TestCases/sampleWorkflow_001 -Type 'WORKFLOW'
Returns the specified workflow from the indicated path.
-------------------------- EXAMPLE 2 --------------------------
PS > Get-JS7DeployableItem -Folder /TestRuns -Recursive
Returns deployable objects such as workflows from the specified folder recursively.
Overview
Content Tools