TestCaseManagement

Create synchronization request for a plan run

Changed on

Manually publishes a synchronization request for a plan run with job source tracking. Returns 409 if the plan run has not finished, was cancelled or terminated, or already has a sync in flight.

post/tcm/external/sync/executions/planRun

Request

  • Base URL: https://api.mabl.com
  • URL: https://api.mabl.com/tcm/external/sync/executions/planRun
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Request body

plan_run_idstring required

Unique identifier for the PlanRun

job_source'test_run' | 'plan_run' required

What triggered this job

test_run_idstring

The test run to sync, if not the whole plan run

external_tcm_platform'xray' | 'testrail' | 'zephyr'

Supported external test case management platforms

Response

Synchronization request created successfully

idstring

Unique identifier of the TestCase

workspace_idstring

Unique identifier for the associated Workspace

job_type'xray_sync' | 'testrail_sync' | 'zephyr_sync' | 'workspace_copy'

Type of AsynchronousJob

status'pending' | 'running' | 'completed' | 'failed'

Current status of the AsynchronousJob

created_timeinteger

Time the AsynchronousJob was created

created_by_idstring

Identifier of the user who created the AsynchronousJob

last_updated_timeinteger

Time the AsynchronousJob was last updated

last_updated_by_idstring

Identifier of the user who last updated the AsynchronousJob

error_messagestring

If failed, an optional error message associated with the failure

job_source'test_run' | 'plan_run'

What triggered this job

Changes

  • 488eade0b398Revision changes
    • warning

      added the new project_not_configured enum value to the /////// response property for the response status

    • warning

      added the new zephyr enum value to the ///// response property for the response status

    • warning

      added the new zephyr_sync enum value to the response property for the response status

    • info

      added the new zephyr enum value to the request property ////

  • e0444c72fafcRevision changes
    • info

      added the non-success response with the status