Export test cases

post

https://{tenant}.katalon.io/v2/tm/test-cases/export

Queues a document export of test cases that the caller can read.
Use destination: DOCUMENT to export test cases in CSV or WORD format.
The response contains task metadata, not a completed file. Use Get a task to check its status.
If you send a request body, it replaces the complete query-parameter selection; the API does not merge both selections.
A body format takes precedence over the query format.
Requires the TestCase:Read permission.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

Search expression. URL-encode the expression when constructing requests.

page

integer

≥ 0

Defaults to 0

Zero-based page number.

size

integer

1 to 100

Defaults to 100

Page size. Values above 100 are capped at 100.

sorts

string

Sort expression for the search.

countOnly

boolean

Defaults to false

Request a count without fetching the full page of records.

format

string

enum

Defaults to CSV

Document format. Accepts CSV or WORD without regard to letter case. Defaults to CSV.

Allowed:

Body Params

A body selection replaces query-parameter selection. Use the DOCUMENT destination to export a CSV or Word document.
The body field is query; q is the equivalent query-parameter name.

query

string

RSQL selection filter.

pageNumber

integer

Defaults to 0

Zero-based page number.

pageSize

integer

Defaults to 100

Effective page size is capped at 100.

sorts

string

Sort expression.

countOnly

boolean

Defaults to false

joins

array of objects

joins

destination

string

enum

Defaults to DOCUMENT

Allowed:

format

string

enum

Defaults to CSV

Allowed:

Headers

x-account-id

string

Optional account UUID for selecting account context explicitly.

x-organization-id

int64

Optional organization ID for selecting organization context explicitly.

x-project-id

int64

required

True Platform project ID, not a repository ID.

Responses

401

Authentication is missing or invalid.

403

The caller lacks access or the required permission.

default

The request could not be completed. Inspect the response before retrying a mutation.

Language

Credentials

Basic

base64

URL

Loading…

Response

Choose an example:

application/json

202The API accepted the export task. This response does not contain the file.

400The selection or document format is invalid.