AsynchronousJob

Update an asynchronous job

Changed on

Updates Job

patch/async-jobs/{job_id}

Request

  • Base URL: https://api.mabl.com
  • URL: https://api.mabl.com/async-jobs/{job_id}
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Path parameters

job_idstring required

Job ID

Headers

If-Matchstring required

If-Match header

Request body

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

Response

Job updated 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 project_not_configured enum value to the request property ///////

    • info

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

    • info

      added the new zephyr_sync enum value to the request property

  • daadc556ff0dRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status