TCG

Push generated test cases into a connected test management tool

Starts an asynchronous export of the TCG's generated test cases into TestRail, Xray, Azure Test Plans or Zephyr Scale via the central integrations service. Returns immediately with the run record; poll the companion GET endpoint for progress. Every export CREATES new cases in the target tool — nothing is updated in place, so exporting twice produces two independent sets.

post/api/v1/tcg/{tcg_id}/push-export

Request

Base URL
https://toolkit.browserstack.com
Auth
API key in cookie _wdt_rails_session

Path parameters

tcg_idstring required

ID of the test case generation request

Request body

tool'testrail' | 'xray' | 'azure-testplan' | 'zephyr-scale' required

Integration key of the target tool. qTest and QMetry are not accepted: their connectors are read-only upstream.

project_idstring required

Project in the target tool

folder_idstring

Destination container, interpreted per tool and stored on a typed target record: a section id for TestRail (required there), a folder PATH for Xray and Zephyr Scale, a test plan id for Azure Test Plans.

suite_idstring

TestRail multi-suite projects, and the test suite id for Azure Test Plans

area_pathstring

Azure Test Plans only

iteration_pathstring

Azure Test Plans only

create_preconditionsboolean

Xray only: create each case's precondition as its own linked Jira issue

skip_exportedboolean

Dedupe. Any case an earlier run already created in this PROJECT is left alone, so a second export does not duplicate it. DEFAULTS TO TRUE — send false only to force a fresh set, which is what someone who deleted the cases in their tool needs, since these records track what we created rather than what still exists. Reported back as status.skipped.

folder_namestring

Creates (or reuses) a per-run home of this name and targets it: a section under folder_id for TestRail, a folder path for Xray and Zephyr Scale, and a whole TEST PLAN (root suite included) for Azure Test Plans, where it replaces any caller-picked plan and suite.

Example request

{
  "project_id": "10001",
  "folder_id": "/Regression/Critical",
  "skip_exported": true,
  "folder_name": "TCG-42 Checkout"
}

Response

Export accepted and queued

Example response

{
  "data": {
    "type": "tcg-push-exports",
    "attributes": {
      "export-type": "testrail",
      "target": {
        "type": "TcgTestrailExportTarget",
        "project-id": "2",
        "container": "section 9",
        "site-url": "https://acme.testrail.io"
      },
      "total-count": 42
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.