Simscope REST API

The Simscope REST API can be used to access most of Simscope's data model, from a variety of programming languages.

API Tokens

→ To access Simscope REST API, you need to use an API Token for authentication.

Example Uses

For example, the REST API can access:

• Regression results
• Signature results
• Job search
• Get single Job details
• Issue search
  • Bug update
• Metrics/Dashboard queries
• List components
• List models (commits)
• List rules
• List users

REST API documentation

The Simscope REST API is documented by clicking the REST API link at the bottom of any live Simscope server web page.

For example, go to the URL:

http://simscope-hostname:8080/help-rest-api

Languages Supported

Simscope's REST API can be accessed from any language that has HTTP REST API support.

• curl (command-line)

• Python

• Note: any other language can be used via custom REST API.

REST API overview

Simscope's REST API is grouped under the URL:

http://server:8080/api/

→

{
    "+Sessions": "/api/sessions/",
    "Admin": "/api/admin/",
    "Assignments": "/api/assignments/",
    "Components": "/api/c/",
    "Config": "/api/config/",
    "Dashboards": "/api/metrics/d/",
    "DesignMetrics": "/api/metrics/",
    "Issues": "/api/issues/",
    "Models": "/api/models/",
    "RegressionSearch": "/api/rsearch/",
    "Regressions": "/api/r/",
    "Rules": "/api/rules/",
    "SignatureClasses": "/api/sigclasses/",
    "SignatureSearch": "/api/sigsearch/",
    "Signatures": "/api/sigs/",
    "Subscriptions": "/api/subs/",
    "Tagged": "/api/tagged/",
    "Tests": "/api/tests/",
    "Timeline": "/api/timeline/",
    "Triage": "/api/triage/",
    "Users": "/api/u/",
    "Views": "/api/views/"
}

Note: for security, some Simscope API's require Administrator (user) API tokens, and will be blocked for normal Simscope users.