Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Name

Get-JS7RepositoryItem

SYNOPSIS

Returns a list of scheduling objects from a local Git repository

SYNTAX

Get-JS7RepositoryItem [-Folder] <String> [-Recursive] [-Local] [<CommonParameters>]

DESCRIPTION

A list of scheduling objects such as workflows etc. are returned from a local Git repository

* by the category for LOCAL or ROLLOUT scheduling objects,
* by the folder of the item location optionally including sub-folders.

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

The following REST Web Service API resources are used:

* /inventory/repository/read

PARAMETERS

Folder

-Folder <String>
Specifies the repository folder for which items should be returned.

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

Recursive

-Recursive <SwitchParameter>
Specifies that all sub-folders should be looked up if the -Folder parameter is used.
By default no sub-folders will be looked up.

Required?false
Position?named
Default valueFalse
Accept pipeline input?false
Accept wildcard characters?false

Local

-Local <SwitchParameter>
Specifies that a repository holding local scheduling objects should be used.
This corresponds to the LOCAL category. If this switch is not used then then
ROLLOUT category is assumed for a repository that holds scheduling objects
intended for rollout to later environments such as test, prod.

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

about_JS7

EXAMPLES

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

PS > $items = Get-JS7RepositoryItem -Folder /samples

Returns all items available with a repository of category ROLLOUT.

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

PS > $items = Get-JS7RepositoryItem -Folder /samples -Recursive

Returns all items available from the "/samples" folder including any sub-folders from a repository of category ROLLOUT.

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

PS > $items = Get-JS7RepositoryItem -Folder /samples/some_sub_folder -Local

Returns the items for scheduling objects that are local to the scheduling environment from the indicated folder.