API

This page describes the API used between the core and the tester.

GET /test/info
Synopsis:

returns all the available tests

Response JSON Object:

  • tests (array) – Array of tests

POST /test/run
Synopsis:

it starts the test in the background

Response JSON Object:

  • type (string) – type of the test

  • params (dict) – parameters for the test

  • ID (string) – ID of the test

  • Secret (string) – Secret for retreive status and results

GET /test/status
Synopsis:

fetches the status of the execution

Response JSON Object:

  • ID (string) – ID of the test

  • Secret (string) – Secret for retreive status and results

  • Status (string) – Status of the test ( running | failed | finished )

GET /test/results
Synopsis:

fetches the result of the test. Only available when the test is finished

Response JSON Object:

  • ID (string) – ID of the test

  • Secret (string) – Secret for retreive status and results

  • result (array) – Array of results

  • result.Label (string) – Label of the result

  • result.Type (string) – Type of the result ( number | string | image | blob )

  • result.Content (string) – Content of the result (base64 encoded)