SystemLink Test API

[ian.yeager]

Is there a latest and greatest set of documentation for the SystemLink Test module? 

https://forums.ni.com/t5/SystemLink/Test-Monitoring-with-the-HTTP-API-Where-are-the-API-Files/td-p/3...

This forum post has a document in it, but it seems like some of the methods are deprecated perhaps, or non-working. I know the LabVIEW API is incoming, but I'd like to get started prior to that if possible. It would great if there were some working examples somewhere of the API in use.

[GreyGrey · Accepted solution]

As of SystemLink 18.2, we’ve added Swagger documentation for the HTTP APIs of the various SystemLink services to the SystemLink Server. To interact with this documentation, navigate to http://<YOUR_SERVER_ADDR>/niapis/. 

In that documentation you you should be able to select the Test Monitor Service and see the current version of the API. Let me know if you have any trouble finding that. 

[ian.yeager]

Grey,

Thanks, that's what I needed. Can you give me a quick synopsis of the designed routing here? How does NI intend for these API's to function, just some simple pseudo code would be good. It would be beneficial if we could get started using the RESTful calls then just replace them with the LabVIEW API calls as they become available.

[JoshuaP]

Here is a link to a preliminary LabVIEW API and some examples. 

https://github.com/joshuaprewitt/lv-test-monitor-http-api

[ian.yeager]

Awesome, thanks. So it looks like the intent is that you would initialize a result per UUT, since a single serial is associated with a result? So in a multi-up system you would create a result that would be managed through the life of the UUT?

[JoshuaP]

I’m not familiar with the term multi-up, but yes you should have just one UUT per result, but a UUT could have multiple results if you are testing different things on different systems or have to retest for any specific reason. The steps within a result are intended to capture the values of specific tests and potential measurement values along the way to allow you later analyze problematic areas, limits and variance over time. 

[ian.yeager]

Multi-up == Multi-UUT. e.g. a four-up test fixture that programs and tests four printed circuit boards at once.  

So, many tests within a result. In the scheme of SystemLink, a "Result" is a sequence of "Tests" performed upon a UUT.