Skip to main content

Get-HaloAsset

Generated Cmdlet Help

This page has been generated from the HaloAPI PowerShell module source. To make changes please edit the appropriate PowerShell source file.

SYNOPSIS

Gets assets from the Halo API.

SYNTAX

Multi (Default)

Get-HaloAsset [-Paginate] [-PageSize <Int32>] [-PageNo <Int32>] [-Search <String>] [-TicketID <Int64>]
[-ClientID <Int64>] [-SiteID <Int64>] [-Username <String>] [-AssetGroupID <Int64>] [-AssetTypeID <Int64>]
[-LinkedToID <Int64>] [-includeinactive] [-includeactive] [-includechildren] [-ContractID <Int64>]
[-FullObjects] [-AdvancedSearch <String>] [-AssetGroups <Int32[]>] [-AssetStatuses <String[]>]
[-AssetTypes <Int32[]>] [-Bookmarked] [-ColumnsID <Int32>] [-Consignable] [-IncludeBillingPeriod]
[-Count <Int32>] [-DomotzAgents] [-ExcludeThese <Int32[]>] [-IDOnly] [-includeallowedstatus]
[-includeassetfields] [-includecolumns] [-includeservices] [-includeuser] [-IntegrationTenantIDs <Int32[]>]
[-InventoryNumber <String>] [-ItemId <Int32>] [-ItemStockId <Int32>] [-KBId <Int32>] [-lastupdatefromdate]
[-lastupdatetodate] [-LicenseID <Int32>] [-Mine] [-MySite] [-NoIcon] [-Order <String>] [-OrderDesc]
[-Order2 <String>] [-OrderDesc2] [-Order3 <String>] [-OrderDesc3] [-Order4 <String>] [-OrderDesc4]
[-Order5 <String>] [-OrderDesc5] [-ServiceId <Int32>] [-ServiceIds <Int32[]>] [-StockBinId <Int32>]
[-StockBinIds <Int32[]>] [-SupplierContractId <Int32>] [-SupplierId <Int32>] [-SupplierContracts <Int32[]>]
[-TicketTypeId <Int32>] [-UserId <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Single

Get-HaloAsset -AssetID <Int64> [-IncludeDetails] [-IncludeDiagramDetails] [-ProgressAction <ActionPreference>]
[<CommonParameters>]

DESCRIPTION

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

EXAMPLES

PARAMETERS

-AssetID

Asset ID

Type: Int64
Parameter Sets: Single
Aliases:

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

-Paginate

Paginate results

Type: SwitchParameter
Parameter Sets: Multi
Aliases: pageinate

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

-PageSize

Number of results per page.

Type: Int32
Parameter Sets: Multi
Aliases: page_size

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

-PageNo

Which page to return.

Type: Int32
Parameter Sets: Multi
Aliases: page_no

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

Filter by Assets with an asset field like your search

Type: String
Parameter Sets: Multi
Aliases:

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

-TicketID

Filter by Assets belonging to a particular ticket

Type: Int64
Parameter Sets: Multi
Aliases: ticket_id

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

-ClientID

Filter by Assets belonging to a particular client

Type: Int64
Parameter Sets: Multi
Aliases: client_id

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

-SiteID

Filter by Assets belonging to a particular site

Type: Int64
Parameter Sets: Multi
Aliases:

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

-Username

Filter by Assets belonging to a particular user

Type: String
Parameter Sets: Multi
Aliases:

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

-AssetGroupID

Filter by Assets belonging to a particular Asset group

Type: Int64
Parameter Sets: Multi
Aliases: assetgroup_id

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

-AssetTypeID

Filter by Assets belonging to a particular Asset type

Type: Int64
Parameter Sets: Multi
Aliases: assettype_id

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

-LinkedToID

Filter by Assets linked to a particular Asset

Type: Int64
Parameter Sets: Multi
Aliases: linkedto_id

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

-includeinactive

Include inactive Assets in the response

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-includeactive

Include active Assets in the response

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-includechildren

Include child Assets in the response

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-ContractID

Filter by Assets linked to a particular Asset

Type: Int64
Parameter Sets: Multi
Aliases: contract_id

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

-FullObjects

Parameter to return the complete objects.

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-IncludeDetails

Include extra objects in the result.

Type: SwitchParameter
Parameter Sets: Single
Aliases:

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

-IncludeDiagramDetails

Include the last action in the result.

Type: SwitchParameter
Parameter Sets: Single
Aliases:

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

-AdvancedSearch

Advanced search query

Type: String
Parameter Sets: Multi
Aliases: advanced_search

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

-AssetGroups

Asset groups to filter by

Type: Int32[]
Parameter Sets: Multi
Aliases:

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

-AssetStatuses

Asset statuses to filter by

Type: String[]
Parameter Sets: Multi
Aliases:

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

-AssetTypes

Asset types to filter by

Type: Int32[]
Parameter Sets: Multi
Aliases:

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

-Bookmarked

Filter by bookmarked assets

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-ColumnsID

Use the provided column profile

Type: Int32
Parameter Sets: Multi
Aliases: columns_id

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

-Consignable

Filter by consignable assets

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-IncludeBillingPeriod

Include the billing period of the linked contract id

Type: SwitchParameter
Parameter Sets: Multi
Aliases: contract_id_adding_to

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

-Count

Return this number of assets.

Type: Int32
Parameter Sets: Multi
Aliases:

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

-DomotzAgents

Filter by assets with a linked Domotz agent

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-ExcludeThese

Exclude assets by id

Type: Int32[]
Parameter Sets: Multi
Aliases:

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

-IDOnly

Return only the asset id

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-includeallowedstatus

Include the asset column tallowallstatus in the response

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-includeassetfields

Include the asset fields in the response

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-includecolumns

Include column details in the response

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-includeservices

Include assets linked service ids in the response

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-includeuser

Include the user details in the response

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-IntegrationTenantIDs

Filter by integration tenant ids

Type: Int32[]
Parameter Sets: Multi
Aliases: integration_tenantids

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

-InventoryNumber

Filter by inventory number

Type: String
Parameter Sets: Multi
Aliases: inventory_number

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

-ItemId

Filter by linked item id

Type: Int32
Parameter Sets: Multi
Aliases: item_id

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

-ItemStockId

Filter by linked item stock id

Type: Int32
Parameter Sets: Multi
Aliases: itemstock_id

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

-KBId

Filter by linked kb article id

Type: Int32
Parameter Sets: Multi
Aliases: kb_id

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

-lastupdatefromdate

Include the last update from date in the response

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-lastupdatetodate

Include the last update to date in the response

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-LicenseID

Filter by assets assigned to a particular license

Type: Int32
Parameter Sets: Multi
Aliases: license_id

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

-Mine

Filter to assets owned by the current user

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-MySite

Filter to assets in the current user's site

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-NoIcon

Exclude the asset icon from the response

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-Order

First field to order the results by.

Type: String
Parameter Sets: Multi
Aliases:

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

-OrderDesc

Order results for the first field in descending order (respects the field choice in '-OrderBy')

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-Order2

Second field to order the results by.

Type: String
Parameter Sets: Multi
Aliases:

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

-OrderDesc2

Order results for the second field in descending order (respects the field choice in '-OrderBy2')

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-Order3

Third field to order the results by.

Type: String
Parameter Sets: Multi
Aliases:

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

-OrderDesc3

Order results for the third field in descending order (respects the field choice in '-OrderBy3')

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-Order4

Fourth field to order the results by.

Type: String
Parameter Sets: Multi
Aliases:

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

-OrderDesc4

Order results for the fourth field in descending order (respects the field choice in '-OrderBy4')

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-Order5

Fifth field to order the results by.

Type: String
Parameter Sets: Multi
Aliases:

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

-OrderDesc5

Order results for the fifth field in descending order (respects the field choice in '-OrderBy5')

Type: SwitchParameter
Parameter Sets: Multi
Aliases:

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

-ServiceId

Filter by assets belonging to a particular service

Type: Int32
Parameter Sets: Multi
Aliases: service_id

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

-ServiceIds

Filter by assets belonging to any of the specified services

Type: Int32[]
Parameter Sets: Multi
Aliases: service_ids

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

-StockBinId

Filter by stockbin id

Type: Int32
Parameter Sets: Multi
Aliases: stockbin_id

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

-StockBinIds

Filter by stockbin ids

Type: Int32[]
Parameter Sets: Multi
Aliases: stockbin_ids

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

-SupplierContractId

Filter by supplier contract id

Type: Int32
Parameter Sets: Multi
Aliases: supplier_contract_id

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

-SupplierId

Filter by supplier id

Type: Int32
Parameter Sets: Multi
Aliases: supplier_id

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

-SupplierContracts

Filter by supplier contract ids

Type: Int32[]
Parameter Sets: Multi
Aliases:

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

-TicketTypeId

Filter by assets with linked tickets of the given type

Type: Int32
Parameter Sets: Multi
Aliases: tickettype_id

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

-UserId

Filter by assets belonging to the given user id

Type: Int32
Parameter Sets: Multi
Aliases: user_id

Required: False
Position: Named
Default value: 0
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