Perform multiple CRUD-like operations in a single transaction

POST 
/data-batch

Each step takes either 'DataReadParams' (for Read) or the corresponding arguments of the single-operation endpoints (for Create, Update, Delete, Undelete, Map, Unmap) . See request body schema.

Request

application/json

Body

required

steps object[]required
Possible values: <= 25
Array [
oneOf
MOD1
op stringrequired
as stringrequired
result boolean
entity stringrequired
readParams objectrequired
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
MOD2
op stringrequired
as string
result boolean
entity stringrequired
inputData object[]required
Array [
id integerrequired
The unique entity id
]
MOD3
op stringrequired
as string
force boolean
result boolean
entity stringrequired
inputData object[]
Array [
id integerrequired
The unique entity id
]
MOD4
op stringrequired
as string
from string
result boolean
entity stringrequired
inputData object[]
Array [
id integerrequired
The unique entity id
]
MOD5
op stringrequired
from string
entity stringrequired
inputData object[]
Array [
id integerrequired
The unique entity id
]
MOD6
op stringrequired
mapOp stringrequired
as string
from string[]
result boolean
sourceEntity stringrequired
entities string[]required
inputData object[]
Array [
id integerrequired
The unique entity id
]
mappings object[]required
Array [
ids objectrequired
Entity ids for mapped entities, e.g. testcase_id
property name* integer
newIds object
Entity ids for mapped entities, e.g. testcase_id
property name* integer
mapped object
]
]

Responses

200

Returns 'DataBatchResult'

application/json

Schema

Schema

object

Example (from schema)

{}

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