Find 'AutomationTestRun' entities using the specified (query) parameters

GET 
/atm-testrun

Same as POST /find, but serializing the query in the 'q' parameter instead of the request body

Request

Query Parameters

q string
The DataReadParams query as JSON or base64-encoded JSON - See POST route
Example: {"filter": {"id": 1}}

Responses

200

Returns FindResult of type 'AutomationTestRun' expanded with specified mapped values

application/json

Schema

Schema

data

object[]

required

Array [

id integer

The unique entity id - must be a positive integer

title string

A descriptive title for this entity or mapping (1 to 200 characters)

Example: A Descriptive Title

project_id integer

The project id this entity or mapping belongs to

tags string

A list of tags for this entity

Example: important,release,smoketest

atm_source_id integer

The atm_source_id property

min_timestamp number

The min_timestamp property

max_timestamp number

The max_timestamp property

duration number

The duration property

status_highest number

The highest result status in this run, see the ordering of the result status values

is_completed boolean

The is_completed property

is_closed boolean

The is_closed property

closed_at date-time

The time this automation run was closed - all referenced automation test cases uses this as a historic timestamp

Example: 1970-01-01T00:00:00.000Z

closed_by number

The id of the user who closed this automation test run

Example: 0

is_pinned boolean

The is_pinned property

key_fields object

The key_fields property

key_fields_raw object

The key_fields_raw property

description stringnullable

An optional description for the test run (can be a rich text document)

Example:

stat_passed_count number

Number of passed results in this run

stat_passed_warn_count number

Number of passed with warning results in this run

stat_skipped_count number

Number of skipped results in this run

stat_blocked_count number

Number of blocked results in this run

stat_failed_count number

Number of failed results in this run

]

meta

object

required

count integerrequired

limit integer

offset integerrequired

totalCount integer

Example (from schema)

{
  "data": [
    {
      "id": 0,
      "title": "A Descriptive Title",
      "project_id": 0,
      "tags": "important,release,smoketest",
      "atm_source_id": 0,
      "min_timestamp": 0,
      "max_timestamp": 0,
      "duration": 0,
      "status_highest": 0,
      "is_completed": true,
      "is_closed": true,
      "closed_at": "1970-01-01T00:00:00.000Z",
      "closed_by": 0,
      "is_pinned": true,
      "key_fields": {},
      "key_fields_raw": {},
      "description": "",
      "stat_passed_count": 0,
      "stat_passed_warn_count": 0,
      "stat_skipped_count": 0,
      "stat_blocked_count": 0,
      "stat_failed_count": 0
    }
  ],
  "meta": {
    "count": 0,
    "limit": 0,
    "offset": 0,
    "totalCount": 0
  }
}

4XX

The request failed because invalid request parameters or data were supplied or access was denied.

application/json

Schema

Schema

code string
The error code describing the general error category.
Example: API_INVALID_INPUT_DATA
status integer

The HTTP status code.

message stringrequired

The actual error message describing the error in more detail.

reqid string

The request id for following up on specific errors.

Example (from schema)

{
  "code": "API_INVALID_INPUT_DATA",
  "status": 0,
  "message": "string",
  "reqid": "string"
}

5XX

The request failed because an error occurred during processing of the request.

application/json

Schema

Schema

code string
The error code describing the general error category.
Example: API_INVALID_INPUT_DATA
status integer

The HTTP status code.

message stringrequired

The actual error message describing the error in more detail.

reqid string

The request id for following up on specific errors.

Example (from schema)

{
  "code": "API_INVALID_INPUT_DATA",
  "status": 0,
  "message": "string",
  "reqid": "string"
}

Loading...