Programmatically Read SystemLink ANP Results List

This article explains how to programmatically retrieve entries in the Results List of an Analysis Automation Procedure (ANP) execution in SystemLink.

When an ANP is executed, additional result data may be logged using the script. For example, an ANP written in DIAdem logs messages to inform the user when certain SubTasks have finished.

These additional results appear within the Details window of the ANP execution in the SystemLink UI.

This information can be programmatically retrieved using the /analysisservers/{as_uuid}/taskexecutions/{te_uuid}/results HTTP GET method. The steps required to use this are detailed below.

To programmatically read the ANP Results List, follow the steps below:

1. Navigate to the SystemLink UI in a browser, and select the Measurement Data Analysis >> Analysis Automation page.
2. In the top-right corner, click the question mark (?) icon and select HTTP API.
   • This opens the Swagger UI in a separate tab. The Swagger UI is a web-based manual for the SystemLink HTTP API.

3. In the Swagger UI, ensure that Analysis Automation is selected from the drop-down menu.

4. Scroll down the page until you identify the /analysisservers/{as_uuid}/taskexecutions API within the Task Executions section.

5. Click on the API to expand details and click Try it Out.
   • This API is required to obtain the ID of a specific ANP task execution in SystemLink.
6. Set the value of as_uuid to the last string in the URL when on the Analysis Automation Instance page of SystemLink.

7. Set the value of expand to taskname. This ensures that the name of the task is printed along with it's ID.

8. Click the blue Execute button underneath the parameters to run this HTTP request.
9. If the HTTP request was successful, the Responses section underneath will display code 200 and a list of ANP executions.
10. Scroll through the response body to identify the desired task's ID. The ID will be the final string in the link key, as highlighted below.

11. Scroll through the Task Executions API list until you identify /analysisservers/{as_uuid}/taskexecutions/{te_uuid}/results.

12. Select the API to expand details and click Try it Out.
    • This API returns the Results List for a specified execution ID.
13. Set the value of as_uuid to the same value used in step 6.
14. Set the value of te_uuid to the Task Execution ID identified in step 10.

15. Click the blue Execute button to run the HTTP request.
16. If the HTTP request was successful, the Responses section underneath will display code 200 and the execution's result list.

Once the results list is successfully obtained within the Swagger UI, the same API URL and parameters configuration can be applied in whatever programming environment you wish to use for interacting with SystemLink programmatically.