Skip to content

Commit f545b01

Browse files
homotechsualhomotechsual
committed
Expand parameters for Get-HaloAsset.
1 parent 97a8ec8 commit f545b01

File tree

1 file changed

+169
-17
lines changed

1 file changed

+169
-17
lines changed

‎Public/Get/Get-HaloAsset.ps1‎

Lines changed: 169 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,6 @@ function Get-HaloAsset {
2727
[Parameter( ParameterSetName = 'Multi' )]
2828
[Alias('page_no')]
2929
[int32]$PageNo,
30-
# Which field to order results based on.
31-
[Parameter( ParameterSetName = 'Multi' )]
32-
[string]$Order,
33-
# Order results in descending order (respects the field choice in '-Order')
34-
[Parameter( ParameterSetName = 'Multi' )]
35-
[switch]$OrderDesc,
3630
# Filter by Assets with an asset field like your search
3731
[Parameter( ParameterSetName = 'Multi' )]
3832
[string]$Search,
@@ -46,7 +40,7 @@ function Get-HaloAsset {
4640
[int64]$ClientID,
4741
# Filter by Assets belonging to a particular site
4842
[Parameter( ParameterSetName = 'Multi' )]
49-
[Alias('site_id')]
43+
[Alias('')]
5044
[int64]$SiteID,
5145
# Filter by Assets belonging to a particular user
5246
[Parameter( ParameterSetName = 'Multi' )]
@@ -84,8 +78,166 @@ function Get-HaloAsset {
8478
[Switch]$IncludeDetails,
8579
# Include the last action in the result.
8680
[Parameter( ParameterSetName = 'Single' )]
87-
[Switch]$IncludeDiagramDetails
88-
)
81+
[Switch]$IncludeDiagramDetails,
82+
# Advanced search query
83+
[Parameter( ParameterSetName = 'Multi' )]
84+
[Alias('advanced_search')]
85+
[string]$AdvancedSearch,
86+
# Asset groups to filter by
87+
[Parameter( ParameterSetName = 'Multi' )]
88+
[int[]]$AssetGroups,
89+
# Asset statuses to filter by
90+
[Parameter( ParameterSetName = 'Multi' )]
91+
[string[]]$AssetStatuses,
92+
# Asset types to filter by
93+
[Parameter( ParameterSetName = 'Multi' )]
94+
[int[]]$AssetTypes,
95+
# Filter by bookmarked assets
96+
[Parameter( ParameterSetName = 'Multi' )]
97+
[switch]$Bookmarked,
98+
# Use the provided column profile
99+
[Parameter( ParameterSetName = 'Multi' )]
100+
[Alias('columns_id')]
101+
[int]$ColumnsID,
102+
# Filter by consignable assets
103+
[Parameter( ParameterSetName = 'Multi' )]
104+
[switch]$Consignable,
105+
# Include the billing period of the linked contract id
106+
[Parameter( ParameterSetName = 'Multi' )]
107+
[Alias('contract_id_adding_to')]
108+
[switch]$IncludeBillingPeriod,
109+
# Return this number of assets.
110+
[Parameter( ParameterSetName = 'Multi' )]
111+
[int]$Count,
112+
# Filter by assets with a linked Domotz agent
113+
[Parameter( ParameterSetName = 'Multi' )]
114+
[switch]$DomotzAgents,
115+
# Exclude assets by id
116+
[Parameter( ParameterSetName = 'Multi' )]
117+
[int[]]$ExcludeThese,
118+
# Return only the asset id
119+
[Parameter( ParameterSetName = 'Multi' )]
120+
[switch]$IDOnly,
121+
# Include the asset column `tallowallstatus` in the response
122+
[Parameter( ParameterSetName = 'Multi' )]
123+
[switch]$includeallowedstatus,
124+
# Include the asset fields in the response
125+
[Parameter( ParameterSetName = 'Multi' )]
126+
[switch]$includeassetfields,
127+
# Include column details in the response
128+
[Parameter( ParameterSetName = 'Multi' )]
129+
[switch]$includecolumns,
130+
# Include assets linked service ids in the response
131+
[Parameter( ParameterSetName = 'Multi' )]
132+
[switch]$includeservices,
133+
# Include the user details in the response
134+
[Parameter( ParameterSetName = 'Multi' )]
135+
[switch]$includeuser,
136+
# Filter by integration tenant ids
137+
[Parameter( ParameterSetName = 'Multi' )]
138+
[Alias('integration_tenantids')]
139+
[int[]]$IntegrationTenantIDs,
140+
# Filter by inventory number
141+
[Parameter( ParameterSetName = 'Multi' )]
142+
[Alias('inventory_number')]
143+
[string]$InventoryNumber,
144+
# Filter by linked item id
145+
[Parameter( ParameterSetName = 'Multi' )]
146+
[Alias('item_id')]
147+
[int]$ItemId,
148+
# Filter by linked item stock id
149+
[Parameter( ParameterSetName = 'Multi' )]
150+
[Alias('itemstock_id')]
151+
[int]$ItemStockId,
152+
# Filter by linked kb article id
153+
[Parameter( ParameterSetName = 'Multi' )]
154+
[Alias('kb_id')]
155+
[int]$KBId,
156+
# Include the last update from date in the response
157+
[Parameter( ParameterSetName = 'Multi' )]
158+
[switch]$lastupdatefromdate,
159+
# Include the last update to date in the response
160+
[Parameter( ParameterSetName = 'Multi' )]
161+
[switch]$lastupdatetodate,
162+
# Filter by assets assigned to a particular license
163+
[Parameter( ParameterSetName = 'Multi' )]
164+
[Alias('license_id')]
165+
[int]$LicenseID,
166+
# Filter to assets owned by the current user
167+
[Parameter( ParameterSetName = 'Multi' )]
168+
[switch]$Mine,
169+
# Filter to assets in the current user's site
170+
[Parameter( ParameterSetName = 'Multi' )]
171+
[switch]$MySite,
172+
# Exclude the asset icon from the response
173+
[Parameter( ParameterSetName = 'Multi' )]
174+
[switch]$NoIcon,
175+
# First field to order the results by.
176+
[Parameter( ParameterSetName = 'Multi' )]
177+
[string]$Order,
178+
# Order results for the first field in descending order (respects the field choice in '-OrderBy')
179+
[Parameter( ParameterSetName = 'Multi' )]
180+
[switch]$OrderDesc,
181+
# Second field to order the results by.
182+
[Parameter( ParameterSetName = 'Multi' )]
183+
[string]$Order2,
184+
# Order results for the second field in descending order (respects the field choice in '-OrderBy2')
185+
[Parameter( ParameterSetName = 'Multi' )]
186+
[switch]$OrderDesc2,
187+
# Third field to order the results by.
188+
[Parameter( ParameterSetName = 'Multi' )]
189+
[string]$Order3,
190+
# Order results for the third field in descending order (respects the field choice in '-OrderBy3')
191+
[Parameter( ParameterSetName = 'Multi' )]
192+
[switch]$OrderDesc3,
193+
# Fourth field to order the results by.
194+
[Parameter( ParameterSetName = 'Multi' )]
195+
[string]$Order4,
196+
# Order results for the fourth field in descending order (respects the field choice in '-OrderBy4')
197+
[Parameter( ParameterSetName = 'Multi' )]
198+
[switch]$OrderDesc4,
199+
# Fifth field to order the results by.
200+
[Parameter( ParameterSetName = 'Multi' )]
201+
[string]$Order5,
202+
# Order results for the fifth field in descending order (respects the field choice in '-OrderBy5')
203+
[Parameter( ParameterSetName = 'Multi' )]
204+
[switch]$OrderDesc5,
205+
# Filter by assets belonging to a particular service
206+
[Parameter( ParameterSetName = 'Multi' )]
207+
[Alias('service_id')]
208+
[int]$ServiceId,
209+
# Filter by assets belonging to any of the specified services
210+
[Parameter( ParameterSetName = 'Multi' )]
211+
[Alias('service_ids')]
212+
[int[]]$ServiceIds,
213+
# Filter by stockbin id
214+
[Parameter( ParameterSetName = 'Multi' )]
215+
[Alias('stockbin_id')]
216+
[int]$StockBinId,
217+
# Filter by stockbin ids
218+
[Parameter( ParameterSetName = 'Multi' )]
219+
[Alias('stockbin_ids')]
220+
[int[]]$StockBinIds,
221+
# Filter by supplier contract id
222+
[Parameter( ParameterSetName = 'Multi' )]
223+
[Alias('supplier_contract_id')]
224+
[int]$SupplierContractId,
225+
# Filter by supplier id
226+
[Parameter( ParameterSetName = 'Multi' )]
227+
[Alias('supplier_id')]
228+
[int]$SupplierId,
229+
# Filter by supplier contract ids
230+
[Parameter( ParameterSetName = 'Multi' )]
231+
[int[]]$SupplierContracts,
232+
# Filter by assets with linked tickets of the given type
233+
[Parameter( ParameterSetName = 'Multi' )]
234+
[Alias('tickettype_id')]
235+
[int]$TicketTypeId,
236+
# Filter by assets belonging to the given user id
237+
[Parameter( ParameterSetName = 'Multi' )]
238+
[Alias('user_id')]
239+
[int]$UserId
240+
)
89241
Invoke-HaloPreFlightCheck
90242
$CommandName = $MyInvocation.InvocationName
91243
$Parameters = (Get-Command -Name $CommandName).Parameters
@@ -103,22 +255,22 @@ function Get-HaloAsset {
103255
$QSCollection = New-HaloQuery -CommandName $CommandName -Parameters $Parameters
104256
$Resource = "api/asset/$($AssetID)"
105257
$RequestParams = @{
106-
Method = 'GET'
107-
Resource = $Resource
258+
Method = 'GET'
259+
Resource = $Resource
108260
AutoPaginateOff = $True
109-
QSCollection = $QSCollection
110-
ResourceType = 'assets'
261+
QSCollection = $QSCollection
262+
ResourceType = 'assets'
111263
}
112264
} else {
113265
Write-Verbose 'Running in multi-asset mode.'
114266
$QSCollection = New-HaloQuery -CommandName $CommandName -Parameters $Parameters -IsMulti
115267
$Resource = 'api/asset'
116268
$RequestParams = @{
117-
Method = 'GET'
118-
Resource = $Resource
269+
Method = 'GET'
270+
Resource = $Resource
119271
AutoPaginateOff = $Paginate
120-
QSCollection = $QSCollection
121-
ResourceType = 'assets'
272+
QSCollection = $QSCollection
273+
ResourceType = 'assets'
122274
}
123275
}
124276
$AssetResults = New-HaloGETRequest @RequestParams

0 commit comments

Comments
 (0)