Register Katalon report metadata

Registers one Katalon Studio report file after you PUT its bytes to a
signed upload destination. Send no request body. Repeat this request
for each file, and keep the report's original folder structure in
folderPath. Include each eligible folder's execution0.log and its
related report files.

Use one fresh batch value for the intended import. Keep the same
project and Basic-auth credentials for every file. Send isEnd=true
only on the final registration after every file PUT succeeds. A batch
can contain files from multiple folders or sessions, so it can create
more than one test run; a test run can also include reports from more
than one batch.

The 200 response is an array of upload-batch resources. Its id is
an upload-batch ID, not a test-run ID. The returned done value is
false; do not use it to check parsing completion. webUrl opens the
upload batch, not a test run.

The response can be [] before an end marker. An end-bearing response
can arrive before asynchronous parsing finishes. The default Katalon
limit is 3,500 file rows per batch. The server can store over-cap files
but may not start normal batch processing.

When repeat-skip protection is enabled, an already completed batch can
skip files whose folder, file name, and uploaded path all match stored
files. A new uploaded path is not the same request. Queue deduplication
can replace older work that has not started, but cannot cancel active
work. Neither protection guarantees exactly-once processing.

pushToXray=true requests an Xray push. false or an omitted value
does not prevent a push when the test run's policy allows one.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Destination project ID as decimal text. The server parses this string
as a long. The user represented by your credentials must be allowed to
upload reports to this project.

string
required

Caller-chosen grouping key. Use a fresh value across projects and
importer types, then keep it stable for every file in this import.
Keep the same Basic-auth credentials for the whole batch.

string
required

String value true or false that marks batch completion. Send true
only on the final registration, after every file PUT succeeds.

string
required

Original file basename, including its extension. The server uses it to select report handling.

string
required

Storage path returned by the upload-URL response. Do not send a local path or the signed uploadUrl.

string
required

Report folder path metadata. Supply this for JUnit and Katalon imports.
Katalon Studio imports use it to preserve report folder grouping; JUnit
stores it but does not split a batch into runs by folder.

string

Optional string value true or false. Omission parses as false.
true requests an Xray push. false or omission does not prevent a
push when the test run's policy allows one. This parameter is not
supported by the Recorder or multiple Katalon routes.

Responses

400

A required query parameter is missing, or a query, enum, or JSON body
value cannot be bound. The response body is not fixed for binding errors.

401

Authentication failed. The framework response body does not have a fixed application JSON schema.

default

The request failed. The status and response body depend on the failure source.

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Choose an example:
application/json