Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
Next revision Both sides next revision
tutorial:rest_api [2020/06/08 03:03]
admin 		tutorial:rest_api [2021/01/02 01:44]
admin
Line 2: Line 2:
  
 Learning Objectives: Learning Objectives:
-  * TestOptimal Support of REST APIs+  * TestOptimal REST APIs
   * Organization of REST APIs   * Organization of REST APIs
   * Security and Authorization   * Security and Authorization
   * Swagger UI   * Swagger UI
-  * Integrate using REST APIs + 
-  * + 
 +===== TestOptimal REST APIs ===== 
 +//TestOptimal// provides a suite of REST APIs to allow 3rd party tools and applications to communicate with //TestOptimal// server.   
 + 
 +You can use these REST APIs to access start and stop model execution, access model artifacts/files as well as perform system functions remotely. 
 + 
 +===== Organization of REST APIs ===== 
 +REST APIs are grouped and organized in these categories (to match Swagger-UI): 
 +  * ALM - ALM source definition and model requirements 
 +  * Agent - TestOptimal Agent APIs: register remote agent and receive agent commands 
 +  * Client - TestOptimal Agent APIs: remote execute model and data set execution 
 +  * Dashboard - Dashboard data: KPI and model execution statistics 
 +  * Demo - REST API used by demo models 
 +  * File - access to model and system files 
 +  * Graph - generate / download graphs for model executions: model graph, coverage graph, traversal graph and test case graph (MSC) 
 +  * Model - access to model artifacts/files 
 +  * Report - Dashboard reports 
 +  * Runtime - start/stop model execution 
 +  * Security - user login 
 +  * Stats - model execution statistics 
 +  * SvrMgr - Server manager functions 
 +  * System - perform system functions 
 +  * web-redirect-controller - internal use 
 + 
 +===== Security and Authorization ===== 
 +Most of the REST APIs are access controlled. 
 + 
 +Basic Auth is used to authenticate users.  It is highly recommended that you [[ ../configuration#enable_https| enable SSL]] if you access //TestOptimal// server from the internet to prevent your user id/password from being intercepted. 
 + 
 + 
 +===== Swagger UI ===== 
 + 
 +Swagger UI is provided for your convenience.  You can access Swagger UI with the following URL: 
 +   http://localhost:8888/swagger 
 +    
 +If you are prompted to Login screen, go ahead and login and re-launch the above URL in the same browser session again. 
 + 
 + 
 +