PowerShell CLI 2.0 - Cmdlets - Get-JS7CalendarDates

Name

Get-JS7CalendarDates

SYNOPSIS

Returns dates from a calendar with the JOC Cockpit inventory

SYNTAX

Get-JS7CalendarDates [-CalendarPath] <String> [[-DateFrom] <DateTime>] [[-DateTo] <DateTime>] [<CommonParameters>]

DESCRIPTION

Return the list of dates that are included with a calendar.

Past and future dates can be retrieved.

The following REST Web Service API resources are used:

* /calendar/dates

PARAMETERS

CalendarPath

-CalendarPath <String>
Specifies the path and name of a calendar that should be returned.

DateFrom

-DateFrom <DateTime>
Optionally specifies the date starting from which calendar dates should be returned.
Consider that a UTC date has to be provided.

Default: Beginning of the current day as a UTC date

DateTo

-DateTo <DateTime>
Optionally specifies the date until which calendar dates should be returned.
Consider that a UTC date has to be provided.

Default: End of the calendar's date range or the end of the current year as a UTC date.

RELATED LINKS

about_JS7

EXAMPLES

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

PS > $dates = Get-JS7CalendarDates -CalendarPath /BusinessDays

Returns the dates specified by the indicated calendar that is stored with the path "/BusinessDays".

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

PS > $dates = Get-JS7CalendarDates -CalendarPath /BusinessDays -DateTo (Get-Date).AddDays(30)

Returns the calendar dates for the next 30 days.

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

PS > $dates = Get-JS7Calendar -WorkingDays | Get-JS7calendarDates

Returns the dates from any working day calendars available with the inventory.