Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
tutorial:rest_api [2021/01/02 01:40] admin |
— (current) | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Tutorial: REST APIs ====== | ||
- | |||
- | Learning Objectives: | ||
- | * TestOptimal REST APIs | ||
- | * Organization of REST APIs | ||
- | * Security and Authorization | ||
- | * Swagger UI | ||
- | * Integrate using REST APIs | ||
- | |||
- | ===== TestOptimal REST APIs ===== | ||
- | // | ||
- | |||
- | You can use these REST APIs to access start and stop model execution, access model artifacts/ | ||
- | |||
- | ===== 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/ | ||
- | * 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. | ||
- | |||
- | |||
- | |||