Eggplant Public API

Version 2.0

Path Table

Method	Path	Description
POST	/auth	Obtain an access token from a client ID and secret
GET	/test_results	List test results
GET	/test_results/{test_result_id}	Get the result of a single test
GET	/test_results/{test_result_id}/logs	Get the logs for a single test
GET	/test_results/{test_result_id}/screenshots	List the available screenshots for a test
GET	/screenshots/{screenshot_id}	Download a screenshot for a test result
GET	/test_config_results	List test config results
GET	/test_config_results/{test_config_result_id}	Get a test config result
GET	/test_config_results/{test_config_result_id}/junit	Get the results of a test config run in junit format
POST	/suts	Create a new SUT
GET	/suts	List suts
PUT	/suts/{sut_id}	Update existing SUT
DELETE	/suts/{sut_id}	Delete existing SUT
GET	/suts/{sut_id}	Get details of a SUT based on the SUT id
GET	/spaces/{space_id}/export	Export a space
POST	/spaces/import	Import a space

Reference Table

Name	Type	Description
AndroidConnectionRequest	Schema	Android connection for POST/PUT requests - no uuid
AndroidConnectionResponse	Schema	Android connection for GET responses - includes uuid
AuthRequestBody	Schema
AuthResponseBody	Schema
BaseSutRequest	Schema	Base class for SUT request bodies to avoid duplication
Body_import_space_spaces_import_post	Schema
BrowserType	Schema
CitrixConnectionRequest	Schema	Citrix connection for POST/PUT requests - no uuid
CitrixConnectionResponse	Schema	Citrix connection for GET responses - includes uuid
ColorDepth	Schema	Color depth for VNC/RDP connections. Higher values provide better quality but may reduce performance.
Criteria	Schema
CriteriaWithoutSpace	Schema
HTTPValidationError	Schema
IOSConnectionRequest	Schema	iOS connection for POST/PUT requests - no uuid
IOSConnectionResponse	Schema	iOS connection for GET responses - includes uuid
Problem	Schema
RdpConnectionRequest	Schema	RDP connection for POST/PUT requests - no uuid
RdpConnectionResponse	Schema	RDP connection for GET responses - includes uuid
RunType	Schema	The possible run types for a particular test result.
SauceLabsBrowserConnectionRequest	Schema	SauceLabs Browser connection for POST/PUT requests - no uuid
SauceLabsBrowserConnectionResponse	Schema	SauceLabs Browser connection for GET responses - includes uuid
SauceLabsDeviceConnectionRequest	Schema	SauceLabs Device connection for POST/PUT requests - no uuid
SauceLabsDeviceConnectionResponse	Schema	SauceLabs Device connection for GET responses - includes uuid
ScaleRatio	Schema	Scale ratio for VNC connection. 1 = normal size, 2 = scaled by 50%
Screenshot	Schema	Info of an available screenshot for a particular test result.
ScreenshotsPaginatedList	Schema	A paginated list of a single test result's screenshots available.
Severity	Schema	The severity levels of a single test result log entry.
SingleSystemConnectionRequest	Schema	SingleSystem connection for POST/PUT requests - no uuid
SingleSystemConnectionResponse	Schema	SingleSystem connection for GET responses - includes uuid
SortBy	Schema	The possible sorting options available for sorting a list of test results.
SortDirection	Schema	The possible direction applied during sorting.
Stage	Schema
Status	Schema	The possible statuses for a particular test result.
Sut	Schema	The information that is needed to create a new SUT
SutsPaginatedList	Schema	A paginated list of the Suts.
TestConfigResult	Schema	TestConfigResult with basic details
TestConfigResultDetails	Schema	Extends TestConfigResult with additional details
TestConfigResultDirectedTestCaseStep	Schema	Test config with model test case step
TestConfigResultScriptedTestCaseStep	Schema	Test config with scripted test case step
TestConfigResultSortBy	Schema
TestConfigResultStep	Schema	Test config with step information
TestConfigResultStepParameter	Schema	Test config with step parameter override
TestConfigResultSutUsed	Schema	Test config with SUT information
TestConfigResultTag	Schema	Test config with tag information
TestConfigResultsPaginatedList	Schema
TestConfigSource	Schema
TestConfigStatus	Schema	The possible statuses for a particular test config result.
TestResult	Schema	The test result containing all the information for a single exploratory, replay or test case execution.
TestResultLogEntriesPaginatedList	Schema	A paginated list of a single test result's log entries.
TestResultLogEntry	Schema	A single log entry from a particular test result.
TestResultTag	Schema
TestResultsPaginatedList	Schema	A paginated list of the test results.
ValidationError	Schema
VncConnectionRequest	Schema	VNC connection for POST/PUT requests - no uuid
VncConnectionResponse	Schema	VNC connection for GET responses - includes uuid
WebDriverConnectionRequest	Schema	WebDriver connection for POST/PUT requests - no uuid
WebDriverConnectionResponse	Schema	WebDriver connection for GET responses - includes uuid

Path Details

[POST] /auth

Summary:
Obtain an access token from a client ID and secret

RequestBody

application/json

{
  client_id: string
  client_secret: string
}

Responses

200 OK

application/json

{
  access_token: string
  expires_in: integer
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

422 Validation Error

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
    ctx: {
    }
  }[]
}

[GET] /test_results

Summary:
List test results

Description:
Gets a paginated list of test results matching the filters applied.

Parameters (Query)

// 
// The number of test results at the beginning which matches the filters applied but will be excluded from the returned list.
// 
offset: integer

// The maximum number of test results that will be returned. Note that the limit's maximum value can be changed by setting the LIMIT_MAX_VALUE in your system environment variables. Allowable range for LIMIT_MAX_VALUE is 1000-2147483647 inclusive.
limit: integer //default: 1000

// The possible sorting options available for sorting a list of test results.
sort_by: enum[id, model_or_suite_name, start_time, test_case_name, test_config_name, execution_environment_name, sut_name]

// The possible direction applied during sorting.
sort_direction: enum[asc, desc]

// Filter the test results by a particular feature file.
feature_file: string //default: null

// Filter the Gherkin test results by a particular scenario name.
scenario: string //default: null

// The possible run types for a particular test result.
run_type: enum[SCRIPTED_TEST_CASE, MODEL_TEST_CASE, EXPLORATORY, REPLAY, GHERKIN]

// The possible statuses for a particular test result.
status: enum[RUNNING, PASSED, FAILED, ERROR, CANCELLED]

// Filter the test results to obtain those which started after the given time.
start_time: string //default: null

// Filter the test results to obtain those which ended before the given time.
end_time: string //default: null

// Filter the test results to obtain the test results which uses the model matching the given model_id. 
model_id: string //default: null

// Filter the test results to obtain the scripted test results which uses the suite matching the given suite_id.
suite_id: string //default: null

// Obtain all the test results for the given test_case_id.
test_case_id: string //default: null

// Obtain all the test results which uses this execution_environment_id for execution. 
execution_environment_id: integer //default: null

// Obtain all the test results which uses the sut matching this sut_id for execution.
sut_id: string //default: null

// Obtain all the test results which are part of a test config run matching the given task_instance_id.
test_config_result_id: string //default: null

// Obtain all the test results of the given test_config_id. 
test_config_id: string //default: null

// Filter the test results by a particular space ID.
space_id: string //default: 910ba100-0000-4000-a000-000000000000

Headers

// The access_token that is returned from the POST /auth endpoint.
authorization: string

Responses

200 OK

application/json

// A paginated list of the test results.
{
  // The total number of items that matches the request before any limit or offset are applied.
  total_count: integer
  // The date and time when this request was made.
  date_as_of: string
  // The test result containing all the information for a single exploratory, replay or test case execution.
  items: {
    // The test result id.
    id: integer
    // The possible statuses for a particular test result.
    status: enum[RUNNING, PASSED, FAILED, ERROR, CANCELLED]
    // The possible run types for a particular test result.
    run_type: enum[SCRIPTED_TEST_CASE, MODEL_TEST_CASE, EXPLORATORY, REPLAY, GHERKIN]
    // Whether this test result was part of a test config configured rerun attempt.
    is_rerun: boolean
    // The time the test run started.
    start_time: string
    // The time the test run completed. If it is still running, this will be null.
    end_time: Partial(string) & Partial(null)
    // The name of the model used for the test execution. If this was a scripted test case result, this will be null.
    model_name: Partial(string) & Partial(null)
    // The id of the model used for the test execution. If this was a scripted test case result, this will be null.
    model_id: Partial(string) & Partial(null)
    // The name of the suite used for the test execution.
    suite_name: Partial(string) & Partial(null)
    // The id of the suite used for the test execution.
    suite_id: Partial(string) & Partial(null)
    // The name of the test case that is being executed. For an exploratory or replay test result, this will be null.
    test_case_name: Partial(string) & Partial(null)
    // The id of the test case that was executed. For an exploratory or replay test result, this will be null.
    test_case_id: Partial(string) & Partial(null)
    // The name of the design or run agent used for the test execution
    execution_environment_name: Partial(string) & Partial(null)
    // The id of the design or run agent used for the test execution.
    execution_environment_id: Partial(integer) & Partial(null)
    // The name of the SUT used for the test execution.
    sut_name: Partial(string) & Partial(null)
    // The id of the SUT used for the test execution.
    sut_id: Partial(string) & Partial(null)
    // The id of the test config result that this test result is part of. For a live run, this will be null.
    test_config_result_id: Partial(string) & Partial(null)
    // The test config step of which this test result represents. This is zero-indexed and for a live run result, this will be null.
    test_config_step: Partial(integer) & Partial(null)
    // The feature file this scenario test result was part of (if this is a gherkin test result).
    feature_file: Partial(string) & Partial(null)
    // The space the test result belongs to. Defaults to the Shared space if not specified.
    space_id: string //default: 910ba100-0000-4000-a000-000000000000
    test_case_tags: {
      // The tag ID.
      id: string
      // The tag name.
      name: string
      // The tag color.
      color: Partial(string) & Partial(null)
      // The space the tag belongs to.
      space_id: Partial(string) & Partial(null)
    }[]
    test_config_tags:#/components/schemas/TestResultTag[]
    // The external ID associated with the test result.
    external_id: Partial(string) & Partial(null)
    // The origin of the test result.
    origin: Partial(string) & Partial(null)
    // The source from which the test was executed.
    source: Partial(TestConfigSource) & Partial(null)
    // The action at which the test result failed.
    failed_at: Partial(string) & Partial(null)
  }[]
}

400 Bad request

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

422 Validation Error

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
    ctx: {
    }
  }[]
}

[GET] /test_results/{test_result_id}

Summary:
Get the result of a single test

Description:
Gets the test result of the given test_result_id.

Headers

// The access_token that is returned from the POST /auth endpoint.
authorization: string

Responses

200 Test result retrieved successfully

application/json

// The test result containing all the information for a single exploratory, replay or test case execution.
{
  // The test result id.
  id: integer
  // The possible statuses for a particular test result.
  status: enum[RUNNING, PASSED, FAILED, ERROR, CANCELLED]
  // The possible run types for a particular test result.
  run_type: enum[SCRIPTED_TEST_CASE, MODEL_TEST_CASE, EXPLORATORY, REPLAY, GHERKIN]
  // Whether this test result was part of a test config configured rerun attempt.
  is_rerun: boolean
  // The time the test run started.
  start_time: string
  // The time the test run completed. If it is still running, this will be null.
  end_time: Partial(string) & Partial(null)
  // The name of the model used for the test execution. If this was a scripted test case result, this will be null.
  model_name: Partial(string) & Partial(null)
  // The id of the model used for the test execution. If this was a scripted test case result, this will be null.
  model_id: Partial(string) & Partial(null)
  // The name of the suite used for the test execution.
  suite_name: Partial(string) & Partial(null)
  // The id of the suite used for the test execution.
  suite_id: Partial(string) & Partial(null)
  // The name of the test case that is being executed. For an exploratory or replay test result, this will be null.
  test_case_name: Partial(string) & Partial(null)
  // The id of the test case that was executed. For an exploratory or replay test result, this will be null.
  test_case_id: Partial(string) & Partial(null)
  // The name of the design or run agent used for the test execution
  execution_environment_name: Partial(string) & Partial(null)
  // The id of the design or run agent used for the test execution.
  execution_environment_id: Partial(integer) & Partial(null)
  // The name of the SUT used for the test execution.
  sut_name: Partial(string) & Partial(null)
  // The id of the SUT used for the test execution.
  sut_id: Partial(string) & Partial(null)
  // The id of the test config result that this test result is part of. For a live run, this will be null.
  test_config_result_id: Partial(string) & Partial(null)
  // The test config step of which this test result represents. This is zero-indexed and for a live run result, this will be null.
  test_config_step: Partial(integer) & Partial(null)
  // The feature file this scenario test result was part of (if this is a gherkin test result).
  feature_file: Partial(string) & Partial(null)
  // The space the test result belongs to. Defaults to the Shared space if not specified.
  space_id: string //default: 910ba100-0000-4000-a000-000000000000
  test_case_tags: {
    // The tag ID.
    id: string
    // The tag name.
    name: string
    // The tag color.
    color: Partial(string) & Partial(null)
    // The space the tag belongs to.
    space_id: Partial(string) & Partial(null)
  }[]
  test_config_tags:#/components/schemas/TestResultTag[]
  // The external ID associated with the test result.
  external_id: Partial(string) & Partial(null)
  // The origin of the test result.
  origin: Partial(string) & Partial(null)
  // The source from which the test was executed.
  source: Partial(TestConfigSource) & Partial(null)
  // The action at which the test result failed.
  failed_at: Partial(string) & Partial(null)
}

400 Bad request

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

403 Access denied

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

404 Test result not found

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

422 Validation Error

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
    ctx: {
    }
  }[]
}

[GET] /test_results/{test_result_id}/logs

Summary:
Get the logs for a single test

Description:
Gets a paginated list of a single test result's logs.

Parameters (Query)

// The number of test result log entries at the beginning that will be excluded from the returned list.
offset: integer

// The maximum number of test result log entries that will be returned. Note that the limit's maximum value can be changed by setting the LIMIT_MAX_VALUE in your system environment variables. Allowable range for LIMIT_MAX_VALUE is 1000-2147483647 inclusive.
limit: integer //default: 1000

Headers

// The access_token that is returned from the POST /auth endpoint.
authorization: string

Responses

200 Test result logs retrieved successfully

application/json

// A paginated list of a single test result's log entries.
{
  // The total number of items that matches the request before any limit or offset are applied.
  total_count: integer
  // The date and time when this request was made.
  date_as_of: string
  // A single log entry from a particular test result.
  items: {
    // The id of the test result of which this log entry is part of.
    test_result_id: integer
    // The timestamp when this log entry was created.
    timestamp: string
    // The message conveyed in this test result log entry.
    message: string
    // The severity levels of a single test result log entry.
    severity: enum[CRITICAL, ERROR, WARNING, INFO, DEBUG]
    stage: enum[INITIALISING, ENGINE, SNIPPET]
    // The type of the message
    message_type: string
    // The name of the image
    image_name: string
    // The ID of the image
    image_id: Partial(string) & Partial(null)
  }[]
}

400 Bad request

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

403 Access denied

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

404 Test result not found

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

422 Validation Error

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
    ctx: {
    }
  }[]
}

[GET] /test_results/{test_result_id}/screenshots

Summary:
List the available screenshots for a test

Description:
Gets a paginated list of screenshots available for the test specified by the given test_result_id.

Parameters (Query)

// The number of screenshots available at the beginning that will be excluded from the returned list.
offset: integer

// The maximum number of screenshots available that will be returned.
// Note that the limit's maximum value can be changed by setting the LIMIT_MAX_VALUE in your system environment variables.
// Allowable range for LIMIT_MAX_VALUE is 1000-2147483647 inclusive.
limit: integer //default: 1000

Headers

// The access_token that is returned from the POST /auth endpoint.
authorization: string

Responses

200 Screenshots available retrieved successfully

application/json

// A paginated list of a single test result's screenshots available.
{
  // The total number of items that matches the request before any limit or offset are applied.
  total_count: integer
  // The date and time when this request was made.
  date_as_of: string
  // Info of an available screenshot for a particular test result.
  items: {
    // The artifact id of this screenshot.
    id: string
    // The timestamp when this screenshot was created.
    timestamp: string
    // The image format of this screenshot.
    content_type: string
  }[]
}

400 Bad request

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

403 Access denied

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

404 Test result not found

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

422 Validation Error

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
    ctx: {
    }
  }[]
}

[GET] /screenshots/{screenshot_id}

Summary:
Download a screenshot for a test result

Description:
Downloads the screenshot for the given screenshot_id.

Headers

// The access_token that is returned from the POST /auth endpoint.
authorization: string

Responses

200 The screenshot of interest, in bytes

image/png image/tiff image/jpeg

400 Bad request

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

404 Test result screenshot not found

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

422 Validation Error

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
    ctx: {
    }
  }[]
}

[GET] /test_config_results

Summary:
List test config results

Description:
Gets a paginated list of test config results matching the filters applied.

Parameters (Query)

// The number of test config results at the beginning which matches the filters applied but will be excluded from the returned list.
offset: integer

// The maximum number of test results that will be returned.  
// Note that the limit's maximum value can be changed by setting the LIMIT_MAX_VALUE in your system environment variables.  
// Allowable range for LIMIT_MAX_VALUE is 1000-2147483647 inclusive.
limit: integer //default: 1000

sort_by: enum[start_time, test_config_name, source]

// The possible direction applied during sorting.
sort_direction: enum[asc, desc]

// The possible statuses for a particular test config result.
status: enum[PENDING, RUNNING, PASSED, PASSED_AFTER_RERUN, FAILED, ERROR, CANCELLING, CANCELLED]

// Filter the test config results to obtain those which started after the given time.
start_time: string //default: null

// Filter the test config results to obtain those which started before the given time.
end_time: string //default: null

// Filter the test config results to obtain the results that use the test config matching the given test_config_id. This will take precedence if used in conjunction with the space_id filter.
test_config_id: string //default: null

// The space ID to filter the test config results by. This filter will be ignored if used in conjunction with the test_config_id filter.
space_id: string //default: 910ba100-0000-4000-a000-000000000000

Headers

// The access_token that is returned from the POST /auth endpoint.
authorization: string

Responses

200 OK

application/json

{
  // The total number of items that matches the request before any limit or offset are applied.
  total_count: integer
  // The date and time when this request was made.
  date_as_of: string
  // TestConfigResult with basic details
  items: {
    // The test config result ID
    id: string
    // The possible statuses for a particular test config result.
    status: enum[PENDING, RUNNING, PASSED, PASSED_AFTER_RERUN, FAILED, ERROR, CANCELLING, CANCELLED]
    // The time the test config run started.
    start_time: string
    // The time the test config run completed. If it is still running, this will be null.
    end_time: Partial(string) & Partial(null)
    // The name of the test configuration
    test_config_name: Partial(string) & Partial(null)
    // The ID of the test configuration
    test_config_id: string
    // The source from which the test config is being executed.
    source: Partial(TestConfigSource) & Partial(null)
    // Granular test config filter options that being used for test config
    filter_options: Partial({
     }) & Partial(null)
    // The space the test config belongs to. Defaults to the Shared space if not specified.
    space_id: string //default: 910ba100-0000-4000-a000-000000000000
  }[]
}

400 Bad request

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

422 Validation Error

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
    ctx: {
    }
  }[]
}

[GET] /test_config_results/{test_config_result_id}

Summary:
Get a test config result

Description:
Gets the test config result for the given test_config_result_id.

Headers

// The access_token that is returned from the POST /auth endpoint.
authorization: string

Responses

200 Test config result retrieved successfully

application/json

// Extends TestConfigResult with additional details
{
  // The test config result ID
  id: string
  // The possible statuses for a particular test config result.
  status: enum[PENDING, RUNNING, PASSED, PASSED_AFTER_RERUN, FAILED, ERROR, CANCELLING, CANCELLED]
  // The time the test config run started.
  start_time: string
  // The time the test config run completed. If it is still running, this will be null.
  end_time: Partial(string) & Partial(null)
  // The name of the test configuration
  test_config_name: Partial(string) & Partial(null)
  // The ID of the test configuration
  test_config_id: string
  // The source from which the test config is being executed.
  source: Partial(TestConfigSource) & Partial(null)
  // Granular test config filter options that being used for test config
  filter_options: Partial({
   }) & Partial(null)
  // The space the test config belongs to. Defaults to the Shared space if not specified.
  space_id: string //default: 910ba100-0000-4000-a000-000000000000
  // Whether any execution in this test config result was a rerun.
  is_rerun: boolean
  // The total number of steps in the referenced test configuration.
  total_steps_in_test_config: integer
  // Test config with SUT information
  suts_used: {
    // The SUT ID
    id: Partial(integer) & Partial(string)
    // The SUT name
    name: string
  }[]
  // The total execution time in seconds for the test config result.
  total_execution_time_secs: integer
  // Whether the test config reruns steps when an error occurs.
  rerun_on_error: boolean
  // Whether the test config reruns steps when a failure occurs.
  rerun_on_failure: boolean
  // The pre-run custom script ID, if configured.
  pre_run_custom_script_id: Partial(string) & Partial(null)
  // The pre-run custom script name, if configured.
  pre_run_custom_script_name: Partial(string) & Partial(null)
  // The configured run timeout in seconds.
  run_timeout: Partial(integer) & Partial(null)
  // The configured system run timeout in seconds.
  system_run_timeout: integer
  // The number of skipped steps in this test config result.
  total_steps_skipped: integer
  // The number of ignored steps in this test config result.
  total_steps_ignored: integer
  // Test config with tag information
  test_config_tags: {
    // The test configuration tag ID.
    id: string
    // The test configuration tag name.
    name: string
    // The tag color.
    color: Partial(string) & Partial(null)
    // The space the tag belongs to.
    space_id: Partial(string) & Partial(null)
  }[]
  // Test config with step information
  test_config_steps: {
    // The test configuration step type.
    step_type: Partial(string) & Partial(null)
    // The referenced test case ID, when applicable.
    test_case_uuid: Partial(string) & Partial(null)
    // Overrides for directed test case steps, when configured.
    directed_test_case_steps: Partial(     // Test config with model test case step
{
       // The model action ID to execute.
       action_id: Partial(string) & Partial(null)
       // The submodel test case ID, when the step targets a submodel.
       submodel_test_case_id: Partial(string) & Partial(null)
       // The parameter overrides for the directed test case step.
       parameters: Partial(        // Test config with step parameter override
{
          // The parameter ID.
          parameter_id: string
          // The parameter value.
          value: string
          // The parameter name, when available.
          name: Partial(string) & Partial(null)
        }[]) & Partial(null)
     }[]) & Partial(null)
    // Overrides for scripted test case steps, when configured.
    scripted_test_case_steps: Partial(     // Test config with scripted test case step
{
       // The local script path for the scripted step.
       local_path: string
       // The parameter string for the scripted step.
       parameters: string
     }[]) & Partial(null)
    // Any validation error message associated with the step.
    validation_error_message: Partial(string) & Partial(null)
  }[]
  // The scripted test configuration global parameters configured on the referenced test configuration. 
  scripted_test_config_params: Partial({
   }) & Partial(null)
}

400 Bad request

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

403 Access denied

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

404 Test config result not found

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

422 Validation Error

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
    ctx: {
    }
  }[]
}

[GET] /test_config_results/{test_config_result_id}/junit

Summary:
Get the results of a test config run in junit format

Description:
For the given test_config_result_id, generate a report in JUnit XML format

Headers

// The access_token that is returned from the POST /auth endpoint.
authorization: string

Responses

200 Test config results report generated successfully

application/json

{}

application/xml

400 Bad request

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

403 Access denied

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

404 Test config result not found

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

422 Validation Error

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
    ctx: {
    }
  }[]
}

[POST] /suts

Summary:
Create a new SUT

Description:
Create a new SUT based on given info.

Headers

// The access_token that is returned from the POST /auth endpoint.
authorization: string

RequestBody

application/json

// Base class for SUT request bodies to avoid duplication
{
  // The name of the SUT
  name: Partial(string) & Partial(null)
  // The description of the SUT
  description: Partial(string) & Partial(null)
  // Whether this SUT is enabled or disabled
  enabled: boolean //default: true
  connections: Partial(VncConnectionRequest) & Partial(RdpConnectionRequest) & Partial(WebDriverConnectionRequest) & Partial(CitrixConnectionRequest) & Partial(SauceLabsDeviceConnectionRequest) & Partial(SauceLabsBrowserConnectionRequest) & Partial(AndroidConnectionRequest) & Partial(IOSConnectionRequest) & Partial(SingleSystemConnectionRequest)[]
  // List of criteria for the SUT
  criteria: Partial({
     // The ID of the criteria
     id: string
     // The name of the criteria
     name: string
     // The color of the criteria
     color: string
   }[]) & Partial(null)
  // [Deprecated] List of execution environments associated with the SUT
  execution_environments: Partial([]) & Partial(null)
  // The ID of the execution environment associated with the SUT
  execution_environment_id: Partial(integer) & Partial(null)
  // The space the SUT belongs to
  space_id: Partial(string) & Partial(null)
}

Responses

200 Successful Response

application/json

// The information that is needed to create a new SUT
{
  // The name of the SUT.
  name: string
  // The description of the SUT.
  description: string
  // The id of the SUT
  id: string
  // Whether this SUT is enabled or disabled
  enabled: boolean
  connections: Partial(VncConnectionResponse) & Partial(RdpConnectionResponse) & Partial(WebDriverConnectionResponse) & Partial(CitrixConnectionResponse) & Partial(SauceLabsDeviceConnectionResponse) & Partial(SauceLabsBrowserConnectionResponse) & Partial(AndroidConnectionResponse) & Partial(IOSConnectionResponse) & Partial(SingleSystemConnectionResponse)[]
  // List of criteria for the SUT
  criteria: Partial({
     // The ID of the criteria
     id: string
     // The name of the criteria
     name: string
     // The color of the criteria
     color: string
     // The space the criteria belongs to. Defaults to the Shared space if not specified.
     space_id: string //default: 910ba100-0000-4000-a000-000000000000
   }[]) & Partial(null)
  execution_environments: string[]
  // The ID of the execution environment associated with the SUT
  execution_environment_id: Partial(string) & Partial(null)
  // The space the sut belongs to. Defaults to the Shared space if not specified.
  space_id: string //default: 910ba100-0000-4000-a000-000000000000
}

201 OK

application/json

400 Bad request

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

403 Access denied

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

422 Validation Error

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
    ctx: {
    }
  }[]
}

[GET] /suts

Summary:
List SUTs

Description:
Gets a paginated list of SUTs matching the filters applied.

Parameters (Query)

// 
// The number of SUTs at the beginning which matches the filters applied but will be excluded from the returned list.
// 
offset: integer

// The maximum number of SUTs that will be returned.
// Note that the limit's maximum value can be changed by setting the LIMIT_MAX_VALUE in your system environment variables.
// Allowable range for LIMIT_MAX_VALUE is 1000-2147483647 inclusive.
limit: integer //default: 1000

// Filter the SUTs by a sut name.
name: string

// Filter the sut by a particular enabled boolean flag.
enabled: boolean

// Filter the sut by a particular is_locked boolean flag.
is_locked: boolean

// Filter the SUTs by a particular space ID.
space_id: string //default: 910ba100-0000-4000-a000-000000000000

Headers

// The access_token that is returned from the POST /auth endpoint.
authorization: string

Responses

200 OK

application/json

// A paginated list of the Suts.
{
  // The total number of items that matches the request before any limit or offset are applied.
  total_count: integer
  // The date and time when this request was made.
  date_as_of: string
  // The information that is needed to create a new SUT
  items: {
    // The name of the SUT.
    name: string
    // The description of the SUT.
    description: string
    // The id of the SUT
    id: string
    // Whether this SUT is enabled or disabled
    enabled: boolean
    connections: Partial(VncConnectionResponse) & Partial(RdpConnectionResponse) & Partial(WebDriverConnectionResponse) & Partial(CitrixConnectionResponse) & Partial(SauceLabsDeviceConnectionResponse) & Partial(SauceLabsBrowserConnectionResponse) & Partial(AndroidConnectionResponse) & Partial(IOSConnectionResponse) & Partial(SingleSystemConnectionResponse)[]
    // List of criteria for the SUT
    criteria: Partial({
       // The ID of the criteria
       id: string
       // The name of the criteria
       name: string
       // The color of the criteria
       color: string
       // The space the criteria belongs to. Defaults to the Shared space if not specified.
       space_id: string //default: 910ba100-0000-4000-a000-000000000000
     }[]) & Partial(null)
    execution_environments: string[]
    // The ID of the execution environment associated with the SUT
    execution_environment_id: Partial(string) & Partial(null)
    // The space the sut belongs to. Defaults to the Shared space if not specified.
    space_id: string //default: 910ba100-0000-4000-a000-000000000000
  }[]
}

400 Bad request

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

422 Validation Error

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
    ctx: {
    }
  }[]
}

[PUT] /suts/{sut_id}

Summary:
Update existing SUT

Description:
Update existing SUT based on given info.

Headers

// The access_token that is returned from the POST /auth endpoint.
authorization: string

RequestBody

application/json

// Base class for SUT request bodies to avoid duplication
{
  // The name of the SUT
  name: Partial(string) & Partial(null)
  // The description of the SUT
  description: Partial(string) & Partial(null)
  // Whether this SUT is enabled or disabled
  enabled: boolean //default: true
  connections: Partial(VncConnectionRequest) & Partial(RdpConnectionRequest) & Partial(WebDriverConnectionRequest) & Partial(CitrixConnectionRequest) & Partial(SauceLabsDeviceConnectionRequest) & Partial(SauceLabsBrowserConnectionRequest) & Partial(AndroidConnectionRequest) & Partial(IOSConnectionRequest) & Partial(SingleSystemConnectionRequest)[]
  // List of criteria for the SUT
  criteria: Partial({
     // The ID of the criteria
     id: string
     // The name of the criteria
     name: string
     // The color of the criteria
     color: string
   }[]) & Partial(null)
  // [Deprecated] List of execution environments associated with the SUT
  execution_environments: Partial([]) & Partial(null)
  // The ID of the execution environment associated with the SUT
  execution_environment_id: Partial(integer) & Partial(null)
  // The space the SUT belongs to
  space_id: Partial(string) & Partial(null)
}

Responses

200 Successful Response

application/json

// The information that is needed to create a new SUT
{
  // The name of the SUT.
  name: string
  // The description of the SUT.
  description: string
  // The id of the SUT
  id: string
  // Whether this SUT is enabled or disabled
  enabled: boolean
  connections: Partial(VncConnectionResponse) & Partial(RdpConnectionResponse) & Partial(WebDriverConnectionResponse) & Partial(CitrixConnectionResponse) & Partial(SauceLabsDeviceConnectionResponse) & Partial(SauceLabsBrowserConnectionResponse) & Partial(AndroidConnectionResponse) & Partial(IOSConnectionResponse) & Partial(SingleSystemConnectionResponse)[]
  // List of criteria for the SUT
  criteria: Partial({
     // The ID of the criteria
     id: string
     // The name of the criteria
     name: string
     // The color of the criteria
     color: string
     // The space the criteria belongs to. Defaults to the Shared space if not specified.
     space_id: string //default: 910ba100-0000-4000-a000-000000000000
   }[]) & Partial(null)
  execution_environments: string[]
  // The ID of the execution environment associated with the SUT
  execution_environment_id: Partial(string) & Partial(null)
  // The space the sut belongs to. Defaults to the Shared space if not specified.
  space_id: string //default: 910ba100-0000-4000-a000-000000000000
}

201 OK

application/json

400 Bad request

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

403 Access denied

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

404 SUT ID not found

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

422 Validation Error

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
    ctx: {
    }
  }[]
}

[DELETE] /suts/{sut_id}

Summary:
Delete existing SUT

Description:
Delete existing SUT based on given SUT ID.

Headers

// The access_token that is returned from the POST /auth endpoint.
authorization: string

Responses

200 Successful Response

application/json

{}

204 No Content

400 Bad request

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

403 Access denied

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

404 SUT ID not found

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

422 Validation Error

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
    ctx: {
    }
  }[]
}

[GET] /suts/{sut_id}

Summary:
Get details of a SUT based on the SUT id

Description:
Get the details of a specific SUT

Headers

// The access_token that is returned from the POST /auth endpoint.
authorization: string

Responses

200 SUT result returned successfully

application/json

// The information that is needed to create a new SUT
{
  // The name of the SUT.
  name: string
  // The description of the SUT.
  description: string
  // The id of the SUT
  id: string
  // Whether this SUT is enabled or disabled
  enabled: boolean
  connections: Partial(VncConnectionResponse) & Partial(RdpConnectionResponse) & Partial(WebDriverConnectionResponse) & Partial(CitrixConnectionResponse) & Partial(SauceLabsDeviceConnectionResponse) & Partial(SauceLabsBrowserConnectionResponse) & Partial(AndroidConnectionResponse) & Partial(IOSConnectionResponse) & Partial(SingleSystemConnectionResponse)[]
  // List of criteria for the SUT
  criteria: Partial({
     // The ID of the criteria
     id: string
     // The name of the criteria
     name: string
     // The color of the criteria
     color: string
     // The space the criteria belongs to. Defaults to the Shared space if not specified.
     space_id: string //default: 910ba100-0000-4000-a000-000000000000
   }[]) & Partial(null)
  execution_environments: string[]
  // The ID of the execution environment associated with the SUT
  execution_environment_id: Partial(string) & Partial(null)
  // The space the sut belongs to. Defaults to the Shared space if not specified.
  space_id: string //default: 910ba100-0000-4000-a000-000000000000
}

400 Bad request

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

403 Access denied

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

404 SUT is not found

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

422 Validation Error

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
    ctx: {
    }
  }[]
}

[GET] /spaces/{space_id}/export

Summary:
Export a space

Description:
Exports all assets in a space as a ZIP archive.

Headers

// The access_token that is returned from the POST /auth endpoint.
authorization: string

Responses

200 ZIP archive of all space assets

application/json

{}

application/zip

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

403 Permission denied

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

404 Space not found

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

422 Validation Error

application/json

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
    ctx: {
    }
  }[]
}

[POST] /spaces/import

Summary:
Import a space

Description:
Imports all assets in a space from a ZIP archive.

Headers

authorization: string

RequestBody

multipart/form-data

{
  // The ZIP file containing the space export.
  file: string
  // The name of the newly imported space. If not provided, the original space name will be used.
  space_name: string
}

Responses

201 Space imported successfully

application/json

{}

400 Invalid ZIP file

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

401 Unauthorized

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

403 Permission denied

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

409 Space name already exists

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

422 Import failed

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

507 Insufficient storage

application/json

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

References

AndroidConnectionRequest

// Android connection for POST/PUT requests - no uuid
{
  // Connection type for Android
  connection_type: string
  // The unique identifier of the Android device to connect to
  device_id: string
}

AndroidConnectionResponse

// Android connection for GET responses - includes uuid
{
  // Connection type for Android
  connection_type: string
  // The unique identifier of the Android device to connect to
  device_id: string
  // Unique identifier for the connection
  uuid: string
}

AuthRequestBody

{
  client_id: string
  client_secret: string
}

AuthResponseBody

{
  access_token: string
  expires_in: integer
}

BaseSutRequest

// Base class for SUT request bodies to avoid duplication
{
  // The name of the SUT
  name: Partial(string) & Partial(null)
  // The description of the SUT
  description: Partial(string) & Partial(null)
  // Whether this SUT is enabled or disabled
  enabled: boolean //default: true
  connections: Partial(VncConnectionRequest) & Partial(RdpConnectionRequest) & Partial(WebDriverConnectionRequest) & Partial(CitrixConnectionRequest) & Partial(SauceLabsDeviceConnectionRequest) & Partial(SauceLabsBrowserConnectionRequest) & Partial(AndroidConnectionRequest) & Partial(IOSConnectionRequest) & Partial(SingleSystemConnectionRequest)[]
  // List of criteria for the SUT
  criteria: Partial({
     // The ID of the criteria
     id: string
     // The name of the criteria
     name: string
     // The color of the criteria
     color: string
   }[]) & Partial(null)
  // [Deprecated] List of execution environments associated with the SUT
  execution_environments: Partial([]) & Partial(null)
  // The ID of the execution environment associated with the SUT
  execution_environment_id: Partial(integer) & Partial(null)
  // The space the SUT belongs to
  space_id: Partial(string) & Partial(null)
}

Body_import_space_spaces_import_post

{
  // The ZIP file containing the space export.
  file: string
  // The name of the newly imported space. If not provided, the original space name will be used.
  space_name: string
}

BrowserType

{
  "type": "string",
  "enum": [
    "none",
    "chrome",
    "firefox",
    "safari",
    "MicrosoftEdge",
    "internet explorer"
  ],
  "title": "BrowserType"
}

CitrixConnectionRequest

// Citrix connection for POST/PUT requests - no uuid
{
  // Connection type for Citrix
  connection_type: string
  // The username to connect to the Citrix SUT
  username: string
  // The password for the username to connect to the Citrix SUT
  password: Partial(string) & Partial(null)
  // The Citrix Storefront URL
  storefront_url: string
  // The name of the application or desktop to launch in Citrix
  application: string
  // The time to wait (milliseconds) between two subsequent captures of the Citrix frame buffer, e.g. 400
  screenshot_interval: string
  // The width and height at which the Citrix window must open, e.g., 1920x1080
  screen_resolution: string
}

CitrixConnectionResponse

// Citrix connection for GET responses - includes uuid
{
  // Connection type for Citrix
  connection_type: string
  // The username to connect to the Citrix SUT
  username: string
  // The password for the username to connect to the Citrix SUT
  password: Partial(string) & Partial(null)
  // The Citrix Storefront URL
  storefront_url: string
  // The name of the application or desktop to launch in Citrix
  application: string
  // The time to wait (milliseconds) between two subsequent captures of the Citrix frame buffer, e.g. 400
  screenshot_interval: string
  // The width and height at which the Citrix window must open, e.g., 1920x1080
  screen_resolution: string
  // Unique identifier for the connection
  uuid: string
}

ColorDepth

{
  "type": "integer",
  "enum": [
    0,
    8,
    16,
    32
  ],
  "title": "ColorDepth",
  "description": "Color depth for VNC/RDP connections. Higher values provide better quality but may reduce performance."
}

Criteria

{
  // The ID of the criteria
  id: string
  // The name of the criteria
  name: string
  // The color of the criteria
  color: string
  // The space the criteria belongs to. Defaults to the Shared space if not specified.
  space_id: string //default: 910ba100-0000-4000-a000-000000000000
}

CriteriaWithoutSpace

{
  // The ID of the criteria
  id: string
  // The name of the criteria
  name: string
  // The color of the criteria
  color: string
}

HTTPValidationError

{
  detail: {
    loc: Partial(string) & Partial(integer)[]
    msg: string
    type: string
    ctx: {
    }
  }[]
}

IOSConnectionRequest

// iOS connection for POST/PUT requests - no uuid
{
  // Connection type for iOS
  connection_type: string
  // The unique device identifier (UDID) of the iOS device to connect to
  device_udid: string
  // The name or thumbprint of the certificate used for code signing
  certificate_name_or_thumbprint: Partial(string) & Partial(null)
  // The name or identifier of the provisioning profile required for app deployment
  provisioning_profile_name_or_identifier: string
}

IOSConnectionResponse

// iOS connection for GET responses - includes uuid
{
  // Connection type for iOS
  connection_type: string
  // The unique device identifier (UDID) of the iOS device to connect to
  device_udid: string
  // The name or thumbprint of the certificate used for code signing
  certificate_name_or_thumbprint: Partial(string) & Partial(null)
  // The name or identifier of the provisioning profile required for app deployment
  provisioning_profile_name_or_identifier: string
  // Unique identifier for the connection
  uuid: string
}

Problem

{
  status: integer //default: 400
  title: Partial(string) & Partial(null)
  detail: Partial(string) & Partial(null)
  type: Partial(string) & Partial(null)
  lock_errors: Partial(string[]) & Partial(null)
}

RdpConnectionRequest

// RDP connection for POST/PUT requests - no uuid
{
  // Connection type for RDP
  connection_type: string
  // The SUT's IP Address or Hostname
  host: string
  // The port number used to connect to the SUT
  port: integer
  // The username of RDP connection for SUT to connect
  username: Partial(string) & Partial(null)
  // The password of RDP connection for SUT to connect
  password: Partial(string) & Partial(null)
  // The depth of color with which the RDP sessions open. To increase the speed of your connection, you can decrease the color depth
  color_depth: Partial(ColorDepth) & Partial(null)
  // The width at which the RDP session window must open
  width: Partial(integer) & Partial(null)
  // The height at which the RDP session window must open
  height: Partial(integer) & Partial(null)
  // The number of monitors for an RDP SUT connection to run and manage multi-monitor test executions
  monitor_count: Partial(integer) & Partial(null)
}

RdpConnectionResponse

// RDP connection for GET responses - includes uuid
{
  // Connection type for RDP
  connection_type: string
  // The SUT's IP Address or Hostname
  host: string
  // The port number used to connect to the SUT
  port: integer
  // The username of RDP connection for SUT to connect
  username: Partial(string) & Partial(null)
  // The password of RDP connection for SUT to connect
  password: Partial(string) & Partial(null)
  // The depth of color with which the RDP sessions open. To increase the speed of your connection, you can decrease the color depth
  color_depth: Partial(ColorDepth) & Partial(null)
  // The width at which the RDP session window must open
  width: Partial(integer) & Partial(null)
  // The height at which the RDP session window must open
  height: Partial(integer) & Partial(null)
  // The number of monitors for an RDP SUT connection to run and manage multi-monitor test executions
  monitor_count: Partial(integer) & Partial(null)
  // Unique identifier for the connection
  uuid: string
}

RunType

{
  "type": "string",
  "enum": [
    "SCRIPTED_TEST_CASE",
    "MODEL_TEST_CASE",
    "EXPLORATORY",
    "REPLAY",
    "GHERKIN"
  ],
  "title": "RunType",
  "description": "The possible run types for a particular test result."
}

SauceLabsBrowserConnectionRequest

// SauceLabs Browser connection for POST/PUT requests - no uuid
{
  // The location of the Sauce Labs server where your tests are run and related artifacts are stored
  data_center: string
  // The operating system to use for the Sauce Labs SUT
  platform_name: string
  // The Sauce Labs account username
  username: string
  // The Sauce Labs account API Key
  api_key: Partial(string) & Partial(null)
  // Your tunnel name if you use tunnel proxies with your Sauce Labs connections
  tunnel_name: Partial(string) & Partial(null)
  // Your tunnel owner name if you use tunnel proxies with your Sauce Labs connections
  tunnel_owner: Partial(string) & Partial(null)
  // Connection type for Sauce Labs Browser
  connection_type: string
  // The type of browser to launch on the Sauce Labs SUT
  browser_name: string
  // The screen resolution for the Sauce Labs browser session e.g., 1920x1080
  resolution: string
  // The browser version to use for the Sauce Labs SUT
  version: Partial(string) & Partial(null)
  // The website address to navigate to when the browser launches.
  url: Partial(string) & Partial(null)
}

SauceLabsBrowserConnectionResponse

// SauceLabs Browser connection for GET responses - includes uuid
{
  // The location of the Sauce Labs server where your tests are run and related artifacts are stored
  data_center: string
  // The operating system to use for the Sauce Labs SUT
  platform_name: string
  // The Sauce Labs account username
  username: string
  // The Sauce Labs account API Key
  api_key: Partial(string) & Partial(null)
  // Your tunnel name if you use tunnel proxies with your Sauce Labs connections
  tunnel_name: Partial(string) & Partial(null)
  // Your tunnel owner name if you use tunnel proxies with your Sauce Labs connections
  tunnel_owner: Partial(string) & Partial(null)
  // Connection type for Sauce Labs Browser
  connection_type: string
  // The type of browser to launch on the Sauce Labs SUT
  browser_name: string
  // The screen resolution for the Sauce Labs browser session e.g., 1920x1080
  resolution: string
  // The browser version to use for the Sauce Labs SUT
  version: Partial(string) & Partial(null)
  // The website address to navigate to when the browser launches.
  url: Partial(string) & Partial(null)
  // Unique identifier for the connection
  uuid: string
}

SauceLabsDeviceConnectionRequest

// SauceLabs Device connection for POST/PUT requests - no uuid
{
  // The location of the Sauce Labs server where your tests are run and related artifacts are stored
  data_center: string
  // The operating system to use for the Sauce Labs SUT
  platform_name: string
  // The Sauce Labs account username
  username: string
  // The Sauce Labs account API Key
  api_key: Partial(string) & Partial(null)
  // Your tunnel name if you use tunnel proxies with your Sauce Labs connections
  tunnel_name: Partial(string) & Partial(null)
  // Your tunnel owner name if you use tunnel proxies with your Sauce Labs connections
  tunnel_owner: Partial(string) & Partial(null)
  // Connection type for Sauce Labs Device
  connection_type: string
  // The type of mobile device and version
  device_name: string
  // The path to the app you want to launch on the Sauce Labs device (e.g., path to .ipa, .apk, .aab or .zip file)
  url: Partial(string) & Partial(null)
}

SauceLabsDeviceConnectionResponse

// SauceLabs Device connection for GET responses - includes uuid
{
  // The location of the Sauce Labs server where your tests are run and related artifacts are stored
  data_center: string
  // The operating system to use for the Sauce Labs SUT
  platform_name: string
  // The Sauce Labs account username
  username: string
  // The Sauce Labs account API Key
  api_key: Partial(string) & Partial(null)
  // Your tunnel name if you use tunnel proxies with your Sauce Labs connections
  tunnel_name: Partial(string) & Partial(null)
  // Your tunnel owner name if you use tunnel proxies with your Sauce Labs connections
  tunnel_owner: Partial(string) & Partial(null)
  // Connection type for Sauce Labs Device
  connection_type: string
  // The type of mobile device and version
  device_name: string
  // The path to the app you want to launch on the Sauce Labs device (e.g., path to .ipa, .apk, .aab or .zip file)
  url: Partial(string) & Partial(null)
  // Unique identifier for the connection
  uuid: string
}

ScaleRatio

{
  "type": "integer",
  "enum": [
    1,
    2
  ],
  "title": "ScaleRatio",
  "description": "Scale ratio for VNC connection. 1 = normal size, 2 = scaled by 50%"
}

Screenshot

// Info of an available screenshot for a particular test result.
{
  // The artifact id of this screenshot.
  id: string
  // The timestamp when this screenshot was created.
  timestamp: string
  // The image format of this screenshot.
  content_type: string
}

ScreenshotsPaginatedList

// A paginated list of a single test result's screenshots available.
{
  // The total number of items that matches the request before any limit or offset are applied.
  total_count: integer
  // The date and time when this request was made.
  date_as_of: string
  // Info of an available screenshot for a particular test result.
  items: {
    // The artifact id of this screenshot.
    id: string
    // The timestamp when this screenshot was created.
    timestamp: string
    // The image format of this screenshot.
    content_type: string
  }[]
}

Severity

{
  "type": "string",
  "enum": [
    "CRITICAL",
    "ERROR",
    "WARNING",
    "INFO",
    "DEBUG"
  ],
  "title": "Severity",
  "description": "The severity levels of a single test result log entry."
}

SingleSystemConnectionRequest

// SingleSystem connection for POST/PUT requests - no uuid
{
  // Connection type for Single System
  connection_type: string
  // The username to connect to the single system SUT
  username: Partial(string) & Partial(null)
  // The password to connect to the single system SUT
  password: Partial(string) & Partial(null)
  // The width at which the single system window must open
  width: Partial(integer) & Partial(null)
  // The height at which the single system window must open
  height: Partial(integer) & Partial(null)
}

SingleSystemConnectionResponse

// SingleSystem connection for GET responses - includes uuid
{
  // Connection type for Single System
  connection_type: string
  // The username to connect to the single system SUT
  username: Partial(string) & Partial(null)
  // The password to connect to the single system SUT
  password: Partial(string) & Partial(null)
  // The width at which the single system window must open
  width: Partial(integer) & Partial(null)
  // The height at which the single system window must open
  height: Partial(integer) & Partial(null)
  // Unique identifier for the connection
  uuid: string
}

SortBy

{
  "type": "string",
  "enum": [
    "id",
    "model_or_suite_name",
    "start_time",
    "test_case_name",
    "test_config_name",
    "execution_environment_name",
    "sut_name"
  ],
  "title": "SortBy",
  "description": "The possible sorting options available for sorting a list of test results."
}

SortDirection

{
  "type": "string",
  "enum": [
    "asc",
    "desc"
  ],
  "title": "SortDirection",
  "description": "The possible direction applied during sorting."
}

Stage

{
  "type": "string",
  "enum": [
    "INITIALISING",
    "ENGINE",
    "SNIPPET"
  ],
  "title": "Stage"
}

Status

{
  "type": "string",
  "enum": [
    "RUNNING",
    "PASSED",
    "FAILED",
    "ERROR",
    "CANCELLED"
  ],
  "title": "Status",
  "description": "The possible statuses for a particular test result."
}

Sut

// The information that is needed to create a new SUT
{
  // The name of the SUT.
  name: string
  // The description of the SUT.
  description: string
  // The id of the SUT
  id: string
  // Whether this SUT is enabled or disabled
  enabled: boolean
  connections: Partial(VncConnectionResponse) & Partial(RdpConnectionResponse) & Partial(WebDriverConnectionResponse) & Partial(CitrixConnectionResponse) & Partial(SauceLabsDeviceConnectionResponse) & Partial(SauceLabsBrowserConnectionResponse) & Partial(AndroidConnectionResponse) & Partial(IOSConnectionResponse) & Partial(SingleSystemConnectionResponse)[]
  // List of criteria for the SUT
  criteria: Partial({
     // The ID of the criteria
     id: string
     // The name of the criteria
     name: string
     // The color of the criteria
     color: string
     // The space the criteria belongs to. Defaults to the Shared space if not specified.
     space_id: string //default: 910ba100-0000-4000-a000-000000000000
   }[]) & Partial(null)
  execution_environments: string[]
  // The ID of the execution environment associated with the SUT
  execution_environment_id: Partial(string) & Partial(null)
  // The space the sut belongs to. Defaults to the Shared space if not specified.
  space_id: string //default: 910ba100-0000-4000-a000-000000000000
}

SutsPaginatedList

// A paginated list of the Suts.
{
  // The total number of items that matches the request before any limit or offset are applied.
  total_count: integer
  // The date and time when this request was made.
  date_as_of: string
  // The information that is needed to create a new SUT
  items: {
    // The name of the SUT.
    name: string
    // The description of the SUT.
    description: string
    // The id of the SUT
    id: string
    // Whether this SUT is enabled or disabled
    enabled: boolean
    connections: Partial(VncConnectionResponse) & Partial(RdpConnectionResponse) & Partial(WebDriverConnectionResponse) & Partial(CitrixConnectionResponse) & Partial(SauceLabsDeviceConnectionResponse) & Partial(SauceLabsBrowserConnectionResponse) & Partial(AndroidConnectionResponse) & Partial(IOSConnectionResponse) & Partial(SingleSystemConnectionResponse)[]
    // List of criteria for the SUT
    criteria: Partial({
       // The ID of the criteria
       id: string
       // The name of the criteria
       name: string
       // The color of the criteria
       color: string
       // The space the criteria belongs to. Defaults to the Shared space if not specified.
       space_id: string //default: 910ba100-0000-4000-a000-000000000000
     }[]) & Partial(null)
    execution_environments: string[]
    // The ID of the execution environment associated with the SUT
    execution_environment_id: Partial(string) & Partial(null)
    // The space the sut belongs to. Defaults to the Shared space if not specified.
    space_id: string //default: 910ba100-0000-4000-a000-000000000000
  }[]
}

TestConfigResult

// TestConfigResult with basic details
{
  // The test config result ID
  id: string
  // The possible statuses for a particular test config result.
  status: enum[PENDING, RUNNING, PASSED, PASSED_AFTER_RERUN, FAILED, ERROR, CANCELLING, CANCELLED]
  // The time the test config run started.
  start_time: string
  // The time the test config run completed. If it is still running, this will be null.
  end_time: Partial(string) & Partial(null)
  // The name of the test configuration
  test_config_name: Partial(string) & Partial(null)
  // The ID of the test configuration
  test_config_id: string
  // The source from which the test config is being executed.
  source: Partial(TestConfigSource) & Partial(null)
  // Granular test config filter options that being used for test config
  filter_options: Partial({
   }) & Partial(null)
  // The space the test config belongs to. Defaults to the Shared space if not specified.
  space_id: string //default: 910ba100-0000-4000-a000-000000000000
}

TestConfigResultDetails

// Extends TestConfigResult with additional details
{
  // The test config result ID
  id: string
  // The possible statuses for a particular test config result.
  status: enum[PENDING, RUNNING, PASSED, PASSED_AFTER_RERUN, FAILED, ERROR, CANCELLING, CANCELLED]
  // The time the test config run started.
  start_time: string
  // The time the test config run completed. If it is still running, this will be null.
  end_time: Partial(string) & Partial(null)
  // The name of the test configuration
  test_config_name: Partial(string) & Partial(null)
  // The ID of the test configuration
  test_config_id: string
  // The source from which the test config is being executed.
  source: Partial(TestConfigSource) & Partial(null)
  // Granular test config filter options that being used for test config
  filter_options: Partial({
   }) & Partial(null)
  // The space the test config belongs to. Defaults to the Shared space if not specified.
  space_id: string //default: 910ba100-0000-4000-a000-000000000000
  // Whether any execution in this test config result was a rerun.
  is_rerun: boolean
  // The total number of steps in the referenced test configuration.
  total_steps_in_test_config: integer
  // Test config with SUT information
  suts_used: {
    // The SUT ID
    id: Partial(integer) & Partial(string)
    // The SUT name
    name: string
  }[]
  // The total execution time in seconds for the test config result.
  total_execution_time_secs: integer
  // Whether the test config reruns steps when an error occurs.
  rerun_on_error: boolean
  // Whether the test config reruns steps when a failure occurs.
  rerun_on_failure: boolean
  // The pre-run custom script ID, if configured.
  pre_run_custom_script_id: Partial(string) & Partial(null)
  // The pre-run custom script name, if configured.
  pre_run_custom_script_name: Partial(string) & Partial(null)
  // The configured run timeout in seconds.
  run_timeout: Partial(integer) & Partial(null)
  // The configured system run timeout in seconds.
  system_run_timeout: integer
  // The number of skipped steps in this test config result.
  total_steps_skipped: integer
  // The number of ignored steps in this test config result.
  total_steps_ignored: integer
  // Test config with tag information
  test_config_tags: {
    // The test configuration tag ID.
    id: string
    // The test configuration tag name.
    name: string
    // The tag color.
    color: Partial(string) & Partial(null)
    // The space the tag belongs to.
    space_id: Partial(string) & Partial(null)
  }[]
  // Test config with step information
  test_config_steps: {
    // The test configuration step type.
    step_type: Partial(string) & Partial(null)
    // The referenced test case ID, when applicable.
    test_case_uuid: Partial(string) & Partial(null)
    // Overrides for directed test case steps, when configured.
    directed_test_case_steps: Partial(     // Test config with model test case step
{
       // The model action ID to execute.
       action_id: Partial(string) & Partial(null)
       // The submodel test case ID, when the step targets a submodel.
       submodel_test_case_id: Partial(string) & Partial(null)
       // The parameter overrides for the directed test case step.
       parameters: Partial(        // Test config with step parameter override
{
          // The parameter ID.
          parameter_id: string
          // The parameter value.
          value: string
          // The parameter name, when available.
          name: Partial(string) & Partial(null)
        }[]) & Partial(null)
     }[]) & Partial(null)
    // Overrides for scripted test case steps, when configured.
    scripted_test_case_steps: Partial(     // Test config with scripted test case step
{
       // The local script path for the scripted step.
       local_path: string
       // The parameter string for the scripted step.
       parameters: string
     }[]) & Partial(null)
    // Any validation error message associated with the step.
    validation_error_message: Partial(string) & Partial(null)
  }[]
  // The scripted test configuration global parameters configured on the referenced test configuration. 
  scripted_test_config_params: Partial({
   }) & Partial(null)
}

TestConfigResultDirectedTestCaseStep

// Test config with model test case step
{
  // The model action ID to execute.
  action_id: Partial(string) & Partial(null)
  // The submodel test case ID, when the step targets a submodel.
  submodel_test_case_id: Partial(string) & Partial(null)
  // The parameter overrides for the directed test case step.
  parameters: Partial(   // Test config with step parameter override
{
     // The parameter ID.
     parameter_id: string
     // The parameter value.
     value: string
     // The parameter name, when available.
     name: Partial(string) & Partial(null)
   }[]) & Partial(null)
}

TestConfigResultScriptedTestCaseStep

// Test config with scripted test case step
{
  // The local script path for the scripted step.
  local_path: string
  // The parameter string for the scripted step.
  parameters: string
}

TestConfigResultSortBy

{
  "type": "string",
  "enum": [
    "start_time",
    "test_config_name",
    "source"
  ],
  "title": "TestConfigResultSortBy"
}

TestConfigResultStep

// Test config with step information
{
  // The test configuration step type.
  step_type: Partial(string) & Partial(null)
  // The referenced test case ID, when applicable.
  test_case_uuid: Partial(string) & Partial(null)
  // Overrides for directed test case steps, when configured.
  directed_test_case_steps: Partial(   // Test config with model test case step
{
     // The model action ID to execute.
     action_id: Partial(string) & Partial(null)
     // The submodel test case ID, when the step targets a submodel.
     submodel_test_case_id: Partial(string) & Partial(null)
     // The parameter overrides for the directed test case step.
     parameters: Partial(      // Test config with step parameter override
{
        // The parameter ID.
        parameter_id: string
        // The parameter value.
        value: string
        // The parameter name, when available.
        name: Partial(string) & Partial(null)
      }[]) & Partial(null)
   }[]) & Partial(null)
  // Overrides for scripted test case steps, when configured.
  scripted_test_case_steps: Partial(   // Test config with scripted test case step
{
     // The local script path for the scripted step.
     local_path: string
     // The parameter string for the scripted step.
     parameters: string
   }[]) & Partial(null)
  // Any validation error message associated with the step.
  validation_error_message: Partial(string) & Partial(null)
}

TestConfigResultStepParameter

// Test config with step parameter override
{
  // The parameter ID.
  parameter_id: string
  // The parameter value.
  value: string
  // The parameter name, when available.
  name: Partial(string) & Partial(null)
}

TestConfigResultSutUsed

// Test config with SUT information
{
  // The SUT ID
  id: Partial(integer) & Partial(string)
  // The SUT name
  name: string
}

TestConfigResultTag

// Test config with tag information
{
  // The test configuration tag ID.
  id: string
  // The test configuration tag name.
  name: string
  // The tag color.
  color: Partial(string) & Partial(null)
  // The space the tag belongs to.
  space_id: Partial(string) & Partial(null)
}

TestConfigResultsPaginatedList

{
  // The total number of items that matches the request before any limit or offset are applied.
  total_count: integer
  // The date and time when this request was made.
  date_as_of: string
  // TestConfigResult with basic details
  items: {
    // The test config result ID
    id: string
    // The possible statuses for a particular test config result.
    status: enum[PENDING, RUNNING, PASSED, PASSED_AFTER_RERUN, FAILED, ERROR, CANCELLING, CANCELLED]
    // The time the test config run started.
    start_time: string
    // The time the test config run completed. If it is still running, this will be null.
    end_time: Partial(string) & Partial(null)
    // The name of the test configuration
    test_config_name: Partial(string) & Partial(null)
    // The ID of the test configuration
    test_config_id: string
    // The source from which the test config is being executed.
    source: Partial(TestConfigSource) & Partial(null)
    // Granular test config filter options that being used for test config
    filter_options: Partial({
     }) & Partial(null)
    // The space the test config belongs to. Defaults to the Shared space if not specified.
    space_id: string //default: 910ba100-0000-4000-a000-000000000000
  }[]
}

TestConfigSource

{
  "type": "string",
  "enum": [
    "DAI",
    "DAI_SCHEDULE",
    "CLI"
  ],
  "title": "TestConfigSource"
}

TestConfigStatus

{
  "type": "string",
  "enum": [
    "PENDING",
    "RUNNING",
    "PASSED",
    "PASSED_AFTER_RERUN",
    "FAILED",
    "ERROR",
    "CANCELLING",
    "CANCELLED"
  ],
  "title": "TestConfigStatus",
  "description": "The possible statuses for a particular test config result."
}

TestResult

// The test result containing all the information for a single exploratory, replay or test case execution.
{
  // The test result id.
  id: integer
  // The possible statuses for a particular test result.
  status: enum[RUNNING, PASSED, FAILED, ERROR, CANCELLED]
  // The possible run types for a particular test result.
  run_type: enum[SCRIPTED_TEST_CASE, MODEL_TEST_CASE, EXPLORATORY, REPLAY, GHERKIN]
  // Whether this test result was part of a test config configured rerun attempt.
  is_rerun: boolean
  // The time the test run started.
  start_time: string
  // The time the test run completed. If it is still running, this will be null.
  end_time: Partial(string) & Partial(null)
  // The name of the model used for the test execution. If this was a scripted test case result, this will be null.
  model_name: Partial(string) & Partial(null)
  // The id of the model used for the test execution. If this was a scripted test case result, this will be null.
  model_id: Partial(string) & Partial(null)
  // The name of the suite used for the test execution.
  suite_name: Partial(string) & Partial(null)
  // The id of the suite used for the test execution.
  suite_id: Partial(string) & Partial(null)
  // The name of the test case that is being executed. For an exploratory or replay test result, this will be null.
  test_case_name: Partial(string) & Partial(null)
  // The id of the test case that was executed. For an exploratory or replay test result, this will be null.
  test_case_id: Partial(string) & Partial(null)
  // The name of the design or run agent used for the test execution
  execution_environment_name: Partial(string) & Partial(null)
  // The id of the design or run agent used for the test execution.
  execution_environment_id: Partial(integer) & Partial(null)
  // The name of the SUT used for the test execution.
  sut_name: Partial(string) & Partial(null)
  // The id of the SUT used for the test execution.
  sut_id: Partial(string) & Partial(null)
  // The id of the test config result that this test result is part of. For a live run, this will be null.
  test_config_result_id: Partial(string) & Partial(null)
  // The test config step of which this test result represents. This is zero-indexed and for a live run result, this will be null.
  test_config_step: Partial(integer) & Partial(null)
  // The feature file this scenario test result was part of (if this is a gherkin test result).
  feature_file: Partial(string) & Partial(null)
  // The space the test result belongs to. Defaults to the Shared space if not specified.
  space_id: string //default: 910ba100-0000-4000-a000-000000000000
  test_case_tags: {
    // The tag ID.
    id: string
    // The tag name.
    name: string
    // The tag color.
    color: Partial(string) & Partial(null)
    // The space the tag belongs to.
    space_id: Partial(string) & Partial(null)
  }[]
  test_config_tags:#/components/schemas/TestResultTag[]
  // The external ID associated with the test result.
  external_id: Partial(string) & Partial(null)
  // The origin of the test result.
  origin: Partial(string) & Partial(null)
  // The source from which the test was executed.
  source: Partial(TestConfigSource) & Partial(null)
  // The action at which the test result failed.
  failed_at: Partial(string) & Partial(null)
}

TestResultLogEntriesPaginatedList

// A paginated list of a single test result's log entries.
{
  // The total number of items that matches the request before any limit or offset are applied.
  total_count: integer
  // The date and time when this request was made.
  date_as_of: string
  // A single log entry from a particular test result.
  items: {
    // The id of the test result of which this log entry is part of.
    test_result_id: integer
    // The timestamp when this log entry was created.
    timestamp: string
    // The message conveyed in this test result log entry.
    message: string
    // The severity levels of a single test result log entry.
    severity: enum[CRITICAL, ERROR, WARNING, INFO, DEBUG]
    stage: enum[INITIALISING, ENGINE, SNIPPET]
    // The type of the message
    message_type: string
    // The name of the image
    image_name: string
    // The ID of the image
    image_id: Partial(string) & Partial(null)
  }[]
}

TestResultLogEntry

// A single log entry from a particular test result.
{
  // The id of the test result of which this log entry is part of.
  test_result_id: integer
  // The timestamp when this log entry was created.
  timestamp: string
  // The message conveyed in this test result log entry.
  message: string
  // The severity levels of a single test result log entry.
  severity: enum[CRITICAL, ERROR, WARNING, INFO, DEBUG]
  stage: enum[INITIALISING, ENGINE, SNIPPET]
  // The type of the message
  message_type: string
  // The name of the image
  image_name: string
  // The ID of the image
  image_id: Partial(string) & Partial(null)
}

TestResultTag

{
  // The tag ID.
  id: string
  // The tag name.
  name: string
  // The tag color.
  color: Partial(string) & Partial(null)
  // The space the tag belongs to.
  space_id: Partial(string) & Partial(null)
}

TestResultsPaginatedList

// A paginated list of the test results.
{
  // The total number of items that matches the request before any limit or offset are applied.
  total_count: integer
  // The date and time when this request was made.
  date_as_of: string
  // The test result containing all the information for a single exploratory, replay or test case execution.
  items: {
    // The test result id.
    id: integer
    // The possible statuses for a particular test result.
    status: enum[RUNNING, PASSED, FAILED, ERROR, CANCELLED]
    // The possible run types for a particular test result.
    run_type: enum[SCRIPTED_TEST_CASE, MODEL_TEST_CASE, EXPLORATORY, REPLAY, GHERKIN]
    // Whether this test result was part of a test config configured rerun attempt.
    is_rerun: boolean
    // The time the test run started.
    start_time: string
    // The time the test run completed. If it is still running, this will be null.
    end_time: Partial(string) & Partial(null)
    // The name of the model used for the test execution. If this was a scripted test case result, this will be null.
    model_name: Partial(string) & Partial(null)
    // The id of the model used for the test execution. If this was a scripted test case result, this will be null.
    model_id: Partial(string) & Partial(null)
    // The name of the suite used for the test execution.
    suite_name: Partial(string) & Partial(null)
    // The id of the suite used for the test execution.
    suite_id: Partial(string) & Partial(null)
    // The name of the test case that is being executed. For an exploratory or replay test result, this will be null.
    test_case_name: Partial(string) & Partial(null)
    // The id of the test case that was executed. For an exploratory or replay test result, this will be null.
    test_case_id: Partial(string) & Partial(null)
    // The name of the design or run agent used for the test execution
    execution_environment_name: Partial(string) & Partial(null)
    // The id of the design or run agent used for the test execution.
    execution_environment_id: Partial(integer) & Partial(null)
    // The name of the SUT used for the test execution.
    sut_name: Partial(string) & Partial(null)
    // The id of the SUT used for the test execution.
    sut_id: Partial(string) & Partial(null)
    // The id of the test config result that this test result is part of. For a live run, this will be null.
    test_config_result_id: Partial(string) & Partial(null)
    // The test config step of which this test result represents. This is zero-indexed and for a live run result, this will be null.
    test_config_step: Partial(integer) & Partial(null)
    // The feature file this scenario test result was part of (if this is a gherkin test result).
    feature_file: Partial(string) & Partial(null)
    // The space the test result belongs to. Defaults to the Shared space if not specified.
    space_id: string //default: 910ba100-0000-4000-a000-000000000000
    test_case_tags: {
      // The tag ID.
      id: string
      // The tag name.
      name: string
      // The tag color.
      color: Partial(string) & Partial(null)
      // The space the tag belongs to.
      space_id: Partial(string) & Partial(null)
    }[]
    test_config_tags:#/components/schemas/TestResultTag[]
    // The external ID associated with the test result.
    external_id: Partial(string) & Partial(null)
    // The origin of the test result.
    origin: Partial(string) & Partial(null)
    // The source from which the test was executed.
    source: Partial(TestConfigSource) & Partial(null)
    // The action at which the test result failed.
    failed_at: Partial(string) & Partial(null)
  }[]
}

ValidationError

{
  loc: Partial(string) & Partial(integer)[]
  msg: string
  type: string
  ctx: {
  }
}

VncConnectionRequest

// VNC connection for POST/PUT requests - no uuid
{
  // Connection type for VNC
  connection_type: string
  // The SUT's IP Address or Hostname
  host: string
  // The port number used to connect to the SUT
  port: integer
  // The username of VNC connection for SUT to connect
  username: Partial(string) & Partial(null)
  // The password of VNC connection for SUT to connect
  password: Partial(string) & Partial(null)
  // The depth of color with which the VNC sessions open. To increase the speed of your connection, you can decrease the color depth
  color_depth: Partial(ColorDepth) & Partial(null)
  // Scale ratio for VNC connection. 1 = normal size, 2 = scaled by 50%
  scale_ratio: enum[1, 2]
  // The host name or IP address of the computer that hosts an SSH tunnel for the SUT's secure connections.
  ssh_host: Partial(string) & Partial(null)
  // The account name with which the SUT user logs into an SSH host.
  ssh_user: Partial(string) & Partial(null)
  // The password with which the SUT user logs into an SSH Host.
  ssh_password: Partial(string) & Partial(null)
}

VncConnectionResponse

// VNC connection for GET responses - includes uuid
{
  // Connection type for VNC
  connection_type: string
  // The SUT's IP Address or Hostname
  host: string
  // The port number used to connect to the SUT
  port: integer
  // The username of VNC connection for SUT to connect
  username: Partial(string) & Partial(null)
  // The password of VNC connection for SUT to connect
  password: Partial(string) & Partial(null)
  // The depth of color with which the VNC sessions open. To increase the speed of your connection, you can decrease the color depth
  color_depth: Partial(ColorDepth) & Partial(null)
  // Scale ratio for VNC connection. 1 = normal size, 2 = scaled by 50%
  scale_ratio: enum[1, 2]
  // The host name or IP address of the computer that hosts an SSH tunnel for the SUT's secure connections.
  ssh_host: Partial(string) & Partial(null)
  // The account name with which the SUT user logs into an SSH host.
  ssh_user: Partial(string) & Partial(null)
  // The password with which the SUT user logs into an SSH Host.
  ssh_password: Partial(string) & Partial(null)
  // Unique identifier for the connection
  uuid: string
}

WebDriverConnectionRequest

// WebDriver connection for POST/PUT requests - no uuid
{
  // Connection type for WebDriver
  connection_type: string
  // The SUT's IP address or hostname
  host: string
  // The port number used to connect to the SUT
  port: integer
  // A valid JSON object used to communicate the features supported by a session
  capabilities: {
  }
  // The type of browser you want to launch on the SUT for testing
  browser: Partial(BrowserType) & Partial(null)
}

WebDriverConnectionResponse

// WebDriver connection for GET responses - includes uuid
{
  // Connection type for WebDriver
  connection_type: string
  // The SUT's IP address or hostname
  host: string
  // The port number used to connect to the SUT
  port: integer
  // A valid JSON object used to communicate the features supported by a session
  capabilities: {
  }
  // The type of browser you want to launch on the SUT for testing
  browser: Partial(BrowserType) & Partial(null)
  // Unique identifier for the connection
  uuid: string
}