Skip to main content
Server path: /haloitsm-assets | Type: Application | PCID required: Yes

​
Tools

ToolDescription
haloitsm_assets_create_assetPOST /Asset
haloitsm_assets_create_asset_typePOST /AssetType
haloitsm_assets_delete_asset_by_idDELETE /Asset/{id}
haloitsm_assets_delete_asset_type_by_idDELETE /AssetType/{id}
haloitsm_assets_get_asset_by_idGet one Device
haloitsm_assets_get_asset_type_by_idGet one Xtype
haloitsm_assets_list_assetList of Device
haloitsm_assets_list_asset_get_all_software_versionsGET /Asset/GetAllSoftwareVersions
haloitsm_assets_list_asset_next_tagGET /Asset/NextTag
haloitsm_assets_list_asset_typeList of Xtype

​
haloitsm_assets_create_asset

POST /Asset Parameters:
ParameterTypeRequiredDefaultDescription
bodyobject[]No—Request body

​
haloitsm_assets_create_asset_type

POST /AssetType Parameters:
ParameterTypeRequiredDefaultDescription
bodyobject[]No—Request body

​
haloitsm_assets_delete_asset_by_id

DELETE /Asset/{id} Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYes—The id value

​
haloitsm_assets_delete_asset_type_by_id

DELETE /AssetType/{id} Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYes—The id value

​
haloitsm_assets_get_asset_by_id

Get one Device Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYes—The id value
assettype_idintegerNo—Assettype Id
includeactivitybooleanNo—(bool) Include activity details in the response.
includeallowedstatusbooleanNo—(bool) Include allowed statuses details in the response.
includedetailsbooleanNo—(bool) Include extra objects in the response.
includediagramdetailsbooleanNo—(bool) Include diagram details in the response.
includehierarchybooleanNo—(bool) Include hierarchy details in the response.

​
haloitsm_assets_get_asset_type_by_id

Get one Xtype Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYes—The id value
booking_typeintegerNo—Booking Type
client_idintegerNo—Client Id
end_datestringNo—End date for filtering
fieldsandlayoutonlybooleanNo—The fieldsandlayoutonly value
includedetailsbooleanNo—The includedetails value
site_idintegerNo—Site Id
start_datestringNo—Start date for filtering

​
haloitsm_assets_list_asset

List of Device Parameters:
ParameterTypeRequiredDefaultDescription
activeinactivestringNo—(string) Filter on active/inactive assets - comma seperated, first value being true or false for active, second for inactive.
advanced_searchstringNo—Advanced Search
assetgroup_idintegerNo—(int) Filter by Assets belonging to a particular Asset group.
assetgroupsstringNo—(string) Filter Assets on asset groups, comma seperated ids.
assetsstringNo—The assets value
assetstatusesstringNo—(string) Filter Assets on asset statuses, comma seperated ids.
assettypeintegerNo—The assettype value
assettype_idintegerNo—(int) Filter by Assets belonging to a particular Asset type.
assettypesstringNo—(string) Filter Assets on asset types, comma seperated ids.
bookmarkedbooleanNo—(bool) Include only Assets that are bookmarked in the response.
client_idintegerNo—(int) Filter by Assets belonging to a particular client.
client_idsstringNo—(array of int) Returns Assets based on client ID’s in the array.
columns_idintegerNo—(int) The column profile ID.
consignablebooleanNo—(bool) Include only the Assets that are consignable in the response.
consignment_idintegerNo—(int) Filter by Assets consignment id.
contract_idintegerNo—(int) Filter by Assets assigned to a particular contract.
contract_id_adding_tointegerNo—(int) Include the billing period of the linked contract id in the response.
countintegerNo—(int) Number of Assets to return in the response.
domotzagentsbooleanNo—(bool) Include only Assets with a linked Domotz agent in the response.
excludethesestringNo—(string) Returns Assets based on the exclusion of these Asset ID’s, comma seperated.
globalSearchIDstringNo—Global Search ID
idonlybooleanNo—(bool) Include only the Asset ID in the response.
includeactivebooleanNo—(bool) Include active Assets in the response.
includeallowedstatusbooleanNo—(bool) Include the Asset column ‘tallowallstatus’ in the response.
includeassetfieldsbooleanNo—(bool) Include asset fields in the response - must also specify the URL parameter ‘assettype_id’ at the same time.
includechildrenbooleanNo—(bool) Include child Assets in the response.
includecolumnsbooleanNo—(bool) Include column details in the response.
includeinactivebooleanNo—(bool) Include inactive Assets in the response.
includeservicesbooleanNo—(bool) Include Assets linked service ids in the response.
includeuserbooleanNo—(bool) Include user details in the response.
integration_tenantidsinteger[]No—Integration Tenantids
integration_typestringNo—(string) Filter on which integration the Asset was imported through - ‘aterarmm’, ‘ninjarmm’, ‘syncromsp’, ‘domotz’, ‘connectwiseautomate’, ‘snow’, ‘datto’, ‘passportal’, ‘addigy’, ‘liongard’.
inventory_numberstringNo—Inventory Number
islogonbehalfviewbooleanNo—The islogonbehalfview value
item_idintegerNo—(int) Filter by Assets item id.
itemstock_idintegerNo—(int) Filter by Assets item stock id.
kb_idintegerNo—Kb Id
lastupdatefromdatebooleanNo—(bool) Include the field lastupdatefromdate in the response.
lastupdatetodatebooleanNo—(bool) Include the field lastupdatetodate in the response.
licence_idintegerNo—(int) Filter by Assets assigned to a particular licence.
linked_to_ticketbooleanNo—Linked To Ticket
linkedto_idintegerNo—(int) Filter by Assets linked to a particular Asset.
minebooleanNo—(bool) Include only the Assets that belong to yourself in the response.
mysitebooleanNo—(bool) Include only the Assets that belong to your site in the response.
noiconbooleanNo—(bool) Exclude the Asset icon in the response.
orderstringNo—(string) The name of the field to order by first.
order2stringNo—(string) The name of the field to order by second.
order3stringNo—(string) The name of the field to order by third.
order4stringNo—(string) The name of the field to order by fourth.
order5stringNo—(string) The name of the field to order by fifth.
orderdescbooleanNo—(bool) Whether to order ascending or descending on first order.
orderdesc2booleanNo—(bool) Whether to order ascending or descending on second order.
orderdesc3booleanNo—(bool) Whether to order ascending or descending on third order.
orderdesc4booleanNo—(bool) Whether to order ascending or descending on fourth order.
orderdesc5booleanNo—(bool) Whether to order ascending or descending on fifth order.
page_nointegerNo—(int) When using Pagination, the page number to return.
page_sizeintegerNo—(int) When using Pagination, the size of the page.
pageinatebooleanNo—(bool) Whether to use Pagination in the response.
previously_selectedbooleanNo—(bool) Include the most recent dateoccured field from a linked ticket in the response.
previously_selected_client_idintegerNo—(int) Filter previously_selected by client id.
previously_selected_site_idintegerNo—(int) Filter previously_selected by site id.
previously_selected_user_idintegerNo—(int) Filter previously_selected by user id.
salesorder_idintegerNo—(int) Filter by Assets sales order id.
salesorder_lineintegerNo—(int) Filter by Assets sales order line id.
searchstringNo—(string) Filters response based on the search string.
search_inventory_number_onlybooleanNo—(bool) Whether to search only on inventory number in the search string.
service_idintegerNo—(int) Filter by Assets belonging to a particular service.
service_idsstringNo—(string) Filter Assets on service ids, comma seperated ids.
site_idintegerNo—(int) Filter by Assets belonging to a particular site.
stockbin_idintegerNo—Stockbin Id
stockbin_idsinteger[]No—Stockbin Ids
supplier_contract_idintegerNo—(int) Filter by Assets assigned to a particular supplier contract.
supplier_idintegerNo—(int) Filter by Assets belonging to a particular supplier.
suppliercontractsstringNo—(string) Filter Assets on supplier contracts, comma seperated ids.
ticket_idintegerNo—(int) Filter by Assets belonging to a particular ticket.
tickettype_idintegerNo—Tickettype Id
user_idintegerNo—User Id
usernamestringNo—(string) Filters by the specified username.
include_custom_fieldsstringNo—(string) Comma separated list of Custom Field IDs to include in the response.

​
haloitsm_assets_list_asset_get_all_software_versions

GET /Asset/GetAllSoftwareVersions

​
haloitsm_assets_list_asset_next_tag

GET /Asset/NextTag

​
haloitsm_assets_list_asset_type

List of Xtype Parameters:
ParameterTypeRequiredDefaultDescription
assetgroup_idintegerNo—Assetgroup Id
can_create_onlybooleanNo—Can Create Only
can_edit_onlybooleanNo—Can Edit Only
fixedassetgroupsbooleanNo—The fixedassetgroups value
include_currentintegerNo—Include Current
resourcesonlybooleanNo—The resourcesonly value
setuplistbooleanNo—The setuplist value
tickettype_idintegerNo—Tickettype Id
typestringNo—The type value