Skip to content

Get-HaloTeam

SYNOPSIS

Gets teams from the Halo API.

SYNTAX

Multi (Default)

1
2
Get-HaloTeam [-Type <String>] [-IncludeAgentsForTeams <String>] [-MemberOnly] [-ShowCounts] [-Domain <String>]
 [-ViewID <Int32>] [-IncludeEnabled] [-IncludeDisabled] [-DepartmentID <Int32>] [<CommonParameters>]

Single

1
Get-HaloTeam -TeamID <Int64> [-IncludeDetails] [<CommonParameters>]

DESCRIPTION

Retrieves teams from the Halo API - supports a variety of filtering parameters.

EXAMPLES

Example 1

1
PS C:\> {{ Add example code here }}

{{ Add example description here }}

PARAMETERS

-TeamID

Team ID

1
2
3
4
5
6
7
8
9
Type: Int64
Parameter Sets: Single
Aliases:

Required: True
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Type

Filter teams to a specific type: reqs = tickets, opps = opportunities and prjs = projects.

1
2
3
4
5
6
7
8
9
Type: String
Parameter Sets: Multi
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IncludeAgentsForTeams

Teams to return agents for in the results. Comma separated string.

1
2
3
4
5
6
7
8
9
Type: String
Parameter Sets: Multi
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-MemberOnly

Only include teams the current agent is a member of.

1
2
3
4
5
6
7
8
9
Type: SwitchParameter
Parameter Sets: Multi
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ShowCounts

Show the count of team tickets in the results.

1
2
3
4
5
6
7
8
9
Type: SwitchParameter
Parameter Sets: Multi
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Domain

Filter counts to a specific domain: reqs = tickets, opps = opportunities and prjs = projects.

1
2
3
4
5
6
7
8
9
Type: String
Parameter Sets: Multi
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ViewID

Filter counts to a specific view ID.

1
2
3
4
5
6
7
8
9
Type: Int32
Parameter Sets: Multi
Aliases: view_id

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-IncludeEnabled

Include enabled teams (defaults to $True).

1
2
3
4
5
6
7
8
9
Type: SwitchParameter
Parameter Sets: Multi
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IncludeDisabled

Include disabled teams.

1
2
3
4
5
6
7
8
9
Type: SwitchParameter
Parameter Sets: Multi
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-DepartmentID

Filter by the specified department ID.

1
2
3
4
5
6
7
8
9
Type: Int32
Parameter Sets: Multi
Aliases: department_id

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-IncludeDetails

Include extra objects in the result.

1
2
3
4
5
6
7
8
9
Type: SwitchParameter
Parameter Sets: Single
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

A powershell object containing the response.

NOTES