DataTrue
API docs by Redocly

DataTrue CI API (1.0.0)

Download OpenAPI specification:Download

DataTrue Support: [email protected] URL: https://support.datatrue.com/ Terms of Service

Introduction

DataTrue exposes a REST based API to allow tests and suites to be run from external systems such as a continuous integration (CI) environment.

Authentication

The CI API requires an API key to be provided in the Authorization header. Two different API keys can be provided to the CI API, one can be found within your User Profile, and the other within your account settings.

When using the API key from your account settings only tests and suites within that account can be run. When using the API key from your User Profile any tests or suites that you have access to can be run.

Test Runs

Trigger a test run

Trigger a test run for a Test or a Suite

Authorizations:
API Key
Request Body schema: application/json
required
object

Options for the test run

object

Variables to set for the test run

Responses

Request samples

Content type
application/json
{
  • "test_run": {
    },
  • "variables": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "job_id": "string"
}

Retrieve the progress for a test run

Retrieve the progress for a test run

Authorizations:
API Key
path Parameters
testRunId
required
number

ID of the test run you wish to retrieve the progress for

Responses

Response samples

Content type
application/json
{
  • "status": "queued",
  • "num": 0,
  • "total": 0,
  • "progress": {
    }
}

Retrieve the progress for a test run Deprecated

Retrieve the progress for a test run using the job ID

Authorizations:
API Key
path Parameters
jobId
required
number

ID of the job you wish to retrieve the progress for

Responses

Response samples

Content type
application/json
{
  • "status": "queued",
  • "num": 0,
  • "total": 0,
  • "progress": {
    }
}