How to Start or End Systemlink Client Asset Utilization Using HTTP API

Updated Sep 28, 2024

Environment

Software

  • SystemLink Client
  • SystemLink Asset Module

I have multiple clients connected to SystemLink Server. How do I enable asset utilization records to appear in SystemLink Asset Management reports?

You can use the SystemLink Asset Module to track the utilization of all your test assets that are connected to your SystemLink client systems, such as test equipment and instrumentation.
This document explains how to start/end asset utilization using HTTP APIs. The usage of this HTTP API requests will help in recording and displaying all connected systems' assets utilization on the System Management Report.

  1. On SytemlLnk web application, go to Sytems Management>> System to display the list of all systems.
connected.png
  1. Click on the system you want to operate on. This will display the system identifiers (minion ID, model name, vendor name, serial number) and all assets present on it. These system/asset properties will be used to configure the HTTP API request.
assetidentification.png
  1. Click on the ? and select HTTP API. This will open Swagger where you can access and operate on HTTP APIs.
connectedswagger.png
  1. Make sure the definition is Asset Performance Management.
asset.png
Start asset utilization
  1. Scroll down to utilization category. To start asset utilization, click on POST/v1/assets/start-utilization
assetPOST start.png
  1. Click Try it Out.
assetSTARTtryitout.png
  1. Configure the buffer
  • utilizationIdentifier should be a unique number
  • utilizationTimestamp specifies the time you want to start using the asset
  • minion ID, model name, vendor name and serial number can be found on  the system/asset tab (please refer to the above step 2)
  • Set the utilizationcategory (reason the user is using the asset) and more specifications such as test name(name of the test or measurement task you want the asset to perform), tester name, etc. These properties can later be used to filter, and to generate custom system asset utilization reports.
assetSTARTbuffer.png
 
  1. Click Execute. If the request was successfully processed, there should be no errors and the response body should look like below
assetSTARTsuccess.png

If the request wasn't successfully processed, the response message will include the error content as the one below. In this example, the reason given for the error is that, the specified utilizationIdentifier already exists on the same minion id. Setting a different utilizationIdentifier will resolve the issue.
assetSTARTerror.png


End asset utilization
  1. Use utilization' POST/v1/assets/end-utilization to end asset utilization.
assetPOST ends.png
  1. Click Try it Out.
  2. Configure the buffer
  • utilizationIdentifier is the same used to start asset utilization.
  • utilizationTimestamp specifies the time asset utilization ends.
8.PNG
  1. Click Execute

Send HTTP requests to start or end asset utilization from LabVIEW

You can sent use HTTP Clients VI to send the above requests from LabVIEW (sample program available in the attachment files at the bottom of this document).
  • Start asset utilization
assetstartLV.png
  • End asset utilization
assetendLV.png
 

The system will take few minutes to update the information on the client asset utilization report, but you can directly check system' asset utilization from System Management>>Report tab.

You can use Filter to narrow down your search.
assetreport.png
assetreport2.png
 

Attachments

AssetUtilizationTest_mod2.zip

Related Links

Other Support Options

Ask the NI Community

Collaborate with other users in our discussion forums



Request Support from an Engineer

A valid service agreement or active software subscription may be required, and support options vary by country.