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

GET 
/testplan

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 'TestPlan' 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

is_deleted boolean

If the entity has been soft-deleted this value is true

project_id integer

The project id this entity or mapping belongs to

created_at date-time

The creation time for this entity or mapping value

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

created_by number

The creator user id of this entity or mapping value - or zero if created by the system

Example: 0

modified_at date-time

The last modification time for this entity or mapping value

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

modified_by number

The id of the user who last modified or undeleted this entity or mapping value - or zero if modified by the system

Example: 0

deleted_at date-time

The soft-deletion time for this entity or mapping value

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

deleted_by number

The id of the user who deleted this entity or mapping value - or zero if deleted by the system

Example: 0

description string

An optional description for this test plan (can be a rich text document)

$testrun_count number

The number of test runs linked to this test plan - read only

$last_testrun_created object

The time the last test run was created from this test plan - read only

$open_testrun_count number

The number of open test runs linked to this test plan - read only

$query_count number

The number of tset case queries linked to this test plan - read only

]

meta

object

required

count integerrequired

limit integer

offset integerrequired

totalCount integer

Example (from schema)

{
  "data": [
    {
      "id": 0,
      "title": "A Descriptive Title",
      "is_deleted": true,
      "project_id": 0,
      "created_at": "1970-01-01T00:00:00.000Z",
      "created_by": 0,
      "modified_at": "1970-01-01T00:00:00.000Z",
      "modified_by": 0,
      "deleted_at": "1970-01-01T00:00:00.000Z",
      "deleted_by": 0,
      "description": "string",
      "$testrun_count": 0,
      "$last_testrun_created": {},
      "$open_testrun_count": 0,
      "$query_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...