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

POST 
/project/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

Default value: 0

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

Either 'asc'ending or 'desc'ending order for the given column

Possible values: [asc, desc]

]

includeTotalCount boolean

Includes the total result count if pagination options were given

filter

object

Filter/search terms

and

object

oneOf

ByKeys

Filter/search terms

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

Filter/search terms

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

]

]

property name*

object

oneOf

MOD1

oneOf

ByKeysValue

Any basic JSON value (string, number, boolean, null)

oneOf

MOD1

string

MOD2

number

MOD3

boolean

MOD2

Array [

oneOf

MOD1

string

MOD2

number

MOD3

boolean

]

MOD2

op stringrequired

The comparison/matching operation to perform on the value: eq, not_eq, like, not_like, in, not_in, like_in, not_like_in, gt, lt, lte, gte, range, has_any, has_all, has_none, in_subtree

Possible values: [eq, not_eq, like, not_like, in, not_in, like_in, not_like_in, gt, lt, lte, gte, range, has_any, has_all, has_none, in_subtree]

value

object

required

The target value(s) or pattern

oneOf

ByKeysValue

Any basic JSON value (string, number, boolean, null)

oneOf

MOD1

string

MOD2

number

MOD3

boolean

MOD2

Array [

oneOf

MOD1

string

MOD2

number

MOD3

boolean

]

col

MOD3

op stringrequired

The comparison/matching operation to perform on the value: eq, not_eq, like, not_like, in, not_in, like_in, not_like_in, gt, lt, lte, gte, range, has_any, has_all, has_none, in_subtree

Possible values: [eq, not_eq, like, not_like, in, not_in, like_in, not_like_in, gt, lt, lte, gte, range, has_any, has_all, has_none, in_subtree]

value

col stringrequired

The target column/prop name (instead of fixed value)

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

FkIdsNullable

Entity ids for mapped entities, e.g. testcase_id (also allows null as value)

property name*

object

oneOf

MOD1

integer

MOD2

string

MOD2

Array [

property name*

object

oneOf

MOD1

integer

MOD2

string

]

inverse boolean

Inverts the result to retrieve non-mapped entities

Default value: false

filter

object

Filter/search terms

and

object

oneOf

ByKeys

Filter/search terms

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

Filter/search terms

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

]

]

property name*

object

oneOf

MOD1

oneOf

ByKeysValue

Any basic JSON value (string, number, boolean, null)

oneOf

MOD1

string

MOD2

number

MOD3

boolean

MOD2

Array [

oneOf

MOD1

string

MOD2

number

MOD3

boolean

]

MOD2

op stringrequired

The comparison/matching operation to perform on the value: eq, not_eq, like, not_like, in, not_in, like_in, not_like_in, gt, lt, lte, gte, range, has_any, has_all, has_none, in_subtree

Possible values: [eq, not_eq, like, not_like, in, not_in, like_in, not_like_in, gt, lt, lte, gte, range, has_any, has_all, has_none, in_subtree]

value

object

required

The target value(s) or pattern

oneOf

ByKeysValue

Any basic JSON value (string, number, boolean, null)

oneOf

MOD1

string

MOD2

number

MOD3

boolean

MOD2

Array [

oneOf

MOD1

string

MOD2

number

MOD3

boolean

]

col

MOD3

op stringrequired

The comparison/matching operation to perform on the value: eq, not_eq, like, not_like, in, not_in, like_in, not_like_in, gt, lt, lte, gte, range, has_any, has_all, has_none, in_subtree

Possible values: [eq, not_eq, like, not_like, in, not_in, like_in, not_like_in, gt, lt, lte, gte, range, has_any, has_all, has_none, in_subtree]

value

col stringrequired

The target column/prop name (instead of fixed value)

resultFilter

object

Filter/search terms

and

object

oneOf

ByKeys

Filter/search terms

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

Filter/search terms

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

]

]

property name*

object

oneOf

MOD1

oneOf

ByKeysValue

Any basic JSON value (string, number, boolean, null)

oneOf

MOD1

string

MOD2

number

MOD3

boolean

MOD2

Array [

oneOf

MOD1

string

MOD2

number

MOD3

boolean

]

MOD2

op stringrequired

The comparison/matching operation to perform on the value: eq, not_eq, like, not_like, in, not_in, like_in, not_like_in, gt, lt, lte, gte, range, has_any, has_all, has_none, in_subtree

Possible values: [eq, not_eq, like, not_like, in, not_in, like_in, not_like_in, gt, lt, lte, gte, range, has_any, has_all, has_none, in_subtree]

value

object

required

The target value(s) or pattern

oneOf

ByKeysValue

Any basic JSON value (string, number, boolean, null)

oneOf

MOD1

string

MOD2

number

MOD3

boolean

MOD2

Array [

oneOf

MOD1

string

MOD2

number

MOD3

boolean

]

col

MOD3

op stringrequired

The comparison/matching operation to perform on the value: eq, not_eq, like, not_like, in, not_in, like_in, not_like_in, gt, lt, lte, gte, range, has_any, has_all, has_none, in_subtree

Possible values: [eq, not_eq, like, not_like, in, not_in, like_in, not_like_in, gt, lt, lte, gte, range, has_any, has_all, has_none, in_subtree]

value

col stringrequired

The target column/prop name (instead of fixed value)

countOnly boolean

Only returns a count instead of a list of entities

Default value: false

idOnly boolean

Only retrieves entity ids, omitting all other columns

Default value: false

optional boolean

Indicates that the mapping is optional and may be 'null' in the result

Default value: false

includeDeleted boolean

Includes deleted member entities in the mapping search result

Default value: false

omitLargeValues boolean

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

Default value: false

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

Also includes mapping even if result entity is specified

Default value: false

map

object

Nested mapping starting from one of the member entities of this mapping

oneOf

MOD2

Array [

0

1

2

3

4

5

6

7

8

9

]

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

FkIdsNullable

Entity ids for mapped entities, e.g. testcase_id (also allows null as value)

property name*

object

oneOf

MOD1

integer

MOD2

string

MOD2

Array [

property name*

object

oneOf

MOD1

integer

MOD2

string

]

inverse boolean

Inverts the result to retrieve non-mapped entities

Default value: false

filter

object

Filter/search terms

and

object

oneOf

ByKeys

Filter/search terms

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

Filter/search terms

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

]

]

property name*

object

oneOf

MOD1

oneOf

ByKeysValue

Any basic JSON value (string, number, boolean, null)

oneOf

MOD1

string

MOD2

number

MOD3

boolean

MOD2

Array [

oneOf

MOD1

string

MOD2

number

MOD3

boolean

]

MOD2

op stringrequired

The comparison/matching operation to perform on the value: eq, not_eq, like, not_like, in, not_in, like_in, not_like_in, gt, lt, lte, gte, range, has_any, has_all, has_none, in_subtree

Possible values: [eq, not_eq, like, not_like, in, not_in, like_in, not_like_in, gt, lt, lte, gte, range, has_any, has_all, has_none, in_subtree]

value

object

required

The target value(s) or pattern

oneOf

ByKeysValue

Any basic JSON value (string, number, boolean, null)

oneOf

MOD1

string

MOD2

number

MOD3

boolean

MOD2

Array [

oneOf

MOD1

string

MOD2

number

MOD3

boolean

]

col

MOD3

op stringrequired

The comparison/matching operation to perform on the value: eq, not_eq, like, not_like, in, not_in, like_in, not_like_in, gt, lt, lte, gte, range, has_any, has_all, has_none, in_subtree

Possible values: [eq, not_eq, like, not_like, in, not_in, like_in, not_like_in, gt, lt, lte, gte, range, has_any, has_all, has_none, in_subtree]

value

col stringrequired

The target column/prop name (instead of fixed value)

resultFilter

object

Filter/search terms

and

object

oneOf

ByKeys

Filter/search terms

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

Filter/search terms

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

]

]

property name*

object

oneOf

MOD1

oneOf

ByKeysValue

Any basic JSON value (string, number, boolean, null)

oneOf

MOD1

string

MOD2

number

MOD3

boolean

MOD2

Array [

oneOf

MOD1

string

MOD2

number

MOD3

boolean

]

MOD2

op stringrequired

The comparison/matching operation to perform on the value: eq, not_eq, like, not_like, in, not_in, like_in, not_like_in, gt, lt, lte, gte, range, has_any, has_all, has_none, in_subtree

Possible values: [eq, not_eq, like, not_like, in, not_in, like_in, not_like_in, gt, lt, lte, gte, range, has_any, has_all, has_none, in_subtree]

value

object

required

The target value(s) or pattern

oneOf

ByKeysValue

Any basic JSON value (string, number, boolean, null)

oneOf

MOD1

string

MOD2

number

MOD3

boolean

MOD2

Array [

oneOf

MOD1

string

MOD2

number

MOD3

boolean

]

col

MOD3

op stringrequired

The comparison/matching operation to perform on the value: eq, not_eq, like, not_like, in, not_in, like_in, not_like_in, gt, lt, lte, gte, range, has_any, has_all, has_none, in_subtree

Possible values: [eq, not_eq, like, not_like, in, not_in, like_in, not_like_in, gt, lt, lte, gte, range, has_any, has_all, has_none, in_subtree]

value

col stringrequired

The target column/prop name (instead of fixed value)

countOnly boolean

Only returns a count instead of a list of entities

Default value: false

idOnly boolean

Only retrieves entity ids, omitting all other columns

Default value: false

optional boolean

Indicates that the mapping is optional and may be 'null' in the result

Default value: false

includeDeleted boolean

Includes deleted member entities in the mapping search result

Default value: false

omitLargeValues boolean

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

Default value: false

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

Also includes mapping even if result entity is specified

Default value: false

map

object

Nested mapping starting from one of the member entities of this mapping

oneOf

MOD2

Array [

0

1

2

3

4

5

6

7

8

9

]

]

includeDeleted boolean

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

omitLargeValues boolean
Omits 'large' column/prop values (if available)
Default value: true
omitForbidden boolean
Omits entities which are not allowed to be read rather than return an error
Default value: false
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 'Project' expanded with specified mapped values

application/json

Schema

Schema

data

object[]

required

Array [

id integer

The unique entity id - must be a positive integer

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

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

_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)

owner_user_id integer

Reserved for future use

name string

The project name

project_key stringnullable

An optional project shorthand key

Example: PRO

description string

An optional descriptive text for the project

]

meta

object

required

count integerrequired

limit integer

offset integerrequired

totalCount integer

Example (from schema)

{
  "data": [
    {
      "id": 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",
      "owner_user_id": 0,
      "name": "string",
      "project_key": "PRO",
      "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.
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...