uip tm export-jobs

Syntax and options for `uip tm export-jobs`, which checks the background jobs in which Test Manager builds Excel, PDF, and JUnit export files.

uip tm export-jobs checks file export jobs, the background jobs in which Test Manager builds an Excel, PDF, or JUnit file. The following commands start a file export job and, without --wait, return its Id. With --wait, they poll the job and write the file themselves.

Command	File	Object type of the job
testcases export	Test cases as an .xlsx workbook	testCase
report export with --execution-id	One execution's report as Excel, PDF, or JUnit	testExecution
report export with --test-case-log-ids	A PDF of chosen test case results, or a .zip of PDFs for two or more	testCaseLog

executions export and requirements export write their .xlsx file in the same call and start no export job.

When a job reaches Completed, AttachmentId identifies the produced file. Test Manager stores every export file as an attachment of the project, so download it with uip tm attachment download and --object-type project, whatever was exported.

Synopsis

uip tm export-jobs get (--project-key <key> | --project-id <id>) --job-id <uuid> [--object-type <type>]

All verbs honor the global options and the standard exit codes.

uip tm export-jobs get

Get the status of a file export job. The job must belong to the project you name, or it reads as not found. When Status is Completed, the response carries Instructions with the attachment download command for the file.

Status is one of Initiated, InProgress, Completed, Failed, or Cancelled; the last three are terminal. TaskType names the kind of file, for example TestCasesExcelExport, TestExecutionPdfExport, TestExecutionJUnitExport, or TestCaseLogPdfExport. AttachmentId is null until the job completes.

Arguments

None.

Options

Flag	Description
--project-key <key>	Test Manager project key. One of --project-key or --project-id is required. Ignored if --project-id is also given.
--project-id <id>	Test Manager project ID. Use instead of --project-key; wins if both are given.
--job-id <uuid>	Required. File export job UUID, the Id the export command returned. A value that is not a UUID is refused before the request.
--object-type <type>	What the export was started for: project, requirement, testCase, testSet, testExecution, testStepLog, or testCaseLog. Selects which permission Test Manager checks; the job is found by --job-id alone. Defaults to testCase.

Examples

# Check a test case export
uip tm export-jobs get \
  --project-key DEMO \
  --job-id a1b2c3d4-0000-0000-0000-000000000001

# Check an execution report export
uip tm export-jobs get \
  --project-key DEMO \
  --job-id a1b2c3d4-0000-0000-0000-000000000002 \
  --object-type testExecution

# Download the file of a completed job
uip tm attachment download \
  --project-key DEMO \
  --attachment-id b2c3d4e5-0000-0000-0000-000000000002 \
  --object-type project \
  --output-file testcases.xlsx

Data shape

{
  "Code": "ExportJobGet",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "Status": "Completed",
    "TaskType": "TestCasesExcelExport",
    "AttachmentId": "b2c3d4e5-0000-0000-0000-000000000002",
    "Created": "2026-10-14T10:00:00.000Z",
    "CreatedBy": "c3d4e5f6-0000-0000-0000-000000000003",
    "Updated": "2026-10-14T10:00:05.000Z",
    "UpdatedBy": "c3d4e5f6-0000-0000-0000-000000000003",
    "Payload": null
  },
  "Instructions": "Fetch the file with: uip tm attachment download --project-id 9f8e7d6c-0000-0000-0000-000000000001 --attachment-id b2c3d4e5-0000-0000-0000-000000000002 --object-type project --output-file <path>"
}

Related

• testcases export: start a test case export.
• report export: start an execution report or test case result export.
• attachment download: download the produced file.
• migration: the separate jobs behind whole-project export and import.

See also

• Test Manager overview