Get Files Information on SystemLink Using the HTTP API on Swagger UI

Updated Feb 22, 2024

Environment

Software

  • SystemLink Server
  • LabVIEW
  • JSONtext

Many operations on SystemLink Web Application can be controlled from external applications by using HTTP API. This article demonstrates how to get or set files metadata by use of HTTP API on Swagger UI. This article assumes that you have basic knowledge related to SystemLink and how to upload files on SystemLink.
 

On the Swagger UI page for SystemLink File Service,  go to the section for GET​/v1​/service-groups​/Default​/files command.
This HTTP API returns files information base on your query settings.
  1. You can test this HTTP API by clicking Try it Out.
  2. Set the skip (how many files to skip in the result when paging), take (how many files to return in the result) and other filter parameters as desired.
The below example sends query to take and return a list of 50 available files. 
filesSL.PNG
 
  1. Click Execute  
If the HTTP API is executed normally, Code 200 for Response body will be returned. Moreover, the total number of files currently available on your SystemLink server can also be verified at the last line of this Response body text as the totalCount value.
filesSL2.PNG


A similar request can be excecuted from LabVIEW using the below Isample program. (JSONtext  library is needed in this example to reorder the Response body text and retrieve the totalCount value. JSONtext can be downloaded from VI package manager )

GET Files info.png

filesSLResult.PNG