Find 'TestCaseFolder' entities using the specified (body) parameters

POST 
/testcase-folder/find

Search for entities with the filters and arguments specified in 'DataReadParams' (see request schema), with optional mapping expansions via 'map'. Note that 'filter' should include a 'project_id' parameter if API key permissions are restricted to a single project.

Request

application/json

Body

required

pagination object

Pagination settings control how much data from a result is fetched

offset integer

The offset the result starts at

pageAtId integer

Selects the page with the given id in the result, given a limit (= page size)

inflate integer

Adds a number of items before the start offset and after the limit (for pagination use)

limit integer

The maximum number of result rows

order object[]
Controls the ordering of the result
Array [
oneOf
MOD1
order stringrequired
Ordering by a pre-defined value sequence - the partial ordering of the given values in the result is preserved
column stringrequired
The name of the column to order by
seq number[]required
MOD2
column stringrequired
The name of the column to order by
order stringrequired
Possible values: [asc, desc]
Either 'asc'ending or 'desc'ending order for the given column
]
includeTotalCount boolean

Includes the total result count if pagination options were given

filter object
Filter/search terms
and object
oneOf
ByKeys
and object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
or object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
MOD2
Array [
and object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
or object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
]
or object
oneOf
ByKeys
and object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
or object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
MOD2
Array [
and object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
or object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
]
oneOf
computedColumns string[]

List of computed columns to include (by default includes all)

id integer

Only return the entity with the given id, returns one or none

ids integer[]

Only return the entities with the given ids

map object
Map expression to expand properties or relationships with other entities
oneOf
MapJoin
entities object
The list of entity names which are part of the mapping (for mapping relationship tables)
oneOf
MOD1
string
MOD2
Array [
string
]
entity string
The entity name (for direct mapping via a foreign key)
ids object
A list of id tuples to filter by
oneOf
MOD2
Array [
oneOf
]
inverse boolean
Default value: false
Inverts the result to retrieve non-mapped entities
filter object
Filter/search terms
and object
oneOf
ByKeys
and object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
or object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
MOD2
Array [
and object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
or object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
]
or object
oneOf
ByKeys
and object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
or object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
MOD2
Array [
and object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
or object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
]
oneOf
resultFilter object
Filter/search terms
and object
oneOf
ByKeys
and object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
or object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
MOD2
Array [
and object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
or object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
]
or object
oneOf
ByKeys
and object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
or object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
MOD2
Array [
and object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
or object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
]
oneOf
countOnly boolean
Default value: false
Only returns a count instead of a list of entities
idOnly boolean
Default value: false
Only retrieves entity ids, omitting all other columns
optional boolean
Default value: false
Indicates that the mapping is optional and may be 'null' in the result
includeDeleted boolean
Default value: false
Includes deleted member entities in the mapping search result
omitLargeValues boolean
Default value: false
Omits 'large' column/prop values (if available)
omit boolean
Omit the mapping result from result entities - For intermediate nested mappings
result string
The entity to use as the result instead of the mapping relationship entity data
resultIncludeMapping boolean
Default value: false
Also includes mapping even if result entity is specified
map object
Nested mapping starting from one of the member entities of this mapping
oneOf
MOD2
Array [
openapi
info Testiny API
The Testiny platform API.
servers
paths
components
tags
security
title
]
MOD2
Array [
entities object
The list of entity names which are part of the mapping (for mapping relationship tables)
oneOf
MOD1
string
MOD2
Array [
string
]
entity string
The entity name (for direct mapping via a foreign key)
ids object
A list of id tuples to filter by
oneOf
MOD2
Array [
oneOf
]
inverse boolean
Default value: false
Inverts the result to retrieve non-mapped entities
filter object
Filter/search terms
and object
oneOf
ByKeys
and object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
or object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
MOD2
Array [
and object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
or object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
]
or object
oneOf
ByKeys
and object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
or object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
MOD2
Array [
and object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
or object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
]
oneOf
resultFilter object
Filter/search terms
and object
oneOf
ByKeys
and object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
or object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
MOD2
Array [
and object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
or object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
]
or object
oneOf
ByKeys
and object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
or object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
MOD2
Array [
and object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
or object
oneOf
MOD2
Array [
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
]
]
oneOf
countOnly boolean
Default value: false
Only returns a count instead of a list of entities
idOnly boolean
Default value: false
Only retrieves entity ids, omitting all other columns
optional boolean
Default value: false
Indicates that the mapping is optional and may be 'null' in the result
includeDeleted boolean
Default value: false
Includes deleted member entities in the mapping search result
omitLargeValues boolean
Default value: false
Omits 'large' column/prop values (if available)
omit boolean
Omit the mapping result from result entities - For intermediate nested mappings
result string
The entity to use as the result instead of the mapping relationship entity data
resultIncludeMapping boolean
Default value: false
Also includes mapping even if result entity is specified
map object
Nested mapping starting from one of the member entities of this mapping
oneOf
MOD2
Array [
openapi
info Testiny API
The Testiny platform API.
servers
paths
components
tags
security
title
]
]
includeDeleted boolean

Includes soft-deleted entities in the result (if applicable)

omitLargeValues boolean

Default value: true

Omits 'large' column/prop values (if available)

omitForbidden boolean

Default value: false

Omits entities which are not allowed to be read rather than return an error

asOf string

Perform a history query given the asOf timestamp (if available)

idOnly boolean

Only returns ids in the result, omitting all other properties

countOnly boolean

Returns only the length of the result list instead of the result list itself

label string

Responses

200

Returns FindResult of type 'TestCaseFolder' 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)
sort_index number
An integer sort index for natural ordering of this entity or mapping value - value must be in range (-999999999999999,999999999999999)
is_deleted boolean
If the entity has been soft-deleted this value is true
created_at date-time
The creation time for this entity or mapping value
created_by number
The creator user id of this entity or mapping value - or zero if created by the system
modified_at date-time
The last modification time for this entity or mapping value
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
deleted_at date-time
The soft-deletion time for this entity or mapping value
deleted_by number
The id of the user who deleted this entity or mapping value - or zero if deleted by the system
_etag stringrequired
A tag for detecting conflicting modifications - current value (may be empty) must be passed along in an update (or update must be forced)
project_id integer
The project id this entity or mapping belongs to
testcase_folder_parent_id integer
The id of the folder's parent in the tree structure (no cycles allowed)
description string
An optional description for this test case folder (can be a rich text document)
]
meta objectrequired
count integerrequired
limit integer
offset integerrequired
totalCount integer

Example (from schema)

{
  "data": [
    {
      "id": 0,
      "title": "A Descriptive Title",
      "sort_index": 0,
      "is_deleted": true,
      "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,
      "_etag": "string",
      "project_id": 0,
      "testcase_folder_parent_id": 0,
      "description": "string"
    }
  ],
  "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.

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.

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...