PowerShell CLI 2.0 - Cmdlets - Restore-JS7InventoryItem

Name

Restore-JS7InventoryItem

SYNOPSIS

Restores objects such as workflows from the JOC Cockpit inventory trash

SYNTAX

Restore-JS7InventoryItem [-Path] <String> [-Type] <String> [[-NewPath] <String>] [[-Prefix] <String>] [[-Suffix] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]

DESCRIPTION

This cmdlet restores objects such as workflows that have previously been removed and that are available from the trash.

Typically removal of objects is committed and objects are added to the trash with one of the cmdlets:

* For deployable objects use of the cmdlet the Publish-JS7DeployableItem cmdlet with the -Delete switch commits permanent deletion.
* For releasable objects use of the cmdlet the Publish-JS7ReleasableOItem cmdlet with the -Delete switch commits permanent deletion.

The following REST Web Service API resources are used:

* /inventory/trash/restore

PARAMETERS

Path

-Path <String>
Specifies the folder and sub-folders of the object.

Type

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

* Deployable object types
** WORKFLOW
** FILEORDERSOURCE
** JOBRESOURCE
** NOTICEBOARD
** LOCK
* Releasable object types
** INCLUDESCRIPT
** JOBTEMPLATE
** WORKINGDAYSCALENDAR
** NONWORKINGDAYSCALENDAR
** SCHEDULE
** REPORT

NewPath

-NewPath <String>
Optionally specifies the new path for the restored object. If this parameter is not used then the original path will be restored.
If a path with the same hierarchy and name exists then the removed path cannot be restored. You could consider using the -Prefix
and -Suffix parameters to create unique folder names.

Prefix

-Prefix <String>
Optionally specifies a prefix that is prepended to the restored object's path. If the same path already exists then incremental numbers will be added
to the prefix until a unique path is created.

Suffix

-Suffix <String>
Optionally specifies a suffix that is appended to the restored object's path. If the same path already exists then incremental numbers will be added
to the suffix until a unique path is created.

AuditComment

-AuditComment <String>
Specifies a free text that indicates the reason for the current intervention, e.g. "business requirement", "maintenance window" etc.

The Audit Comment is visible from the Audit Log view of the JOC Cockpit.
This parameter is not mandatory. However, the JOC Cockpit can be configured to require Audit Log comments for all interventions.

AuditTimeSpent

-AuditTimeSpent <Int32>
Specifies the duration in minutes that the current intervention required.

This information is shown in the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JS7.

AuditTicketLink

-AuditTicketLink <Uri>
Specifies a URL to a ticket system that keeps track of any interventions performed for JS7.

This information is shown in the Audit Log view of JOC Cockpit.
It can be useful when integrated with a ticket system that logs interventions with JS7.

RELATED LINKS

about_JS7

EXAMPLES

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

PS > Restore-JS7InventoryItem -Path /some_folder/sampleWorkflow -Type 'WORKFLOW'

Restores the indicated worfklow in the JOC Cockpit inventory.