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 Both sides next revision
tutorial:rest_api [2020/12/31 18:08]
admin
tutorial:rest_api [2021/01/02 01:33]
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   * 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:
 +  * 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