Get-MyITProcessInitiatives
SYNOPSIS
List of initiatives
SYNTAX
Get-MyITProcessInitiatives [[-filter_field] <String>] [[-filter_predicate] <String>]
[[-filter_condition] <String>] [[-filter_operator] <String>] [[-sort_field] <String>]
[[-sort_direction] <String>] [[-page] <Int64>] [[-pageSize] <Int64>] [-allPages] [<CommonParameters>]
DESCRIPTION
The Get-MyITProcessInitiatives cmdlet gets a list of initiatives
Initiatives are located under Strategy > Client > Menu > Initiatives
EXAMPLES
EXAMPLE 1
Get-MyITProcessInitiatives
Returns the first 100 initiatives
EXAMPLE 2
Get-MyITProcessInitiatives -filter_field client.id -filter_predicate equal -filter_condition '123456789'
Returns the initiatives whose client.id equals the defined condition
EXAMPLE 3
Get-MyITProcessInitiatives -sort_field client.id -sort_direction desc
Returns the first 100 initiatives sorted by client.id in descending order
EXAMPLE 4
Get-MyITProcessInitiatives -page 2 -pageSize 50
Returns results 50 at a time and outputs data from page 2
PARAMETERS
-filter_field
Filter by a specific field name
Allowed values: ‘id’, ‘client.id’, ‘client.name’, ‘title’, ‘description’, ‘isArchived’, ‘recommendationsIds’
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-filter_predicate
Filter by a specific field predicate operator
Allowed values: ‘equal’, ‘notEqual’, ‘greaterThan’, ‘lessThan’, ‘contains’
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-filter_condition
Filter by a value in the specified field.
This value cannot be empty
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-filter_operator
Also filter for other values
Allowed values: ‘and’, ‘or’, $null
This parameter is just a placeholder for now as I am unsure how to add this functionality if multiple queries are needed
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-sort_field
Sort by a specific field name
Allowed values: ‘id’, ‘client.id’, ‘client.name’, ‘title’, ‘description’, ‘isArchived’, ‘recommendationsIds’
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-sort_direction
Sort the specific field name in a certain direction
Allowed values: ‘asc’, ‘desc’
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-page
Defines the page number to return
[Default] 1
Type: Int64
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-pageSize
Defines the number of items to return with each page
[Default] 100 [Maximum] 100
Type: Int64
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-allPages
Returns all items from an endpoint
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
OUTPUTS
NOTES
N\A